summaryrefslogtreecommitdiff
path: root/share/cmake-3.22/Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst
diff options
context:
space:
mode:
authorRyan Prichard <rprichard@google.com>2022-01-13 17:30:17 -0800
committerRyan Prichard <rprichard@google.com>2022-01-13 17:30:31 -0800
commit7aea7e9880110799088cd1de509886871078306f (patch)
tree5cf68b7dabd868f99ec4160cf1f7237ff63e4c37 /share/cmake-3.22/Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst
parentd09ee7574f3e46668b23b3b6efebd0ea75de85b2 (diff)
downloaddarwin-x86-7aea7e9880110799088cd1de509886871078306f.tar.gz
Fusion2: http://fusion2/610fb8e3-5633-41a6-b50b-ed5819f55cd6 GCS path: gs://ndk-kokoro-release-artifacts/prod/ndk/cmake/darwin_release/3/20211215-131219 Prebuilt updated using: ndk/scripts/update_kokoro_prebuilts.py Test: Treehugger, Kokoro presubmit Bug: http://b/213946898 Change-Id: Icbb6d90cad49dbe67f168075508872b1704d9f61
Diffstat (limited to 'share/cmake-3.22/Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst')
-rw-r--r--share/cmake-3.22/Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst40
1 files changed, 40 insertions, 0 deletions
diff --git a/share/cmake-3.22/Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst b/share/cmake-3.22/Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst
new file mode 100644
index 0000000..53a19dc
--- /dev/null
+++ b/share/cmake-3.22/Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst
@@ -0,0 +1,40 @@
+CMAKE_EXPORT_COMPILE_COMMANDS
+-----------------------------
+
+.. versionadded:: 3.5
+
+Enable/Disable output of compile commands during generation.
+
+If enabled, generates a ``compile_commands.json`` file containing the exact
+compiler calls for all translation units of the project in machine-readable
+form. The format of the JSON file looks like:
+
+.. code-block:: javascript
+
+ [
+ {
+ "directory": "/home/user/development/project",
+ "command": "/usr/bin/c++ ... -c ../foo/foo.cc",
+ "file": "../foo/foo.cc"
+ },
+
+ ...
+
+ {
+ "directory": "/home/user/development/project",
+ "command": "/usr/bin/c++ ... -c ../foo/bar.cc",
+ "file": "../foo/bar.cc"
+ }
+ ]
+
+This is initialized by the :envvar:`CMAKE_EXPORT_COMPILE_COMMANDS` environment
+variable, and initializes the :prop_tgt:`EXPORT_COMPILE_COMMANDS` target
+property for all targets.
+
+.. note::
+ This option is implemented only by :ref:`Makefile Generators`
+ and the :generator:`Ninja`. It is ignored on other generators.
+
+ This option currently does not work well in combination with
+ the :prop_tgt:`UNITY_BUILD` target property or the
+ :variable:`CMAKE_UNITY_BUILD` variable.