summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorWilliam Deegan <bill@baddogconsulting.com>2020-08-09 18:18:17 (GMT)
committerGitHub <noreply@github.com>2020-08-09 18:18:17 (GMT)
commita299e6e30b8766cf4c3163648ee951949a790068 (patch)
tree70fbd3f1456e641fba4f96c653ce92149a5cc187 /doc
parent0b01a5f0c74993f7e4d77109acce40fc845e6f83 (diff)
parent44e55878823357414dee54bdbf714713ff22aab8 (diff)
downloadSCons-a299e6e30b8766cf4c3163648ee951949a790068.zip
SCons-a299e6e30b8766cf4c3163648ee951949a790068.tar.gz
SCons-a299e6e30b8766cf4c3163648ee951949a790068.tar.bz2
Merge pull request #3762 from mwichmann/man-note
Trivial: add a comment about options to manpage source
Diffstat (limited to 'doc')
-rw-r--r--doc/man/scons.xml6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/man/scons.xml b/doc/man/scons.xml
index 20d2d06..5cad5c7 100644
--- a/doc/man/scons.xml
+++ b/doc/man/scons.xml
@@ -487,6 +487,12 @@ supports the same command-line options as GNU &Make;
and many of those supported by <application>cons</application>.
</para>
+<!-- The recommended approach of multiple <term> entries per <varlistentry> -->
+<!-- (if needed) is not used for Options, because the default docbook -->
+<!-- presentation format for a varlist has been changed in SCons from -->
+<!-- csv to one-per-line to improve the display of Builders and -->
+<!-- Functions/Methods in those sections. Do the csv manually. -->
+
<!-- Note: commented-out options are retained as they may be a model -->
<!-- for future development directions. Do not remove. -->