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

Christoph Cullmann <[email protected]>
Newsgroups gmane.comp.kde.doc,gmane.comp.kde.cvs
Message-ID <[email protected]>
Git commit e3257591ece9840ac9d27bbf864499c78d595576 by Christoph Cullmann.
Committed on 06/02/2021 at 15:27.
Pushed by ashark into branch 'docbook_historied_per_file'.

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

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

M  +2    -2    doc/getting-started/kde-modules-and-selection.docbook
M  +23   -0    doc/kdesrc-buildrc/conf-options-table.docbook

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

diff --git a/doc/getting-started/kde-modules-and-selection.docbook b/doc/getting-started/kde-modules-and-selection.docbook
index b064ad16..83697b3e 100644
--- a/doc/getting-started/kde-modules-and-selection.docbook
+++ b/doc/getting-started/kde-modules-and-selection.docbook
@@ -316,8 +316,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>
 
diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook
index 499ac3e7..27e88e33 100644
--- a/doc/kdesrc-buildrc/conf-options-table.docbook
+++ b/doc/kdesrc-buildrc/conf-options-table.docbook
@@ -306,6 +306,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
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.