diff options
| author | Sebastian Schuberth <sschuberth@gmail.com> | 2016-01-15 14:08:45 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2016-01-15 20:04:33 (GMT) |
| commit | 6e92f7b2de3d6a25e4e77e274de110a2974c74ca (patch) | |
| tree | bd800efbcaa6643c6c040cbc9d5e810307ab48a7 | |
| parent | b8d002af1aeefb435a9560b056f081e5d8dff734 (diff) | |
| download | CMake-6e92f7b2de3d6a25e4e77e274de110a2974c74ca.zip CMake-6e92f7b2de3d6a25e4e77e274de110a2974c74ca.tar.gz CMake-6e92f7b2de3d6a25e4e77e274de110a2974c74ca.tar.bz2 | |
Help: Document the CMAKE_EXPORT_COMPILE_COMMANDS variable
| -rw-r--r-- | Help/manual/cmake-variables.7.rst | 1 | ||||
| -rw-r--r-- | Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst | 30 |
2 files changed, 31 insertions, 0 deletions
diff --git a/Help/manual/cmake-variables.7.rst b/Help/manual/cmake-variables.7.rst index 3f49572..15eaece 100644 --- a/Help/manual/cmake-variables.7.rst +++ b/Help/manual/cmake-variables.7.rst @@ -118,6 +118,7 @@ Variables that Change Behavior /variable/CMAKE_DISABLE_FIND_PACKAGE_PackageName /variable/CMAKE_ERROR_DEPRECATED /variable/CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION + /variable/CMAKE_EXPORT_COMPILE_COMMANDS /variable/CMAKE_EXPORT_NO_PACKAGE_REGISTRY /variable/CMAKE_SYSROOT /variable/CMAKE_FIND_APPBUNDLE diff --git a/Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst b/Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst new file mode 100644 index 0000000..8776279 --- /dev/null +++ b/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. |