Package: bcc
Version: 0.16.17-3.6
Severity: minor
* What led up to the situation?
Checking for defects with
[test-]groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z < "man page"
[test-groff is a script in the repository for "groff"] (local copy and
"troff" slightly changed by me).
* What was the outcome of this action?
troff: backtrace: file '<stdin>':2
troff:<stdin>:2: warning: macro 'BY' not defined
troff: backtrace: file '<stdin>':132
troff:<stdin>:132: warning: trailing space in the line
troff: backtrace: file '<stdin>':339
troff:<stdin>:339: warning: trailing space in the line
* What outcome did you expect instead?
No output (no warnings).
-.-
General remarks and further material, if a diff-file exist, are in the
attachments.
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.10.6-amd64 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1),
LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages bcc depends on:
ii bin86 0.16.17-3.6
ii libc6 2.40-2
Versions of packages bcc recommends:
pn elks-libc <none>
bcc suggests no packages.
-- no debconf information
Any program (person), that produces man pages, should check its content for
defects by using
groff -mandoc -t -ww -b -z [ -K utf8 | k ]
The same goes for man pages that are used as an input.
For a style guide use
mandoc -T lint
-.-
So any 'generator' should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
This is just a simple quality control measure.
The 'generator' may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
Input text line longer than 80 bytes.
Not removing trailing spaces (in in- and output).
The reason for these trailing spaces should be found and eliminated.
Not beginning each input sentence on a new line.
Lines should thus be shorter.
See man-pages(7), item 'semantic newline'.
-.-
The difference between the formatted outputs can be seen with:
nroff -mandoc <file1> > <out1>
nroff -mandoc <file2> > <out2>
diff -u <out1> <out2>
and for groff, using
"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -mandoc -Z - "
instead of \'nroff -mandoc\'
Add the option \'-t\', if the file contains a table.
Read the output of \'diff -u\' with \'less -R\' or similar.
-.-.
If \'man\' (man-db) is used to check the manual for warnings,
the following must be set:
The option "-warnings=w"
The environmental variable:
export MAN_KEEP_STDERR=yes (or any non-empty value)
or
(produce only warnings):
export MANROFFOPT="-ww -b -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-.
Output from "mandoc -T lint bcc.1": (possibly shortened list)
mandoc: bcc.1:2:2: ERROR: skipping unknown macro: .BY Bruce Evans
mandoc: bcc.1:132:56: STYLE: whitespace at end of input line
mandoc: bcc.1:209:4: STYLE: whitespace at end of input line
mandoc: bcc.1:212:4: STYLE: whitespace at end of input line
mandoc: bcc.1:215:4: STYLE: whitespace at end of input line
mandoc: bcc.1:218:4: STYLE: whitespace at end of input line
mandoc: bcc.1:221:4: STYLE: whitespace at end of input line
mandoc: bcc.1:224:4: STYLE: whitespace at end of input line
mandoc: bcc.1:227:4: STYLE: whitespace at end of input line
mandoc: bcc.1:230:4: STYLE: whitespace at end of input line
mandoc: bcc.1:233:4: STYLE: whitespace at end of input line
mandoc: bcc.1:236:4: STYLE: whitespace at end of input line
mandoc: bcc.1:240:4: STYLE: whitespace at end of input line
mandoc: bcc.1:243:4: STYLE: whitespace at end of input line
mandoc: bcc.1:246:4: STYLE: whitespace at end of input line
mandoc: bcc.1:249:4: STYLE: whitespace at end of input line
mandoc: bcc.1:268:4: STYLE: whitespace at end of input line
mandoc: bcc.1:271:4: STYLE: whitespace at end of input line
mandoc: bcc.1:274:4: STYLE: whitespace at end of input line
mandoc: bcc.1:279:4: STYLE: whitespace at end of input line
mandoc: bcc.1:284:4: STYLE: whitespace at end of input line
mandoc: bcc.1:291:4: STYLE: whitespace at end of input line
mandoc: bcc.1:300:4: STYLE: whitespace at end of input line
mandoc: bcc.1:305:4: STYLE: whitespace at end of input line
mandoc: bcc.1:308:4: STYLE: whitespace at end of input line
mandoc: bcc.1:313:4: STYLE: whitespace at end of input line
mandoc: bcc.1:316:2: WARNING: skipping paragraph macro: PP empty
mandoc: bcc.1:324:2: WARNING: skipping paragraph macro: PP empty
mandoc: bcc.1:339:4: STYLE: whitespace at end of input line
-.-.
Remove space characters at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
132:to optimize 8086 code. Specifiers to choose which rules
209:.TP
212:.TP
215:.TP
218:.TP
221:.TP
224:.TP
227:.TP
230:.TP
233:.TP
236:.TP
240:.TP
243:.TP
246:.TP
249:.TP
268:.TP
271:.TP
274:.TP
279:.TP
284:.TP
291:.TP
300:.TP
305:.TP
308:.TP
313:.TP
339:The
-.-.
Change - to \- if it shall be printed as a minus sign.
bcc.1:8:.RB [ -03EGNOPSVcegvwxW ]
bcc.1:47:.B -0
bcc.1:50:.B -3
bcc.1:112:to produce standalone Linux-86 executables
bcc.1:115:switches to i386-Linux code generator and library.
bcc.1:121:switches to i386-Linux code generator and generates OMAGIC object
files
bcc.1:127:with -3 the executable will run under Linux-i386.
bcc.1:210:.B -0
bcc.1:213:.B -3
bcc.1:238:produce code for 2 3 1 0 long byte order (only works in 16-bit code),
-.-.
Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.
8:.RB [ -03EGNOPSVcegvwxW ]
9:.RB [ -Aas_option ]
10:.RB [ -Bexecutable_prefix ]
11:.RB [ -Ddefine ]
12:.RB [ -Uundef ]
13:.RB [ -Mc_mode ]
14:.RB [ -o\ outfile ]
15:.RB [ -ansi ]
16:.RB [ -Ccc1_option ]
17:.RB [ -Pcpp_option ]
18:.RB [ -Iinclude_dir ]
19:.RB [ -Lld_option ]
20:.RB [ -Ttmpdir ]
21:.RB [ -Qc386_option ]
22:.RB [ -ttext_segno ]
38:.B -ansi
47:.B -0
50:.B -3
53:.B -A
54:pass remainder of option to assembler (e.g. -A-l -Alistfile for a listing)
56:.B -B
59:.BR -B ,
65:.B -C
68:.B -D
71:.B -E
74:.B -G
75:produce GCC objects (Same as -Mg)
77:.B -Ixyz
80:.B -I
83:.B -Lxyz
86:.B -L
89:.B -Md
92:.B -i
95:.B -Mf
97:.B -c
99:.B -f
104:.B -Mc
106:.B -c
110:.B -Ms
114:.B -Ml
117:.B -z
120:.B -Mg
125:.B -N
127:with -3 the executable will run under Linux-i386.
129:.B -O
135:.B -O
138:.B -P
141:.B -Q
144:.B -S
147:.B -T
151:.B -U
154:.B -V
157:.B -X
158:pass remainder of option to linker (e.g. -X-Ofile is passed to the linker
159:as -Ofile)
161:.B -c
164:.B -f
168:.B -g
171:.B -o
174:.B -p
177:.B -t1
180:.B -v
181:print names and args of subprocesses being run. Two or more -v's print
182:names of files being unlinked. Three or more -v's print names of paths
185:.B -w
188:.B -W
193:.B -x
196:.B -i
198:.B -i
201:Other options are passed to the linker, in particular -lx, -M, -m, -s, -H.
207:.B -C
210:.B -0
213:.B -3
216:.B -D
219:.B -E
222:.B -I
225:.B -P
228:.B -c
231:.B -d
234:.B -f
237:.B -l
241:.B -o
244:.B -p
247:.B -t
250:.B -w
253:All the options except -D, -I and -o may be turned off by following the
254:option letter by a '-'. Options are processed left to right so the last
354:.B -r
-.-.
Add a comma (or \&) after "e.g." and "i.e.", or use English words
(man-pages(7)).
Abbreviation points should be protected against being interpreted as
an end of sentence, if they are not, and that independent of the
current place on the line.
54:pass remainder of option to assembler (e.g. -A-l -Alistfile for a listing)
158:pass remainder of option to linker (e.g. -X-Ofile is passed to the linker
-.-.
Wrong distance between sentences in the input file.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
28:compile time options allow 80386 or 6809 versions. The compiler understands
41:after preprocessing and before code generation. This will allow
54:pass remainder of option to assembler (e.g. -A-l -Alistfile for a listing)
100:arguments to the code generator for smaller faster code. Note this code is
107:argument to the code generator for smaller faster code. Note the standard
132:to optimize 8086 code. Specifiers to choose which rules
158:pass remainder of option to linker (e.g. -X-Ofile is passed to the linker
331:be moved there. The configuration for this is in the
-.-.
Name of a manual is set in bold, the section in roman.
See man-pages(7).
348:as86(1), ld86(1), elksemu(1)
-.-.
Change a HYPHEN-MINUS (code 0x55, 2D) to a dash
(\-, minus) if it matches "[[:alph:]]-[[:alpha:]]" in the name of an
option).
Facilitates the copy and paste of an option in UTF-8 text.
Is not needed in ordinary words like "mother-in-law", that are not
copied and pasted to a command line (which needs ASCII code)
54:pass remainder of option to assembler (e.g. -A-l -Alistfile for a listing)
158:pass remainder of option to linker (e.g. -X-Ofile is passed to the linker
-.-.
Output from "test-groff -b -mandoc -rF0 -rHY=0 -K utf8 -t -ww -z ":
troff: backtrace: file '<stdin>':2
troff:<stdin>:2: warning: macro 'BY' not defined
troff: backtrace: file '<stdin>':132
troff:<stdin>:132: warning: trailing space in the line
troff: backtrace: file '<stdin>':339
troff:<stdin>:339: warning: trailing space in the line
