Edits to CMake.rst for clarity's sake

[gaeke]

Summary

Having recently followed some of the instructions in CMake.rst I am
submitting this patch to try to improve it a little. Any comments
are appreciated.

Highlights:

• Fix some grammatical and typographical errors.
• Try to improve upon some awkward/nonstandard phrasings.
• Expand slightly the treatment of how you specify arguments to cmake.
• Update the list of possible LLVM_BUILD_TESTS and state where to find the definitive list.
• Correct the name of llvm-tblgen.
• Expand slightly the treatment of several build options, including LLVM_LIT_TOOLS_DIR, LLVM_ENABLE_FFI, and LLVM_EXTERNAL_project_SOURCE_DIR.

[gaeke]

Edits to CMake.rst for clarity's sake [updated]

Rebased the patch against current trunk.

[vsk]

Thanks for your work on this! Comments inline.

docs/CMake.rst

34–35

"Create a build directory", perhaps?

106

Maybe just: "CMake requires that you specify a build tool (e.g ..."

113

The text-wrapping changes here for some reason. Could you maintain the original width?

118–123

I suggest dropping the plural possessive and just going for "This will list the generator names".

144

Does this need to be capitalized?

171

Please omit this.

439

"while at" --> "in"

[gaeke]

Thanks for your feedback. I will submit a new patch shortly.

docs/CMake.rst

106

I am going to go with "allows you to specify", as we go on immediately to state that CMake tries to figure out which tool you want to use if you don't specify it.

113

I have tried to do this in my new version. Sorry about that. There were a lot of changes in this paragraph.

[gaeke]

This new version of the patch incorporates changes based on vsk's feedback.

[chapuni]

LGTM, but I won't approve it since I am not native English speaker.
Thanks for you work!

docs/CMake.rst

72

