[clang-tools-extra] r237554 - docs: Spell a couple of cmake options with =ON in the docs

Justin Bogner mail at justinbogner.com
Sun May 17 22:05:50 PDT 2015


Author: bogner
Date: Mon May 18 00:05:49 2015
New Revision: 237554

URL: http://llvm.org/viewvc/llvm-project?rev=237554&view=rev
Log:
docs: Spell a couple of cmake options with =ON in the docs

Patch by Albert Astals Cid. Thanks!

Modified:
    clang-tools-extra/trunk/docs/ModernizerUsage.rst
    clang-tools-extra/trunk/docs/clang-modernize.rst

Modified: clang-tools-extra/trunk/docs/ModernizerUsage.rst
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/ModernizerUsage.rst?rev=237554&r1=237553&r2=237554&view=diff
==============================================================================
--- clang-tools-extra/trunk/docs/ModernizerUsage.rst (original)
+++ clang-tools-extra/trunk/docs/ModernizerUsage.rst Mon May 18 00:05:49 2015
@@ -38,9 +38,9 @@ General Command Line Options
   ``<build-path>`` is the directory containing a *compilation databasefile*, a
   file named ``compile_commands.json``, which provides compiler arguments for
   building each source file. CMake can generate this file by specifying
-  ``-DCMAKE_EXPORT_COMPILE_COMMANDS`` when running CMake. Ninja_, since v1.2 can
-  also generate this file with ``ninja -t compdb``. If the compilation database
-  cannot be used for any reason, an error is reported.
+  ``-DCMAKE_EXPORT_COMPILE_COMMANDS=ON`` when running CMake. Ninja_, since v1.2
+  can also generate this file with ``ninja -t compdb``. If the compilation
+  database cannot be used for any reason, an error is reported.
 
   This option is ignored if ``--`` is present.
 

Modified: clang-tools-extra/trunk/docs/clang-modernize.rst
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/clang-modernize.rst?rev=237554&r1=237553&r2=237554&view=diff
==============================================================================
--- clang-tools-extra/trunk/docs/clang-modernize.rst (original)
+++ clang-tools-extra/trunk/docs/clang-modernize.rst Mon May 18 00:05:49 2015
@@ -51,7 +51,7 @@ args, it's probably best to use a *compi
 A `compilation database`_ contains the command-line arguments for multiple
 files. If the code you want to transform can be built with CMake, you can
 generate this database easily by running CMake with the
-``-DCMAKE_EXPORT_COMPILE_COMMANDS`` option. The Ninja_ build system, since
+``-DCMAKE_EXPORT_COMPILE_COMMANDS=ON`` option. The Ninja_ build system, since
 v1.2, can create this file too using the *compdb* tool: ``ninja -t compdb``. If
 you're not already using either of these tools or cannot easily make use of
 them you might consider looking into Bear_.





More information about the cfe-commits mailing list