diff options
| author | Mats Wichmann <mats@linux.com> | 2020-06-10 11:09:09 -0600 |
|---|---|---|
| committer | Mats Wichmann <mats@linux.com> | 2020-06-10 11:12:42 -0600 |
| commit | 2f5841806011b1ca123e58ddaa55e4319b5468da (patch) | |
| tree | 44c9910e3aa95d45766d6b67a7a3ca5987c3036e /doc/generated/builders.gen | |
| parent | 07ba4716ef08158da819ec98b4533d06c84c12dc (diff) | |
| download | scons-git-2f5841806011b1ca123e58ddaa55e4319b5468da.tar.gz | |
Documentation updates in perparation for 4.0 [ci skip]
* Switch API docs to readthedocs theme
* Add links in manpage SEE ALSO to external websites. These are not just
live, but also listed out (Linux manpages won't have the hyperlinks)
* Links use docbook5 xlink:href instead of deprecated (claimed to be
removed, but apparently not) ulink syntax
* Comment out manpage Examples section, and leave a pointer to
scons-cookbook.readthedocs.io instead
* Regenerate everything, mainly to pick up compilation_db stuff.
Signed-off-by: Mats Wichmann <mats@linux.com>
Diffstat (limited to 'doc/generated/builders.gen')
| -rw-r--r-- | doc/generated/builders.gen | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/generated/builders.gen b/doc/generated/builders.gen index 0e85eebf9..7a66bd48c 100644 --- a/doc/generated/builders.gen +++ b/doc/generated/builders.gen @@ -50,6 +50,39 @@ for the calling syntax and details. </para> </listitem> </varlistentry> + <varlistentry id="b-CompilationDatabase"> + <term><function>CompilationDatabase</function>()</term> + <term><replaceable>env</replaceable>.<methodname>CompilationDatabase</methodname>()</term> + <listitem><para> + The <function>CompilationDatabase</function> builder writes a JSON formatted compilation + database according to the + <ulink url="https://clang.llvm.org/docs/JSONCompilationDatabase.html">LLVM specification + </ulink> which is consumed by a number of clang tools, editors, and other tools. + </para> + <para> + If you don't specify any files, the builder will default to <filename>compile_commands.json</filename>. + </para> + <para> + If you specify a single file as below + <programlisting language="python"> +env.CompilationDatabase('my_output.json') + </programlisting> + SCons will automatically use that as the target file. + If you specify more than one source, the source list will be ignored. + </para> + <para> + You should not specify source files. The <function>CompilationDatabase</function> builder instruments SCons to collect them from all + the C, C++, assembly source/target pairs. + </para> + <para> + NOTE: You must load the <literal>compilation_db</literal> tool prior to specifying any part of your build or some source/target + files will not show up in your output file. + </para> + <para> + <emphasis>Available since <command>scons</command> 4.0.</emphasis> + </para> + </listitem> + </varlistentry> <varlistentry id="b-CXXFile"> <term><function>CXXFile</function>()</term> <term><replaceable>env</replaceable>.<methodname>CXXFile</methodname>()</term> |