One nitpicking. I suppose almost all guys wouldn't use "cmake --build".
We might refine around there later. (Don't care in this review, though)

127

We dropped "Visual Studio 11", aka msc17, in trunk.
We might upgrade it, regardless of this review.

202–203

BUILD_SHARED_LIBS is unsupported by MS toolchain, CL.EXE and LINK.EXE.

Mingw32(including mingw-w64) supports BUILD_SHARED_LIBS.

315–316

I introduced this section.

I took %PATH%, rather than PATH or $PATH to clarify this aims Windows platform.

333

They don't have default value any more.

• It isn't referred if in-tree subdirectory, for example llvm/tools/clang &c. exists.
• It should be set explicitlly if corresponding subproject is out of tree.

For now, I suggest not to mention default behavior.
See also changelog in llvm/cmake/modules/AddLLVM.cmake.

443

IIRC, we have a plan to let "check" obsoleted.
I suggest to use "check-llvm" or "check-all" here.

[chapuni]

docs/CMake.rst

238–240

Are you really willing to maintain this list whenever an unittest were added or removed?
I suggest here might be generalized presentation, for example "ADTTests, IRTests, etc. in llvm/unittests".

[gaeke]

Thanks for your comments. I will post an updated patch soon.

docs/CMake.rst

72

I will leave it for now. cmake --build works well for me so far.

127

OK. I changed it to "Visual Studio 12".

202–203

OK. I revised this to state that shared libraries are supported if you use MinGW or mingw-w64.

238–240

I agree. I have replaced this list with a small subset.

315–316

I changed both PATH occurrences back to %PATH%.

333

I reworded this to incorporate the points you stated here.

443

OK. Should check-all be specified for Visual Studio as well? For now, I have changed the first two occurrences, and left the sentence about Visual Studio as-is.

[gaeke]

This new version of the patch incorporates changes based on chapuni's feedback.

[chapuni]

docs/CMake.rst

202–204

I wonder it might misunderstand like
"BUILD_SHARED_LIBS is recommended on mingw."

IMO, BUILD_SHARED_LIBS is an option for developers.

443

Yes. in trunk, "check" is an alias of "check-llvm".
For consistency in CMake scripts, "check-*" is the primary target and "check" is compatible stuff for autoconf Make.

You may also mention "check-*" to run tests for individual subproject, here.

445

Although I am not a user of Xcode, I guess it might be generic for IDE Generators.

[vsk]

LGTM.

[gaeke]

Thanks for your comments. I will submit another patch soon.

docs/CMake.rst

202–204

OK, I revised this to warn people that it is not for general use.

443

OK, I changed the third occurrence to "check-all" as well. I don't think it makes a lot of sense to go too deeply into testing procedures here. It seems like people should consult the TestingGuide for that.

445

I'm not a user of Xcode either. If other people want to edit this to explain what the situation is for Xcode, or for other IDEs, I will leave that up to them.

[gaeke]

This new version of the patch incorporates changes based on chapuni's 2nd set of comments.

docs/CMake.rst

 ========================
 Building LLVM with CMake
 ========================
 
 .. contents::
    :local:
 
 Introduction
 ============
 
 `CMake <http://www.cmake.org/>`_ is a cross-platform build-generator tool. CMake
 does not build the project, it generates the files needed by your build tool
-(GNU make, Visual Studio, etc) for building LLVM.
+(GNU make, Visual Studio, etc.) for building LLVM.
 
 If you are really anxious about getting a functional LLVM build, go to the
-`Quick start`_ section. If you are a CMake novice, start on `Basic CMake usage`_
-and then go back to the `Quick start`_ once you know what you are doing. The
+`Quick start`_ section. If you are a CMake novice, start with `Basic CMake usage`_
+and then go back to the `Quick start`_ section once you know what you are doing. The
 `Options and variables`_ section is a reference for customizing your build. If
 you already have experience with CMake, this is the recommended starting point.
 
 .. _Quick start:
 
 Quick start
 ===========
 
 We use here the command-line, non-interactive CMake interface.
 
 #. `Download <http://www.cmake.org/cmake/resources/software.html>`_ and install
    CMake. Version 2.8.8 is the minimum required.
 
 #. Open a shell. Your development tools must be reachable from this shell
    through the PATH environment variable.
 
-#. Create a directory for containing the build. It is not supported to build
-   LLVM on the source directory. cd to this directory:
+#. Create a directory to contain the build. Building LLVM in the source
+   directory is not supported. cd to this directory:
 
    .. code-block:: console
 
      $ mkdir mybuilddir
      $ cd mybuilddir
 
-#. Execute this command on the shell replacing `path/to/llvm/source/root` with
+#. Execute this command in the shell replacing `path/to/llvm/source/root` with
    the path to the root of your LLVM source tree:
 
    .. code-block:: console
 
      $ cmake path/to/llvm/source/root
 
-   CMake will detect your development environment, perform a series of test and
+   CMake will detect your development environment, perform a series of tests, and
    generate the files required for building LLVM. CMake will use default values
    for all build parameters. See the `Options and variables`_ section for
-   fine-tuning your build
+   a list of build parameters that you can modify.
 
    This can fail if CMake can't detect your toolset, or if it thinks that the
-   environment is not sane enough. On this case make sure that the toolset that
-   you intend to use is the only one reachable from the shell and that the shell
-   itself is the correct one for you development environment. CMake will refuse
+   environment is not sane enough. In this case, make sure that the toolset that
+   you intend to use is the only one reachable from the shell, and that the shell
+   itself is the correct one for your development environment. CMake will refuse
    to build MinGW makefiles if you have a POSIX shell reachable through the PATH
    environment variable, for instance. You can force CMake to use a given build
-   tool, see the `Usage`_ section.
+   tool; for instructions, see the `Usage`_ section, below.
 
-#. After CMake has finished running, proceed to use IDE project files or start
+#. After CMake has finished running, proceed to use IDE project files, or start
    the build from the build directory:
 
    .. code-block:: console
 
      $ cmake --build .
 
    The ``--build`` option tells ``cmake`` to invoke the underlying build
-   tool (``make``, ``ninja``, ``xcodebuild``, ``msbuild``, etc).
+   tool (``make``, ``ninja``, ``xcodebuild``, ``msbuild``, etc.)
 
-   The underlying build tool can be invoked directly either of course, but
+   The underlying build tool can be invoked directly, of course, but
    the ``--build`` option is portable.
 
 #. After LLVM has finished building, install it from the build directory:
 
    .. code-block:: console
 
      $ cmake --build . --target install
 
.. code-block:: console
      $ cmake -DCMAKE_INSTALL_PREFIX=/tmp/llvm -P cmake_install.cmake
 
 .. _Basic CMake usage:
 .. _Usage:
 
 Basic CMake usage
 =================
 
-This section explains basic aspects of CMake, mostly for explaining those
-options which you may need on your day-to-day usage.
+This section explains basic aspects of CMake
+which you may need in your day-to-day usage.
 
-CMake comes with extensive documentation in the form of html files and on the
-cmake executable itself. Execute ``cmake --help`` for further help options.
-
-CMake requires to know for which build tool it shall generate files (GNU make,
-Visual Studio, Xcode, etc). If not specified on the command line, it tries to
-guess it based on you environment. Once identified the build tool, CMake uses
-the corresponding *Generator* for creating files for your build tool. You can
-explicitly specify the generator with the command line option ``-G "Name of the
-generator"``. For knowing the available generators on your platform, execute
+CMake comes with extensive documentation, in the form of html files, and as
+online help accessible via the ``cmake`` executable itself. Execute ``cmake
+--help`` for further help options.
+
+CMake requires that you specify for which build tool it shall generate
+files (e.g., GNU make, Visual Studio, or Xcode). If not specified on
+the command line, CMake tries to guess which build tool to use, based on
+your environment. Once it has identified your build tool, CMake uses the
+corresponding *Generator* to create files for your build tool (e.g., Makefiles
+or Visual Studio or Xcode project files). You can explicitly specify the
+generator with the command line option ``-G "Name of the generator"``. To
+see a list of the available generators on your system, execute
 
 .. code-block:: console
 
   $ cmake --help
 
-This will list the generator's names at the end of the help text. Generator's
-names are case-sensitive. Example:
+This will list the generators' names at the end of the help text.
+
+Generators' names are case-sensitive, and may contain spaces. For this reason,
+you should enter them exactly as they are listed in the ``cmake --help``
+output, in quotes. For example, to generate project files specifically for
+Visual Studio 11, you can execute:
 
 .. code-block:: console
 
   $ cmake -G "Visual Studio 11" path/to/llvm/source/root
 
 For a given development platform there can be more than one adequate
-generator. If you use Visual Studio "NMake Makefiles" is a generator you can use
-for building with NMake. By default, CMake chooses the more specific generator
+generator. If you use Visual Studio, "NMake Makefiles" is a generator you can use
+for building with NMake. By default, CMake chooses the most specific generator
 supported by your development environment. If you want an alternative generator,
 you must tell this to CMake with the ``-G`` option.
 
 .. todo::
 
   Explain variables and cache. Move explanation here from #options section.
 
 .. _Options and variables:
 
 Options and variables
 =====================
 
-Variables customize how the build will be generated. Options are boolean
+Variables customize how the build will be generated. Options are Boolean
 variables, with possible values ON/OFF. Options and variables are defined on the
 CMake command line like this:
 
 .. code-block:: console
 
   $ cmake -DVARIABLE=value path/to/llvm/source
 
-You can set a variable after the initial CMake invocation for changing its
+You can set a variable after the initial CMake invocation to change its
 value. You can also undefine a variable:
 
 .. code-block:: console
 
   $ cmake -UVARIABLE path/to/llvm/source
 
-Variables are stored on the CMake cache. This is a file named ``CMakeCache.txt``
-on the root of the build directory. Do not hand-edit it.
-
-Variables are listed here appending its type after a colon. It is correct to
-write the variable and the type on the CMake command line:
+Variables are stored in the CMake cache. This is a file named ``CMakeCache.txt``
+stored at the root of your build directory that is generated by ``cmake``.
+Editing it yourself is not recommended.
+
+Variables are listed in the CMake cache and later in this document with
+the variable name and type separated by a colon. You can also specify the
+variable and type on the CMake command line:
 
 .. code-block:: console
 
   $ cmake -DVARIABLE:TYPE=value path/to/llvm/source
 
+But this is not typically necessary.
+
 Frequently-used CMake variables
 -------------------------------
 
 Here are some of the CMake variables that are used often, along with a
-brief explanation and LLVM-specific notes. For full documentation, check the
-CMake docs or execute ``cmake --help-variable VARIABLE_NAME``.
+brief explanation and LLVM-specific notes. For full documentation, consult the
+CMake manual, or execute ``cmake --help-variable VARIABLE_NAME``.
 
 **CMAKE_BUILD_TYPE**:STRING
-  Sets the build type for ``make`` based generators. Possible values are
-  Release, Debug, RelWithDebInfo and MinSizeRel. On systems like Visual Studio
-  the user sets the build type with the IDE settings.
+  Sets the build type for ``make``-based generators. Possible values are
+  Release, Debug, RelWithDebInfo and MinSizeRel. If you are using an IDE such as
+  Visual Studio, you should use the IDE settings to set the build type.
 
 **CMAKE_INSTALL_PREFIX**:PATH
   Path where LLVM will be installed if "make install" is invoked or the
-  "INSTALL" target is built.
+  "install" target is built.
 
 **LLVM_LIBDIR_SUFFIX**:STRING
   Extra suffix to append to the directory where libraries are to be
   installed. On a 64-bit architecture, one could use ``-DLLVM_LIBDIR_SUFFIX=64``
   to install libraries to ``/usr/lib64``.
 
 **CMAKE_C_FLAGS**:STRING
   Extra flags to use when compiling C source files.
 
 **CMAKE_CXX_FLAGS**:STRING
   Extra flags to use when compiling C++ source files.
 
 **BUILD_SHARED_LIBS**:BOOL
   Flag indicating if shared libraries will be built. Its default value is
-  OFF. Shared libraries are not supported on Windows and not recommended on the
-  other OSes.
+  OFF. Shared libraries are not supported on Windows and not recommended on
+  other operating systems.
 
 .. _LLVM-specific variables:
 
 LLVM-specific variables
 -----------------------
 
 **LLVM_TARGETS_TO_BUILD**:STRING
   Semicolon-separated list of targets to build, or *all* for building all
   targets. Case-sensitive. Defaults to *all*. Example:
   ``-DLLVM_TARGETS_TO_BUILD="X86;PowerPC"``.
 
 **LLVM_BUILD_TOOLS**:BOOL
   Build LLVM tools. Defaults to ON. Targets for building each tool are generated
-  in any case. You can build an tool separately by invoking its target. For
-  example, you can build *llvm-as* with a makefile-based system executing *make
-  llvm-as* on the root of your build directory.
+  in any case. You can build a tool separately by invoking its target. For
+  example, you can build *llvm-as* with a Makefile-based system by executing *make
+  llvm-as* at the root of your build directory.
 
 **LLVM_INCLUDE_TOOLS**:BOOL
-  Generate build targets for the LLVM tools. Defaults to ON. You can use that
-  option for disabling the generation of build targets for the LLVM tools.
+  Generate build targets for the LLVM tools. Defaults to ON. You can use this
+  option to disable the generation of build targets for the LLVM tools.
 
 **LLVM_BUILD_EXAMPLES**:BOOL
   Build LLVM examples. Defaults to OFF. Targets for building each example are
   generated in any case. See documentation for *LLVM_BUILD_TOOLS* above for more
   details.
 
 **LLVM_INCLUDE_EXAMPLES**:BOOL
-  Generate build targets for the LLVM examples. Defaults to ON. You can use that
-  option for disabling the generation of build targets for the LLVM examples.
+  Generate build targets for the LLVM examples. Defaults to ON. You can use this
+  option to disable the generation of build targets for the LLVM examples.
 
 **LLVM_BUILD_TESTS**:BOOL
   Build LLVM unit tests. Defaults to OFF. Targets for building each unit test
   are generated in any case. You can build a specific unit test with the target
   *UnitTestNameTests* (where at this time *UnitTestName* can be ADT, Analysis,
-  ExecutionEngine, JIT, Support, Transform, VMCore; see the subdirectories of
+  AsmParser, Bitcode, CodeGen, DebugInfoDWARF, DebugInfoPDB, ExecutionEngine,
+  IPO, IR, LineEditor, Linker, MCJIT, MC, Option, OrcJIT, ProfileData, Support,
+  or Utils; search for ``add_llvm_unittest`` in the subdirectories of
   *unittests* for an updated list.) It is possible to build all unit tests with
   the target *UnitTests*.
 
 **LLVM_INCLUDE_TESTS**:BOOL
   Generate build targets for the LLVM unit tests. Defaults to ON. You can use
-  that option for disabling the generation of build targets for the LLVM unit
+  this option to disable the generation of build targets for the LLVM unit
   tests.
 
 **LLVM_APPEND_VC_REV**:BOOL
   Append version control revision info (svn revision number or Git revision id)
   to LLVM version string (stored in the PACKAGE_VERSION macro). For this to work
   cmake must be invoked before the build. Defaults to OFF.
 
 **LLVM_ENABLE_THREADS**:BOOL
   Build with threads support, if available. Defaults to ON.
 
 **LLVM_ENABLE_CXX1Y**:BOOL
   Build in C++1y mode, if available. Defaults to OFF.
 
 **LLVM_ENABLE_ASSERTIONS**:BOOL
   Enables code assertions. Defaults to ON if and only if ``CMAKE_BUILD_TYPE``
   is *Debug*.
 
 **LLVM_ENABLE_EH**:BOOL
-  Build LLVM with exception handling support. This is necessary if you wish to
+  Build LLVM with exception-handling support. This is necessary if you wish to
   link against LLVM libraries and make use of C++ exceptions in your own code
   that need to propagate through LLVM code. Defaults to OFF.
 
 **LLVM_ENABLE_PIC**:BOOL
-  Add the ``-fPIC`` flag for the compiler command-line, if the compiler supports
+  Add the ``-fPIC`` flag to the compiler command-line, if the compiler supports
   this flag. Some systems, like Windows, do not need this flag. Defaults to ON.
 
 **LLVM_ENABLE_RTTI**:BOOL
-  Build LLVM with run time type information. Defaults to OFF.
+  Build LLVM with run-time type information. Defaults to OFF.
 
 **LLVM_ENABLE_WARNINGS**:BOOL
   Enable all compiler warnings. Defaults to ON.
 
 **LLVM_ENABLE_PEDANTIC**:BOOL
-  Enable pedantic mode. This disables compiler specific extensions, if
+  Enable pedantic mode. This disables compiler-specific extensions, if
   possible. Defaults to ON.
 
 **LLVM_ENABLE_WERROR**:BOOL
-  Stop and fail build, if a compiler warning is triggered. Defaults to OFF.
+  Stop and fail the build, if a compiler warning is triggered. Defaults to OFF.
 
 **LLVM_ABI_BREAKING_CHECKS**:STRING
   Used to decide if LLVM should be built with ABI breaking checks or
   not.  Allowed values are `WITH_ASSERTS` (default), `FORCE_ON` and
   `FORCE_OFF`.  `WITH_ASSERTS` turns on ABI breaking checks in an
   assertion enabled build.  `FORCE_ON` (`FORCE_OFF`) turns them on
-  (off) irrespective of whether normal (`NDEBUG` based) assertions are
+  (off) irrespective of whether normal (`NDEBUG`-based) assertions are
   enabled or not.  A version of LLVM built with ABI breaking checks
   is not ABI compatible with a version built without it.
 
 **LLVM_BUILD_32_BITS**:BOOL
-  Build 32-bits executables and libraries on 64-bits systems. This option is
-  available only on some 64-bits unix systems. Defaults to OFF.
+  Build 32-bit executables and libraries on 64-bit systems. This option is
+  available only on some 64-bit Unix systems. Defaults to OFF.
 
 **LLVM_TARGET_ARCH**:STRING
   LLVM target to use for native code generation. This is required for JIT
   generation. It defaults to "host", meaning that it shall pick the architecture
   of the machine where LLVM is being built. If you are cross-compiling, set it
   to the target architecture name.
 
 **LLVM_TABLEGEN**:STRING
-  Full path to a native TableGen executable (usually named ``tblgen``). This is
+  Full path to a native TableGen executable (usually named ``llvm-tblgen``). This is
   intended for cross-compiling: if the user sets this variable, no native
   TableGen will be created.
 
 **LLVM_LIT_ARGS**:STRING
   Arguments given to lit.  ``make check`` and ``make clang-test`` are affected.
   By default, ``'-sv --no-progress-bar'`` on Visual C++ and Xcode, ``'-sv'`` on
   others.
 
 **LLVM_LIT_TOOLS_DIR**:PATH
-  The path to GnuWin32 tools for tests. Valid on Windows host.  Defaults to "",
-  then Lit seeks tools according to %PATH%.  Lit can find tools(eg. grep, sort,
-  &c) on LLVM_LIT_TOOLS_DIR at first, without specifying GnuWin32 to %PATH%.
+  The path to GnuWin32 tools for tests. Valid on Windows host.  Defaults to
+  the empty string, in which case lit will look for tools needed for tests
+  (e.g. ``grep``, ``sort``, etc.) in your PATH. If GnuWin32 is not in your
+  PATH, then you can set this variable to the GnuWin32 directory so that
+  lit can find tools needed for tests in that directory.
 
 **LLVM_ENABLE_FFI**:BOOL
-  Indicates whether LLVM Interpreter will be linked with Foreign Function
-  Interface library. If the library or its headers are installed on a custom
-  location, you can set the variables FFI_INCLUDE_DIR and
-  FFI_LIBRARY_DIR. Defaults to OFF.
+  Indicates whether the LLVM Interpreter will be linked with the Foreign Function
+  Interface library (libffi) in order to enable calling external functions.
+  If the library or its headers are installed in a custom
+  location, you can also set the variables FFI_INCLUDE_DIR and
+  FFI_LIBRARY_DIR to the directories where ffi.h and libffi.so can be found,
+  respectively. Defaults to OFF.
 
 **LLVM_EXTERNAL_{CLANG,LLD,POLLY}_SOURCE_DIR**:PATH
-  Path to ``{Clang,lld,Polly}``\'s source directory. Defaults to
-  ``tools/{clang,lld,polly}``. ``{Clang,lld,Polly}`` will not be built when it
-  is empty or it does not point to a valid path.
+  These variables specify the path to the source directory for the external
+  LLVM projects Clang, lld, and Polly, respectively, relative to the
+  top-level source directory. Defaults to ``tools/clang``, ``tools/lld``, and
+  ``tools/polly``, respectively.  If the variable for an external project
+  is empty, or does not point to a valid path, then that project will not
+  be built.
 
 **LLVM_USE_OPROFILE**:BOOL
-  Enable building OProfile JIT support. Defaults to OFF
+  Enable building OProfile JIT support. Defaults to OFF.
 
 **LLVM_USE_INTEL_JITEVENTS**:BOOL
-  Enable building support for Intel JIT Events API. Defaults to OFF
+  Enable building support for Intel JIT Events API. Defaults to OFF.
 
 **LLVM_ENABLE_ZLIB**:BOOL
-  Build with zlib to support compression/uncompression in LLVM tools.
+  Enable building with zlib to support compression/uncompression in LLVM tools.
   Defaults to ON.
 
 **LLVM_USE_SANITIZER**:STRING
   Define the sanitizer used to build LLVM binaries and tests. Possible values
   are ``Address``, ``Memory``, ``MemoryWithOrigins``, ``Undefined``, ``Thread``,
   and ``Address;Undefined``. Defaults to empty string.
 
 **LLVM_PARALLEL_COMPILE_JOBS**:STRING

 
 **LLVM_DOXYGEN_QCH_FILENAME**:STRING
   The filename of the Qt Compressed Help file that will be generated when
   ``-DLLVM_ENABLE_DOXYGEN=ON`` and
   ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON`` are given. Defaults to
   ``org.llvm.qch``.
   This option is only useful in combination with
   ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``;
-  otherwise this has no effect.
+  otherwise it has no effect.
 
 **LLVM_DOXYGEN_QHP_NAMESPACE**:STRING
   Namespace under which the intermediate Qt Help Project file lives. See `Qt
   Help Project`_
   for more information. Defaults to "org.llvm". This option is only useful in
   combination with ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``; otherwise
-  this has no effect.
+  it has no effect.
 
 **LLVM_DOXYGEN_QHP_CUST_FILTER_NAME**:STRING
   See `Qt Help Project`_ for
   more information. Defaults to the CMake variable ``${PACKAGE_STRING}`` which
   is a combination of the package name and version string. This filter can then
   be used in Qt Creator to select only documentation from LLVM when browsing
   through all the help files that you might have loaded. This option is only
   useful in combination with ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``;
-  otherwise this has no effect.
+  otherwise it has no effect.
 
 .. _Qt Help Project: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters
 
 **LLVM_DOXYGEN_QHELPGENERATOR_PATH**:STRING
   The path to the ``qhelpgenerator`` executable. Defaults to whatever CMake's
   ``find_program()`` can find. This option is only useful in combination with
-  ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``; otherwise this has no
+  ``-DLLVM_ENABLE_DOXYGEN_QT_HELP=ON``; otherwise it has no
   effect.
 
 **LLVM_ENABLE_SPHINX**:BOOL
   If enabled CMake will search for the ``sphinx-build`` executable and will make
   the ``SPHINX_OUTPUT_HTML`` and ``SPHINX_OUTPUT_MAN`` CMake options available.
   Defaults to OFF.
 
 **SPHINX_EXECUTABLE**:STRING

 **SPHINX_WARNINGS_AS_ERRORS**:BOOL
   If enabled then sphinx documentation warnings will be treated as
   errors. Defaults to ON.
 
 Executing the test suite
 ========================
 
 Testing is performed when the *check* target is built. For instance, if you are
-using makefiles, execute this command while on the top level of your build
-directory:
+using Makefiles, execute this command while at the root of your build directory:
 
 .. code-block:: console
 
   $ make check
 
-On Visual Studio, you may run tests to build the project "check".
+On Visual Studio, you may run tests by building the project "check".
 
 Cross compiling
 ===============
 
 See `this wiki page <http://www.vtk.org/Wiki/CMake_Cross_Compiling>`_ for
 generic instructions on how to cross-compile with CMake. It goes into detailed
 explanations and may seem daunting, but it is not. On the wiki page there are
 several examples including toolchain files. Go directly to `this section
 <http://www.vtk.org/Wiki/CMake_Cross_Compiling#Information_how_to_set_up_various_cross_compiling_toolchains>`_
 for a quick solution.
 
 Also see the `LLVM-specific variables`_ section for variables used when
 cross-compiling.
 
 Embedding LLVM in your project
 ==============================
 
 From LLVM 3.5 onwards both the CMake and autoconf/Makefile build systems export
 LLVM libraries as importable CMake targets. This means that clients of LLVM can
-now reliably use CMake to develop their own LLVM based projects against an
+now reliably use CMake to develop their own LLVM-based projects against an
 installed version of LLVM regardless of how it was built.
 
-Here is a simple example of CMakeLists.txt file that imports the LLVM libraries
+Here is a simple example of a CMakeLists.txt file that imports the LLVM libraries
 and uses them to build a simple application ``simple-tool``.
 
 .. code-block:: cmake
 
   cmake_minimum_required(VERSION 2.8.8)
   project(SimpleProject)
 
   find_package(LLVM REQUIRED CONFIG)

 
 This file is available in two different locations.
 
 * ``<INSTALL_PREFIX>/share/llvm/cmake/LLVMConfig.cmake`` where
   ``<INSTALL_PREFIX>`` is the install prefix of an installed version of LLVM.
   On Linux typically this is ``/usr/share/llvm/cmake/LLVMConfig.cmake``.
 
 * ``<LLVM_BUILD_ROOT>/share/llvm/cmake/LLVMConfig.cmake`` where
-  ``<LLVM_BUILD_ROOT>`` is the root of the LLVM build tree. **Note this only
-  available when building LLVM with CMake**
+  ``<LLVM_BUILD_ROOT>`` is the root of the LLVM build tree. **Note: this is only
+  available when building LLVM with CMake.**
 
 If LLVM is installed in your operating system's normal installation prefix (e.g.
 on Linux this is usually ``/usr/``) ``find_package(LLVM ...)`` will
 automatically find LLVM if it is installed correctly. If LLVM is not installed
 or you wish to build directly against the LLVM build tree you can use
 ``LLVM_DIR`` as previously mentioned.
 
 The ``LLVMConfig.cmake`` file sets various useful variables. Notable variables

 ``LLVM_ENABLE_RTTI``
   This is set to ON if LLVM was built with run time type information (RTTI),
   otherwise OFF.
 
 ``LLVM_INCLUDE_DIRS``
   A list of include paths to directories containing LLVM header files.
 
 ``LLVM_PACKAGE_VERSION``
