<div dir="ltr">Thanks Vedant and Brian!</div><div class="gmail_extra"><br><div class="gmail_quote">On Mon, Aug 24, 2015 at 5:09 PM, Vedant Kumar via llvm-commits <span dir="ltr"><<a href="mailto:llvm-commits@lists.llvm.org" target="_blank">llvm-commits@lists.llvm.org</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Author: vedantk<br>
Date: Mon Aug 24 19:09:47 2015<br>
New Revision: 245911<br>
<br>
URL: <a href="http://llvm.org/viewvc/llvm-project?rev=245911&view=rev" rel="noreferrer" target="_blank">http://llvm.org/viewvc/llvm-project?rev=245911&view=rev</a><br>
Log:<br>
[docs] Improvements to CMake.rst<br>
<br>
- Fix some grammatical and typographical errors.<br>
- Try to improve upon some awkward/nonstandard phrasings.<br>
- Expand slightly the treatment of how you specify arguments to cmake.<br>
- Update the list of possible LLVM_BUILD_TESTS and state where to find the<br>
definitive list.<br>
- Correct the name of llvm-tblgen.<br>
- Expand slightly the treatment of several build options, including<br>
LLVM_LIT_TOOLS_DIR, LLVM_ENABLE_FFI, and LLVM_EXTERNAL_project_SOURCE_DIR.<br>
<br>
Patch by Brian R. Gaeke!<br>
<br>
Differential Revision: <a href="http://reviews.llvm.org/D11862" rel="noreferrer" target="_blank">http://reviews.llvm.org/D11862</a><br>
<br>
Modified:<br>
llvm/trunk/docs/CMake.rst<br>
<br>
Modified: llvm/trunk/docs/CMake.rst<br>
URL: <a href="http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CMake.rst?rev=245911&r1=245910&r2=245911&view=diff" rel="noreferrer" target="_blank">http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CMake.rst?rev=245911&r1=245910&r2=245911&view=diff</a><br>
==============================================================================<br>
--- llvm/trunk/docs/CMake.rst (original)<br>
+++ llvm/trunk/docs/CMake.rst Mon Aug 24 19:09:47 2015<br>
@@ -10,11 +10,11 @@ Introduction<br>
<br>
`CMake <<a href="http://www.cmake.org/" rel="noreferrer" target="_blank">http://www.cmake.org/</a>>`_ is a cross-platform build-generator tool. CMake<br>
does not build the project, it generates the files needed by your build tool<br>
-(GNU make, Visual Studio, etc) for building LLVM.<br>
+(GNU make, Visual Studio, etc.) for building LLVM.<br>
<br>
If you are really anxious about getting a functional LLVM build, go to the<br>
-`Quick start`_ section. If you are a CMake novice, start on `Basic CMake usage`_<br>
-and then go back to the `Quick start`_ once you know what you are doing. The<br>
+`Quick start`_ section. If you are a CMake novice, start with `Basic CMake usage`_<br>
+and then go back to the `Quick start`_ section once you know what you are doing. The<br>
`Options and variables`_ section is a reference for customizing your build. If<br>
you already have experience with CMake, this is the recommended starting point.<br>
<br>
@@ -31,35 +31,35 @@ We use here the command-line, non-intera<br>
#. Open a shell. Your development tools must be reachable from this shell<br>
through the PATH environment variable.<br>
<br>
-#. Create a directory for containing the build. It is not supported to build<br>
- LLVM on the source directory. cd to this directory:<br>
+#. Create a build directory. Building LLVM in the source<br>
+ directory is not supported. cd to this directory:<br>
<br>
.. code-block:: console<br>
<br>
$ mkdir mybuilddir<br>
$ cd mybuilddir<br>
<br>
-#. Execute this command on the shell replacing `path/to/llvm/source/root` with<br>
+#. Execute this command in the shell replacing `path/to/llvm/source/root` with<br>
the path to the root of your LLVM source tree:<br>
<br>
.. code-block:: console<br>
<br>
$ cmake path/to/llvm/source/root<br>
<br>
- CMake will detect your development environment, perform a series of test and<br>
+ CMake will detect your development environment, perform a series of tests, and<br>
generate the files required for building LLVM. CMake will use default values<br>
for all build parameters. See the `Options and variables`_ section for<br>
- fine-tuning your build<br>
+ a list of build parameters that you can modify.<br>
<br>
This can fail if CMake can't detect your toolset, or if it thinks that the<br>
- environment is not sane enough. On this case make sure that the toolset that<br>
- you intend to use is the only one reachable from the shell and that the shell<br>
- itself is the correct one for you development environment. CMake will refuse<br>
+ environment is not sane enough. In this case, make sure that the toolset that<br>
+ you intend to use is the only one reachable from the shell, and that the shell<br>
+ itself is the correct one for your development environment. CMake will refuse<br>
to build MinGW makefiles if you have a POSIX shell reachable through the PATH<br>
environment variable, for instance. You can force CMake to use a given build<br>
- tool, see the `Usage`_ section.<br>
+ tool; for instructions, see the `Usage`_ section, below.<br>
<br>
-#. After CMake has finished running, proceed to use IDE project files or start<br>
+#. After CMake has finished running, proceed to use IDE project files, or start<br>
the build from the build directory:<br>
<br>
.. code-block:: console<br>
@@ -67,9 +67,9 @@ We use here the command-line, non-intera<br>
$ cmake --build .<br>
<br>
The ``--build`` option tells ``cmake`` to invoke the underlying build<br>
- tool (``make``, ``ninja``, ``xcodebuild``, ``msbuild``, etc).<br>
+ tool (``make``, ``ninja``, ``xcodebuild``, ``msbuild``, etc.)<br>
<br>
- The underlying build tool can be invoked directly either of course, but<br>
+ The underlying build tool can be invoked directly, of course, but<br>
the ``--build`` option is portable.<br>
<br>
#. After LLVM has finished building, install it from the build directory:<br>
@@ -95,33 +95,39 @@ We use here the command-line, non-intera<br>
Basic CMake usage<br>
=================<br>
<br>
-This section explains basic aspects of CMake, mostly for explaining those<br>
-options which you may need on your day-to-day usage.<br>
+This section explains basic aspects of CMake<br>
+which you may need in your day-to-day usage.<br>
<br>
-CMake comes with extensive documentation in the form of html files and on the<br>
-cmake executable itself. Execute ``cmake --help`` for further help options.<br>
-<br>
-CMake requires to know for which build tool it shall generate files (GNU make,<br>
-Visual Studio, Xcode, etc). If not specified on the command line, it tries to<br>
-guess it based on you environment. Once identified the build tool, CMake uses<br>
-the corresponding *Generator* for creating files for your build tool. You can<br>
+CMake comes with extensive documentation, in the form of html files, and as<br>
+online help accessible via the ``cmake`` executable itself. Execute ``cmake<br>
+--help`` for further help options.<br>
+<br>
+CMake allows you to specify a build tool (e.g., GNU make, Visual Studio,<br>
+or Xcode). If not specified on the command line, CMake tries to guess which<br>
+build tool to use, based on your environment. Once it has identified your<br>
+build tool, CMake uses the corresponding *Generator* to create files for your<br>
+build tool (e.g., Makefiles or Visual Studio or Xcode project files). You can<br>
explicitly specify the generator with the command line option ``-G "Name of the<br>
-generator"``. For knowing the available generators on your platform, execute<br>
+generator"``. To see a list of the available generators on your system, execute<br>
<br>
.. code-block:: console<br>
<br>
$ cmake --help<br>
<br>
-This will list the generator's names at the end of the help text. Generator's<br>
-names are case-sensitive. Example:<br>
+This will list the generator names at the end of the help text.<br>
+<br>
+Generators' names are case-sensitive, and may contain spaces. For this reason,<br>
+you should enter them exactly as they are listed in the ``cmake --help``<br>
+output, in quotes. For example, to generate project files specifically for<br>
+Visual Studio 12, you can execute:<br>
<br>
.. code-block:: console<br>
<br>
- $ cmake -G "Visual Studio 11" path/to/llvm/source/root<br>
+ $ cmake -G "Visual Studio 12" path/to/llvm/source/root<br>
<br>
For a given development platform there can be more than one adequate<br>
-generator. If you use Visual Studio "NMake Makefiles" is a generator you can use<br>
-for building with NMake. By default, CMake chooses the more specific generator<br>
+generator. If you use Visual Studio, "NMake Makefiles" is a generator you can use<br>
+for building with NMake. By default, CMake chooses the most specific generator<br>
supported by your development environment. If you want an alternative generator,<br>
you must tell this to CMake with the ``-G`` option.<br>
<br>
@@ -142,18 +148,20 @@ CMake command line like this:<br>
<br>
$ cmake -DVARIABLE=value path/to/llvm/source<br>
<br>
-You can set a variable after the initial CMake invocation for changing its<br>
+You can set a variable after the initial CMake invocation to change its<br>
value. You can also undefine a variable:<br>
<br>
.. code-block:: console<br>
<br>
$ cmake -UVARIABLE path/to/llvm/source<br>
<br>
-Variables are stored on the CMake cache. This is a file named ``CMakeCache.txt``<br>
-on the root of the build directory. Do not hand-edit it.<br>
-<br>
-Variables are listed here appending its type after a colon. It is correct to<br>
-write the variable and the type on the CMake command line:<br>
+Variables are stored in the CMake cache. This is a file named ``CMakeCache.txt``<br>
+stored at the root of your build directory that is generated by ``cmake``.<br>
+Editing it yourself is not recommended.<br>
+<br>
+Variables are listed in the CMake cache and later in this document with<br>
+the variable name and type separated by a colon. You can also specify the<br>
+variable and type on the CMake command line:<br>
<br>
.. code-block:: console<br>
<br>
@@ -163,17 +171,17 @@ Frequently-used CMake variables<br>
-------------------------------<br>
<br>
Here are some of the CMake variables that are used often, along with a<br>
-brief explanation and LLVM-specific notes. For full documentation, check the<br>
-CMake docs or execute ``cmake --help-variable VARIABLE_NAME``.<br>
+brief explanation and LLVM-specific notes. For full documentation, consult the<br>
+CMake manual, or execute ``cmake --help-variable VARIABLE_NAME``.<br>
<br>
**CMAKE_BUILD_TYPE**:STRING<br>
- Sets the build type for ``make`` based generators. Possible values are<br>
- Release, Debug, RelWithDebInfo and MinSizeRel. On systems like Visual Studio<br>
- the user sets the build type with the IDE settings.<br>
+ Sets the build type for ``make``-based generators. Possible values are<br>
+ Release, Debug, RelWithDebInfo and MinSizeRel. If you are using an IDE such as<br>
+ Visual Studio, you should use the IDE settings to set the build type.<br>
<br>
**CMAKE_INSTALL_PREFIX**:PATH<br>
Path where LLVM will be installed if "make install" is invoked or the<br>
- "INSTALL" target is built.<br>
+ "install" target is built.<br>
<br>
**LLVM_LIBDIR_SUFFIX**:STRING<br>
Extra suffix to append to the directory where libraries are to be<br>
@@ -188,8 +196,9 @@ CMake docs or execute ``cmake --help-var<br>
<br>
**BUILD_SHARED_LIBS**:BOOL<br>
Flag indicating if shared libraries will be built. Its default value is<br>
- OFF. Shared libraries are not supported on Windows and not recommended on the<br>
- other OSes.<br>
+ OFF. This option is only recommended for use by LLVM developers.<br>
+ On Windows, shared libraries may be used when building with MinGW, including<br>
+ mingw-w64, but not when building with the Microsoft toolchain.<br>
<br>
.. _LLVM-specific variables:<br>
<br>
@@ -203,13 +212,13 @@ LLVM-specific variables<br>
<br>
**LLVM_BUILD_TOOLS**:BOOL<br>
Build LLVM tools. Defaults to ON. Targets for building each tool are generated<br>
- in any case. You can build an tool separately by invoking its target. For<br>
- example, you can build *llvm-as* with a makefile-based system executing *make<br>
- llvm-as* on the root of your build directory.<br>
+ in any case. You can build a tool separately by invoking its target. For<br>
+ example, you can build *llvm-as* with a Makefile-based system by executing *make<br>
+ llvm-as* at the root of your build directory.<br>
<br>
**LLVM_INCLUDE_TOOLS**:BOOL<br>
- Generate build targets for the LLVM tools. Defaults to ON. You can use that<br>
- option for disabling the generation of build targets for the LLVM tools.<br>
+ Generate build targets for the LLVM tools. Defaults to ON. You can use this<br>
+ option to disable the generation of build targets for the LLVM tools.<br>
<br>
**LLVM_BUILD_EXAMPLES**:BOOL<br>
Build LLVM examples. Defaults to OFF. Targets for building each example are<br>
@@ -217,20 +226,20 @@ LLVM-specific variables<br>
details.<br>
<br>
**LLVM_INCLUDE_EXAMPLES**:BOOL<br>
- Generate build targets for the LLVM examples. Defaults to ON. You can use that<br>
- option for disabling the generation of build targets for the LLVM examples.<br>
+ Generate build targets for the LLVM examples. Defaults to ON. You can use this<br>
+ option to disable the generation of build targets for the LLVM examples.<br>
<br>
**LLVM_BUILD_TESTS**:BOOL<br>
Build LLVM unit tests. Defaults to OFF. Targets for building each unit test<br>
- are generated in any case. You can build a specific unit test with the target<br>
- *UnitTestNameTests* (where at this time *UnitTestName* can be ADT, Analysis,<br>
- ExecutionEngine, JIT, Support, Transform, VMCore; see the subdirectories of<br>
- *unittests* for an updated list.) It is possible to build all unit tests with<br>
- the target *UnitTests*.<br>
+ are generated in any case. You can build a specific unit test using the<br>
+ targets defined under *unittests*, such as ADTTests, IRTests, SupportTests,<br>
+ etc. (Search for ``add_llvm_unittest`` in the subdirectories of *unittests*<br>
+ for a complete list of unit tests.) It is possible to build all unit tests<br>
+ with the target *UnitTests*.<br>
<br>
**LLVM_INCLUDE_TESTS**:BOOL<br>
Generate build targets for the LLVM unit tests. Defaults to ON. You can use<br>
- that option for disabling the generation of build targets for the LLVM unit<br>
+ this option to disable the generation of build targets for the LLVM unit<br>
tests.<br>
<br>
**LLVM_APPEND_VC_REV**:BOOL<br>
@@ -249,39 +258,39 @@ LLVM-specific variables<br>
is *Debug*.<br>
<br>
**LLVM_ENABLE_EH**:BOOL<br>
- Build LLVM with exception handling support. This is necessary if you wish to<br>
+ Build LLVM with exception-handling support. This is necessary if you wish to<br>
link against LLVM libraries and make use of C++ exceptions in your own code<br>
that need to propagate through LLVM code. Defaults to OFF.<br>
<br>
**LLVM_ENABLE_PIC**:BOOL<br>
- Add the ``-fPIC`` flag for the compiler command-line, if the compiler supports<br>
+ Add the ``-fPIC`` flag to the compiler command-line, if the compiler supports<br>
this flag. Some systems, like Windows, do not need this flag. Defaults to ON.<br>
<br>
**LLVM_ENABLE_RTTI**:BOOL<br>
- Build LLVM with run time type information. Defaults to OFF.<br>
+ Build LLVM with run-time type information. Defaults to OFF.<br>
<br>
**LLVM_ENABLE_WARNINGS**:BOOL<br>
Enable all compiler warnings. Defaults to ON.<br>
<br>
**LLVM_ENABLE_PEDANTIC**:BOOL<br>
- Enable pedantic mode. This disables compiler specific extensions, if<br>
+ Enable pedantic mode. This disables compiler-specific extensions, if<br>
possible. Defaults to ON.<br>
<br>
**LLVM_ENABLE_WERROR**:BOOL<br>
- Stop and fail build, if a compiler warning is triggered. Defaults to OFF.<br>
+ Stop and fail the build, if a compiler warning is triggered. Defaults to OFF.<br>
<br>
**LLVM_ABI_BREAKING_CHECKS**:STRING<br>
Used to decide if LLVM should be built with ABI breaking checks or<br>
not. Allowed values are `WITH_ASSERTS` (default), `FORCE_ON` and<br>
`FORCE_OFF`. `WITH_ASSERTS` turns on ABI breaking checks in an<br>
assertion enabled build. `FORCE_ON` (`FORCE_OFF`) turns them on<br>
- (off) irrespective of whether normal (`NDEBUG` based) assertions are<br>
+ (off) irrespective of whether normal (`NDEBUG`-based) assertions are<br>
enabled or not. A version of LLVM built with ABI breaking checks<br>
is not ABI compatible with a version built without it.<br>
<br>
**LLVM_BUILD_32_BITS**:BOOL<br>
- Build 32-bits executables and libraries on 64-bits systems. This option is<br>
- available only on some 64-bits unix systems. Defaults to OFF.<br>
+ Build 32-bit executables and libraries on 64-bit systems. This option is<br>
+ available only on some 64-bit Unix systems. Defaults to OFF.<br>
<br>
**LLVM_TARGET_ARCH**:STRING<br>
LLVM target to use for native code generation. This is required for JIT<br>
@@ -290,7 +299,7 @@ LLVM-specific variables<br>
to the target architecture name.<br>
<br>
**LLVM_TABLEGEN**:STRING<br>
- Full path to a native TableGen executable (usually named ``tblgen``). This is<br>
+ Full path to a native TableGen executable (usually named ``llvm-tblgen``). This is<br>
intended for cross-compiling: if the user sets this variable, no native<br>
TableGen will be created.<br>
<br>
@@ -300,29 +309,36 @@ LLVM-specific variables<br>
others.<br>
<br>
**LLVM_LIT_TOOLS_DIR**:PATH<br>
- The path to GnuWin32 tools for tests. Valid on Windows host. Defaults to "",<br>
- then Lit seeks tools according to %PATH%. Lit can find tools(eg. grep, sort,<br>
- &c) on LLVM_LIT_TOOLS_DIR at first, without specifying GnuWin32 to %PATH%.<br>
+ The path to GnuWin32 tools for tests. Valid on Windows host. Defaults to<br>
+ the empty string, in which case lit will look for tools needed for tests<br>
+ (e.g. ``grep``, ``sort``, etc.) in your %PATH%. If GnuWin32 is not in your<br>
+ %PATH%, then you can set this variable to the GnuWin32 directory so that<br>
+ lit can find tools needed for tests in that directory.<br>
<br>
**LLVM_ENABLE_FFI**:BOOL<br>
- Indicates whether LLVM Interpreter will be linked with Foreign Function<br>
- Interface library. If the library or its headers are installed on a custom<br>
- location, you can set the variables FFI_INCLUDE_DIR and<br>
- FFI_LIBRARY_DIR. Defaults to OFF.<br>
+ Indicates whether the LLVM Interpreter will be linked with the Foreign Function<br>
+ Interface library (libffi) in order to enable calling external functions.<br>
+ If the library or its headers are installed in a custom<br>
+ location, you can also set the variables FFI_INCLUDE_DIR and<br>
+ FFI_LIBRARY_DIR to the directories where ffi.h and libffi.so can be found,<br>
+ respectively. Defaults to OFF.<br>
<br>
**LLVM_EXTERNAL_{CLANG,LLD,POLLY}_SOURCE_DIR**:PATH<br>
- Path to ``{Clang,lld,Polly}``\'s source directory. Defaults to<br>
- ``tools/{clang,lld,polly}``. ``{Clang,lld,Polly}`` will not be built when it<br>
- is empty or it does not point to a valid path.<br>
+ These variables specify the path to the source directory for the external<br>
+ LLVM projects Clang, lld, and Polly, respectively, relative to the top-level<br>
+ source directory. If the in-tree subdirectory for an external project<br>
+ exists (e.g., llvm/tools/clang for Clang), then the corresponding variable<br>
+ will not be used. If the variable for an external project does not point<br>
+ to a valid path, then that project will not be built.<br>
<br>
**LLVM_USE_OPROFILE**:BOOL<br>
- Enable building OProfile JIT support. Defaults to OFF<br>
+ Enable building OProfile JIT support. Defaults to OFF.<br>
<br>
**LLVM_USE_INTEL_JITEVENTS**:BOOL<br>
- Enable building support for Intel JIT Events API. Defaults to OFF<br>
+ Enable building support for Intel JIT Events API. Defaults to OFF.<br>
<br>
**LLVM_ENABLE_ZLIB**:BOOL<br>
- Build with zlib to support compression/uncompression in LLVM tools.<br>
+ Enable building with zlib to support compression/uncompression in LLVM tools.<br>
Defaults to ON.<br>
<br>
**LLVM_USE_SANITIZER**:STRING<br>
@@ -361,14 +377,14 @@ LLVM-specific variables<br>
``org.llvm.qch``.<br>
This option is only useful in combination with<br>
``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``;<br>
- otherwise this has no effect.<br>
+ otherwise it has no effect.<br>
<br>
**LLVM_DOXYGEN_QHP_NAMESPACE**:STRING<br>
Namespace under which the intermediate Qt Help Project file lives. See `Qt<br>
Help Project`_<br>
for more information. Defaults to "org.llvm". This option is only useful in<br>
combination with ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``; otherwise<br>
- this has no effect.<br>
+ it has no effect.<br>
<br>
**LLVM_DOXYGEN_QHP_CUST_FILTER_NAME**:STRING<br>
See `Qt Help Project`_ for<br>
@@ -377,14 +393,14 @@ LLVM-specific variables<br>
be used in Qt Creator to select only documentation from LLVM when browsing<br>
through all the help files that you might have loaded. This option is only<br>
useful in combination with ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``;<br>
- otherwise this has no effect.<br>
+ otherwise it has no effect.<br>
<br>
.. _Qt Help Project: <a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters" rel="noreferrer" target="_blank">http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters</a><br>
<br>
**LLVM_DOXYGEN_QHELPGENERATOR_PATH**:STRING<br>
The path to the ``qhelpgenerator`` executable. Defaults to whatever CMake's<br>
``find_program()`` can find. This option is only useful in combination with<br>
- ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``; otherwise this has no<br>
+ ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``; otherwise it has no<br>
effect.<br>
<br>
**LLVM_DOXYGEN_SVG**:BOOL<br>
@@ -419,15 +435,15 @@ LLVM-specific variables<br>
Executing the test suite<br>
========================<br>
<br>
-Testing is performed when the *check* target is built. For instance, if you are<br>
-using makefiles, execute this command while on the top level of your build<br>
-directory:<br>
+Testing is performed when the *check-all* target is built. For instance, if you are<br>
+using Makefiles, execute this command in the root of your build directory:<br>
<br>
.. code-block:: console<br>
<br>
- $ make check<br>
+ $ make check-all<br>
<br>
-On Visual Studio, you may run tests to build the project "check".<br>
+On Visual Studio, you may run tests by building the project "check-all".<br>
+For more information about testing, see the :doc:`TestingGuide`.<br>
<br>
Cross compiling<br>
===============<br>
@@ -447,10 +463,10 @@ Embedding LLVM in your project<br>
<br>
From LLVM 3.5 onwards both the CMake and autoconf/Makefile build systems export<br>
LLVM libraries as importable CMake targets. This means that clients of LLVM can<br>
-now reliably use CMake to develop their own LLVM based projects against an<br>
+now reliably use CMake to develop their own LLVM-based projects against an<br>
installed version of LLVM regardless of how it was built.<br>
<br>
-Here is a simple example of CMakeLists.txt file that imports the LLVM libraries<br>
+Here is a simple example of a CMakeLists.txt file that imports the LLVM libraries<br>
and uses them to build a simple application ``simple-tool``.<br>
<br>
.. code-block:: cmake<br>
@@ -495,8 +511,8 @@ This file is available in two different<br>
On Linux typically this is ``/usr/share/llvm/cmake/LLVMConfig.cmake``.<br>
<br>
* ``<LLVM_BUILD_ROOT>/share/llvm/cmake/LLVMConfig.cmake`` where<br>
- ``<LLVM_BUILD_ROOT>`` is the root of the LLVM build tree. **Note this only<br>
- available when building LLVM with CMake**<br>
+ ``<LLVM_BUILD_ROOT>`` is the root of the LLVM build tree. **Note: this is only<br>
+ available when building LLVM with CMake.**<br>
<br>
If LLVM is installed in your operating system's normal installation prefix (e.g.<br>
on Linux this is usually ``/usr/``) ``find_package(LLVM ...)`` will<br>
@@ -529,7 +545,7 @@ include<br>
A list of include paths to directories containing LLVM header files.<br>
<br>
``LLVM_PACKAGE_VERSION``<br>
- The LLVM version. This string can be used with CMake conditionals. E.g. ``if<br>
+ The LLVM version. This string can be used with CMake conditionals, e.g., ``if<br>
(${LLVM_PACKAGE_VERSION} VERSION_LESS "3.5")``.<br>
<br>
``LLVM_TOOLS_BINARY_DIR``<br>
@@ -582,7 +598,7 @@ Contents of ``<project dir>/<pass name>/<br>
<br>
Note if you intend for this pass to be merged into the LLVM source tree at some<br>
point in the future it might make more sense to use LLVM's internal<br>
-add_llvm_loadable_module function instead by...<br>
+``add_llvm_loadable_module`` function instead by...<br>
<br>
<br>
Adding the following to ``<project dir>/CMakeLists.txt`` (after<br>
@@ -602,7 +618,7 @@ And then changing ``<project dir>/<pass<br>
)<br>
<br>
When you are done developing your pass, you may wish to integrate it<br>
-into LLVM source tree. You can achieve it in two easy steps:<br>
+into the LLVM source tree. You can achieve it in two easy steps:<br>
<br>
#. Copying ``<pass name>`` folder into ``<LLVM root>/lib/Transform`` directory.<br>
<br>
@@ -618,6 +634,6 @@ Microsoft Visual C++<br>
--------------------<br>
<br>
**LLVM_COMPILER_JOBS**:STRING<br>
- Specifies the maximum number of parallell compiler jobs to use per project<br>
+ Specifies the maximum number of parallel compiler jobs to use per project<br>
when building with msbuild or Visual Studio. Only supported for the Visual<br>
Studio 2010 CMake generator. 0 means use all processors. Default is 0.<br>
<br>
<br>
_______________________________________________<br>
llvm-commits mailing list<br>
<a href="mailto:llvm-commits@lists.llvm.org">llvm-commits@lists.llvm.org</a><br>
<a href="http://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-commits" rel="noreferrer" target="_blank">http://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-commits</a><br>
</blockquote></div><br></div>