Skip to content

Commit c282967

Browse files
committed
[ci skip] updates based on mwichmann's review of the PR
1 parent 12739bb commit c282967

File tree

2 files changed

+9
-10
lines changed

2 files changed

+9
-10
lines changed

SCons/Tool/compilation_db.xml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ See its __doc__ string for a discussion of the format.
2626
<tool name="compilation_db">
2727
<summary>
2828
<para>
29-
Sets up &b-CompilationDatabase; builder which generates a clang tooling compatible compilation database.
29+
Sets up &b-link-CompilationDatabase; builder which generates a clang tooling compatible compilation database.
3030
</para>
3131
</summary>
3232
<sets>
@@ -42,9 +42,9 @@ See its __doc__ string for a discussion of the format.
4242
<builder name="CompilationDatabase">
4343
<summary>
4444
<para>
45-
The &b-CompilationDatabase; builder writes a
46-
<ulink url="https://clang.llvm.org/docs/JSONCompilationDatabase.html">clang formatted compilation
47-
database
45+
The &b-CompilationDatabase; builder writes a JSON formatted compilation
46+
database according to the
47+
<ulink url="https://clang.llvm.org/docs/JSONCompilationDatabase.html">LLVM specification
4848
</ulink> which is consumed by a number of clang tools, editors, and other tools.
4949
</para>
5050
<para>
@@ -63,7 +63,7 @@ env.CompilationDatabase('my_output.json')
6363
the C, C++, assembly source/target pairs.
6464
</para>
6565
<para>
66-
NOTE: You must load the compilation_db tool prior to specifying any part of your build or some source/target
66+
NOTE: You must load the &t-compilation_db; tool prior to specifying any part of your build or some source/target
6767
files will not show up in your output file.
6868
</para>
6969
<para>
@@ -85,10 +85,10 @@ env.CompilationDatabase('my_output.json')
8585
<para>
8686
This is a boolean flag to instruct &b-link-CompilationDatabase; to
8787
write the <literal>file</literal> and <literal>target</literal> members
88-
in the target file with absolute or relative path.
88+
in the compilation database with absolute or relative paths.
8989
</para>
9090
<para>
91-
The default value is False.
91+
The default value is False (use relative paths)
9292
</para>
9393
</summary>
9494
</cvar>

doc/user/misc.xml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -693,9 +693,8 @@ env.Command('directory_build_info',
693693

694694
<para>
695695

696-
Currently SCons supports two variations. One is to output source and target files with paths relative to the
697-
top
698-
of the SCons build, or to output those files with their absolute path.
696+
The compilation database can be populated with source and target files either with paths relative to the
697+
top of the build, or using absolute paths.
699698
</para>
700699
<para>This is controlled by
701700
<envar>COMPILATIONDB_USE_ABSPATH=(True|False)</envar>

0 commit comments

Comments
 (0)