-  The LLVM version. This string can be used with CMake conditionals. E.g. ``if
+  The LLVM version. This string can be used with CMake conditionals, e.g., ``if
   (${LLVM_PACKAGE_VERSION} VERSION_LESS "3.5")``.
 
 ``LLVM_TOOLS_BINARY_DIR``
   The path to the directory containing the LLVM tools (e.g. ``llvm-as``).
 
 Notice that in the above example we link ``simple-tool`` against several LLVM
 libraries. The list of libraries is determined by using the
 ``llvm_map_components_to_libnames()`` CMake function. For a list of available

 Contents of ``<project dir>/<pass name>/CMakeLists.txt``:
 
 .. code-block:: cmake
 
   add_library(LLVMPassname MODULE Pass.cpp)
 
 Note if you intend for this pass to be merged into the LLVM source tree at some
 point in the future it might make more sense to use LLVM's internal
-add_llvm_loadable_module function instead by...
+``add_llvm_loadable_module`` function instead by...
 
 
 Adding the following to ``<project dir>/CMakeLists.txt`` (after
 ``find_package(LLVM ...)``)
 
 .. code-block:: cmake
 
   list(APPEND CMAKE_MODULE_PATH "${LLVM_CMAKE_DIR}")
   include(AddLLVM)
 
 And then changing ``<project dir>/<pass name>/CMakeLists.txt`` to
 
 .. code-block:: cmake
 
   add_llvm_loadable_module(LLVMPassname
     Pass.cpp
     )
 
 When you are done developing your pass, you may wish to integrate it
-into LLVM source tree. You can achieve it in two easy steps:
+into the LLVM source tree. You can achieve it in two easy steps:
 
 #. Copying ``<pass name>`` folder into ``<LLVM root>/lib/Transform`` directory.
 
 #. Adding ``add_subdirectory(<pass name>)`` line into
    ``<LLVM root>/lib/Transform/CMakeLists.txt``.
 
 Compiler/Platform-specific topics
 =================================
 
 Notes for specific compilers and/or platforms.
 
 Microsoft Visual C++
 --------------------
 
 **LLVM_COMPILER_JOBS**:STRING
-  Specifies the maximum number of parallell compiler jobs to use per project
+  Specifies the maximum number of parallel compiler jobs to use per project
   when building with msbuild or Visual Studio. Only supported for the Visual
   Studio 2010 CMake generator. 0 means use all processors. Default is 0.