[Scons-dev] Problems in scons-time.1

esr at thyrsus.com esr at thyrsus.com
Tue Jun 18 01:14:02 EDT 2013


This is automatically generated email about markup problems in a man
page for which you appear to be responsible. If you are not the right
person or list, please tell me so I can correct my database.

See http://catb.org/~esr/doclifter/bugs.html for details on how and
why these patches were generated. Feel free to email me with any
questions. Note: These patches do not change the modification date of
any manual page. You may wish to do that by hand.

I apologize if this message seems spammy or impersonal. The volume of
markup bugs I am tracking is over five hundred - there is no real
alternative to generating bugmail from a database and template.

--
Eric S. Raymond
-------------- next part --------------
Problems with scons-time.1:

List syntax error. This means .IP, .TP or .RS/.RE markup is garbled.
Common causes include .TP just before a section header, .TP entries
with tags but no bodies, and mandoc lists with no trailing .El.
These confuse doclifter, and may also mess up stricter man-page
browsers like Xman and Rosetta.

Your Synopsis is exceptionally creative. Unfortunately, that means
it cannot be translated to structural markup even when things like
running-text inclusions have been moved elswhere.

--- scons-time.1-unpatched 2013-05-24 07:24:30.314478642 -0400
+++ scons-time.1 2013-05-24 07:23:50.438479387 -0400
@@ -111,23 +111,7 @@
[
.IR arguments ...
]
-'\"--------------------------------------------------------------------------
-.SS "Generating Timing Information"
-.SR
-'\"--------------------------------------------------------------------------
-.SS "Extracting Function Timings"
-.SF
-'\"--------------------------------------------------------------------------
-.SS "Extracting Memory Statistics"
-.SY
-'\"--------------------------------------------------------------------------
-.SS "Extracting Object Counts"
-.SO
-'\"--------------------------------------------------------------------------
-.SS "Extracting Execution Times"
-.ST
-'\"--------------------------------------------------------------------------
-.SS "Help Text"
+.br
.B scons-time help
.I SUBCOMMAND
[...]
@@ -912,10 +896,13 @@
.BR "--debug=count --debug=memory --debug=time --debug=memoizer" .
.TP
.B scons_lib_dir
+(This needs to be documented)
.TP
.B scons_wrapper
+(This needs to be documented)
.TP
.B startup_targets
+(This needs to be documented)
.TP
.B subdir
The subdirectory of the project into which the
@@ -935,6 +922,7 @@
.B svn_co_flag
.TP
.B tar
+(This needs to be documented)
.TP
.B targets
A string containing the targets that should be added to
@@ -945,18 +933,25 @@
subset of the full build for the configuration.
.TP
.B targets0
+(This needs to be documented)
.TP
.B targets1
+(This needs to be documented)
.TP
.B targets2
+(This needs to be documented)
.TP
.B title
+(This needs to be documented)
.TP
.B unzip
+(This needs to be documented)
.TP
.B verbose
+(This needs to be documented)
.TP
.B vertical_bars
+(This needs to be documented)
'\"--------------------------------------------------------------------------
.SS Example
Here is an example


More information about the Scons-dev mailing list