diff options
| author | William Deegan <bill@baddogconsulting.com> | 2020-05-29 22:22:08 (GMT) |
|---|---|---|
| committer | William Deegan <bill@baddogconsulting.com> | 2020-05-29 22:22:08 (GMT) |
| commit | ef7265e6b2bc4f005a48fcc5c8f9e724f08d0ed6 (patch) | |
| tree | dd81d54b0ed5e64df74412d1f62fba796870bbfd | |
| parent | 897e738e626f528618ff3c2f97e67767d2644fdf (diff) | |
| download | SCons-ef7265e6b2bc4f005a48fcc5c8f9e724f08d0ed6.zip SCons-ef7265e6b2bc4f005a48fcc5c8f9e724f08d0ed6.tar.gz SCons-ef7265e6b2bc4f005a48fcc5c8f9e724f08d0ed6.tar.bz2 | |
[ci skip] a little formatting change
| -rw-r--r-- | doc/user/misc.xml | 57 |
1 files changed, 33 insertions, 24 deletions
diff --git a/doc/user/misc.xml b/doc/user/misc.xml index f2531b6..e9b078d 100644 --- a/doc/user/misc.xml +++ b/doc/user/misc.xml @@ -675,25 +675,34 @@ env.Command('directory_build_info', </section> - <section> - <title>Creating LLVM Compilation Database</title> - - <para> - - LLVM has defined a JSON Compilation Database Format. This file is in common use as input into LLVM tools and many IDE's and editors as well. - </para> - <para> - See <ulink url="https://clang.llvm.org/docs/JSONCompilationDatabase.html"><citetitle>JSON Compilation Database Format Specification¶</citetitle></ulink> for complete information - </para> - - <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. - </para> - <para>This is controlled by <envar>COMPILATIONDB_USE_ABSPATH=(True|False)</envar></para> - - <para>Example of absolute paths for target and source</para> - <programlisting language="json"> + <section> + <title>Creating LLVM Compilation Database</title> + + <para> + + LLVM has defined a JSON Compilation Database Format. This file is in common use as input into LLVM tools + and many IDE's and editors as well. + </para> + <para> + See + <ulink url="https://clang.llvm.org/docs/JSONCompilationDatabase.html"> + <citetitle>JSON Compilation Database Format Specification¶</citetitle> + </ulink> + for complete information + </para> + + <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. + </para> + <para>This is controlled by + <envar>COMPILATIONDB_USE_ABSPATH=(True|False)</envar> + </para> + + <para>Example of absolute paths for target and source</para> + <programlisting language="json"> [ { "command": "gcc -o test_main.o -c test_main.c", @@ -702,10 +711,10 @@ env.Command('directory_build_info', "target": "/home/user/sandbox/test_main.o" } ] - </programlisting> - <para>Example of relative paths for target and source</para> + </programlisting> + <para>Example of relative paths for target and source</para> - <programlisting language="json"> + <programlisting language="json"> [ { "command": "gcc -o test_main.o -c test_main.c", @@ -714,7 +723,7 @@ env.Command('directory_build_info', "target": "test_main.o" } ] - </programlisting> + </programlisting> - </section> + </section> </chapter> |