From c2829674b04927e17784dd9653298ee25c440376 Mon Sep 17 00:00:00 2001
From: William Deegan <bill@baddogconsulting.com>
Date: Sun, 7 Jun 2020 11:41:40 -0700
Subject: [ci skip] updates based on mwichmann's review of the PR

---
 SCons/Tool/compilation_db.xml | 14 +++++++-------
 doc/user/misc.xml             |  5 ++---
 2 files changed, 9 insertions(+), 10 deletions(-)

diff --git a/SCons/Tool/compilation_db.xml b/SCons/Tool/compilation_db.xml
index 47126a7..038e9cb 100644
--- a/SCons/Tool/compilation_db.xml
+++ b/SCons/Tool/compilation_db.xml
@@ -26,7 +26,7 @@ See its __doc__ string for a discussion of the format.
     <tool name="compilation_db">
         <summary>
             <para>
-                Sets up &b-CompilationDatabase; builder which generates a clang tooling compatible compilation database.
+                Sets up &b-link-CompilationDatabase; builder which generates a clang tooling compatible compilation database.
             </para>
         </summary>
         <sets>
@@ -42,9 +42,9 @@ See its __doc__ string for a discussion of the format.
     <builder name="CompilationDatabase">
         <summary>
             <para>
-                The &b-CompilationDatabase; builder writes a
-                <ulink url="https://clang.llvm.org/docs/JSONCompilationDatabase.html">clang formatted compilation
-                    database
+                The &b-CompilationDatabase; 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>
@@ -63,7 +63,7 @@ env.CompilationDatabase('my_output.json')
                 the C, C++, assembly source/target pairs.
             </para>
             <para>
-                NOTE: You must load the compilation_db tool prior to specifying any part of your build or some source/target
+                NOTE: You must load the &t-compilation_db; tool prior to specifying any part of your build or some source/target
                 files will not show up in your output file.
             </para>
             <para>
@@ -85,10 +85,10 @@ env.CompilationDatabase('my_output.json')
             <para>
                 This is a boolean flag to instruct &b-link-CompilationDatabase; to
                 write the <literal>file</literal> and <literal>target</literal> members
-                in the target file with absolute or relative path.
+                in the compilation database with absolute or relative paths.
             </para>
             <para>
-                The default value is False.
+                The default value is False (use relative paths)
             </para>
         </summary>
     </cvar>
diff --git a/doc/user/misc.xml b/doc/user/misc.xml
index 8aa7d62..e430897 100644
--- a/doc/user/misc.xml
+++ b/doc/user/misc.xml
@@ -693,9 +693,8 @@ env.Command('directory_build_info',
 
         <para>
 
-            Currently SCons supports two variations. One is to output source and target files with paths relative to the
-            top
-            of the SCons build, or to output those files with their absolute path.
+            The compilation database can be populated with source and target files either with paths relative to the
+            top of the build, or using absolute paths.
         </para>
         <para>This is controlled by
             <envar>COMPILATIONDB_USE_ABSPATH=(True|False)</envar>
-- 
cgit v0.12