summaryrefslogtreecommitdiff
path: root/share/cmake-3.10/Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst
diff options
context:
space:
mode:
Diffstat (limited to 'share/cmake-3.10/Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst')
-rw-r--r--share/cmake-3.10/Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/share/cmake-3.10/Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst b/share/cmake-3.10/Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst
new file mode 100644
index 0000000..8776279
--- /dev/null
+++ b/share/cmake-3.10/Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst
@@ -0,0 +1,30 @@
+CMAKE_EXPORT_COMPILE_COMMANDS
+-----------------------------
+
+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"
+ }
+ ]
+
+.. note::
+ This option is implemented only by :ref:`Makefile Generators`
+ and the :generator:`Ninja`. It is ignored on other generators.