Package: fakeroot
Version: 1.36-1
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with a new version
test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -z < "man page"
[Use "groff -e ' $' <file>" to find trailing spaces.]
["test-groff" is a script in the repository for "groff"; is not shipped]
(local copy and "troff" slightly changed by me).
[The fate of "test-nroff" was decided in groff bug #55941.]
* What was the outcome of this action?
an.tmac:<stdin>:103: style: .BR expects at least 2 arguments, got 1
* 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.11.10-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 fakeroot depends on:
ii libc6 2.40-4
ii libfakeroot 1.36-1
fakeroot recommends no packages.
fakeroot suggests no packages.
-- no debconf information
Input file is faked-sysv.1
Any program (person), that produces man pages, should check the output
for defects by using (both groff and nroff)
[gn]roff -mandoc -t -ww -b -z -K utf8 <man page>
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 output of the original and patched file
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 faked-sysv.1": (shortened list)
4 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z faked-sysv.1": (shortened list)
2 trailing space in the line
-.-.
Remove space characters (whitespace) at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
Number of lines affected is
4
-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.
43:.BI \-\-foreground
74:.BR fakeroot
91:.RI <jdas...@debian.org>
97:.BR /usr/share/doc/fakeroot/DEBUG
-.-.
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.
-.-
Mark a abbreviation point as such by suffixing them with "\\&".
33:is the process that remembers that new owner. If later the same
51:by key. (If the specified channel doesn't exist, it's created).
67:None so far. Be warned, though: although I've written quite a few much
90:mostly by J.H.M. Dassen
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
Not considered in a patch, too many lines.
faked-sysv.1:51:by key. (If the specified channel doesn't exist, it's created).
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:43: style: .BI expects at least 2 arguments, got 1
troff:<stdin>:73: warning: trailing space in the line
an.tmac:<stdin>:74: style: .BR expects at least 2 arguments, got 1
troff:<stdin>:90: warning: trailing space in the line
an.tmac:<stdin>:91: style: .RI expects at least 2 arguments, got 1
an.tmac:<stdin>:97: style: .BR expects at least 2 arguments, got 1
-.-.
Additionally (general):
Abbreviations get a '\&' added after their final full stop (.) to mark them
as such and not as an end of a sentence.
--- faked-sysv.1 2024-12-19 04:08:10.350625177 +0000
+++ faked-sysv.1.new 2024-12-19 04:23:09.517387292 +0000
@@ -22,7 +22,7 @@ manipulated by fakeroot processes.
.SH SYNOPSIS
.B faked
.B [\-\-debug] [\-\-foreground] [\-\-cleanup] [\-\-key
-.IB msg-key ]
+.IB msg-key ]
.B [\-\-load] [\-\-save-file
.IB save-file ]
.B [\-\-port
@@ -30,25 +30,27 @@ manipulated by fakeroot processes.
.SH DESCRIPTION
If a fakeroot process wants to change the ownership of a file, then
.B faked
-is the process that remembers that new owner. If later the same
-fakeroot process does a stat() for that filename, then the libfakeroot
-wrapped stat() call will first ask faked for the fake ownership etc
-of that file, and then report it.
+is the process that remembers that new owner.
+If later
+the same fakeroot process does a stat() for that filename,
+then the libfakeroot wrapped stat() call will first ask faked for the fake
+ownership etc.\& of that file, and then report it.
.SH OPTIONS
.TP
.B \-\-debug
Print debugging information on stderr.
.TP
-.BI \-\-foreground
+.B \-\-foreground
Don't fork into the background.
.TP
.B \-\-cleanup \ number
Cleanup the semaphores.
.TP
.B \-\-key \ key-number
-Don't allocate a new communication channel, but use channel specified
-by key. (If the specified channel doesn't exist, it's created).
+Don't allocate a new communication channel,
+but use channel specified by key.
+(If the specified channel doesn't exist, it's created).
.TP
.B \-\-save\-file \ save-file
Save the environment to save-file on exit.
@@ -64,15 +66,19 @@ root:root.
Use TCP port tcp-port.
.SH BUGS
-None so far. Be warned, though: although I've written quite a few much
-larger (and smaller) programs, I've never written anything that was
-as tiny as
+None so far.
+Be warned, though:
+although I've written quite a few much larger
+(and smaller)
+programs,
+I've never written anything that was as tiny as
.BR fakeroot ,
had as many bugs as
.BR fakeroot ,
-and still was as usable as, say,
-.BR fakeroot
-version 0.0_3, the first version that could be used to build itself.
+and still was as usable as, say,
+.B fakeroot
+version 0.0_3,
+the first version that could be used to build itself.
.SH COPYING
.B fakeroot
is distributed under the GNU General Public License.
@@ -87,11 +93,11 @@ Clint Adams
.TP
Timo Savola
.SH MANUAL PAGE
-mostly by J.H.M. Dassen
-.RI <jdas...@debian.org>
+mostly by J.H.M.\& Dassen
+.RI < jdas...@debian.org >
mods/additions by joost and Clint.
.SH "SEE ALSO"
.BR fakeroot (1),
.BR dpkg-buildpackage (1),
-.BR debuild (1)
-.BR /usr/share/doc/fakeroot/DEBUG
+.BR debuild (1),
+.B /usr/share/doc/fakeroot/DEBUG
