[sdk/kdesrc-build] doc: add some docs for compile-commands-export & compile-commands-linking

[Christoph Cullmann]

Git commit b3d7215225235cebfa30987adb6d4e9a69c28660 by Christoph Cullmann.
Committed on 06/02/2021 at 15:27.
Pushed by mpyne into branch 'master'.

add some docs for compile-commands-export & compile-commands-linking

M  +25   -2    doc/index.docbook

https://invent.kde.org/sdk/kdesrc-build/commit/b3d7215225235cebfa30987adb6d4e9a69c28660

diff --git a/doc/index.docbook b/doc/index.docbook
index 1fc27c7..bdbf92f 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -1193,8 +1193,8 @@ decide that you'd rather not download, build, and install
 
 <para>You can achieve this by using the <link
 linkend="conf-ignore-modules">ignore-modules</link> configuration option.
-On the command line the 
-<link linkend="ignoring-modules">&cmd-ignore-modules; option</link> 
+On the command line the
+<link linkend="ignoring-modules">&cmd-ignore-modules; option</link>
 does the same thing, but is more convenient for filtering out a module just once.
 </para>
 
@@ -2058,6 +2058,29 @@ color codes to anything but a terminal (such as xterm, &konsole;, or the normal
 </entry>
 </row>
 
+<row id="conf-compile-commands-export">
+<entry>compile-commands-export</entry>
+<entry>Module setting overrides global</entry>
+<entry>
+<para>Enables the generation of a <literal>compile_commands.json</literal> via CMake inside the build directory.
+This option defaults to <replaceable>true</replaceable>, set it to <userinput>false</userinput> to disable
+this behavior.
+</para>
+</entry>
+</row>
+
+<row id="conf-compile-commands-linking">
+<entry>compile-commands-linking</entry>
+<entry>Module setting overrides global</entry>
+<entry>
+<para>Enables the creation of symbolic links from <literal>compile_commands.json</literal> generated via CMake
+inside the build directory to the matching source directory.
+This option defaults to <replaceable>false</replaceable>, set it to <userinput>true</userinput> to enable
+the automatic symbolic link creation.
+</para>
+</entry>
+</row>
+
 <row id="conf-configure-flags">
 <entry>configure-flags</entry>
 <entry>Appends to global options for the default buildsystem, overrides global