diff options
author | Justin Bogner <mail@justinbogner.com> | 2015-05-18 05:05:49 +0000 |
---|---|---|
committer | Justin Bogner <mail@justinbogner.com> | 2015-05-18 05:05:49 +0000 |
commit | e3acc8bc56dce55a79f5c7fa5d3c02c97c11a6fc (patch) | |
tree | 25a87beaa920b10413bca64e56ab984ab583ec43 | |
parent | 8db9176d688fd89a7578d120542fbfa7f87eb515 (diff) | |
download | bcm5719-llvm-e3acc8bc56dce55a79f5c7fa5d3c02c97c11a6fc.tar.gz bcm5719-llvm-e3acc8bc56dce55a79f5c7fa5d3c02c97c11a6fc.zip |
docs: Spell a couple of cmake options with =ON in the docs
Patch by Albert Astals Cid. Thanks!
llvm-svn: 237554
-rw-r--r-- | clang-tools-extra/docs/ModernizerUsage.rst | 6 | ||||
-rw-r--r-- | clang-tools-extra/docs/clang-modernize.rst | 2 |
2 files changed, 4 insertions, 4 deletions
diff --git a/clang-tools-extra/docs/ModernizerUsage.rst b/clang-tools-extra/docs/ModernizerUsage.rst index d5ef9ae9ef6..9f88f288c87 100644 --- a/clang-tools-extra/docs/ModernizerUsage.rst +++ b/clang-tools-extra/docs/ModernizerUsage.rst @@ -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. diff --git a/clang-tools-extra/docs/clang-modernize.rst b/clang-tools-extra/docs/clang-modernize.rst index cec6a8baa54..c1adcab1f1d 100644 --- a/clang-tools-extra/docs/clang-modernize.rst +++ b/clang-tools-extra/docs/clang-modernize.rst @@ -51,7 +51,7 @@ args, it's probably best to use a *compilation database*. 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_. |