Package: fakeroot
Version: 1.36.2-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 -rCHECKSTYLE=10 -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>:25: misuse, warning: .IB is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument."
an.tmac:<stdin>:36: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument."
an.tmac:<stdin>:37: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument."
an.tmac:<stdin>:105: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument."
an.tmac:<stdin>:118: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument."
an.tmac:<stdin>:121: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument."
troff:<stdin>:129: warning: font name 'CW' is deprecated
an.tmac:<stdin>:160: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument."
an.tmac:<stdin>:243: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument."
an.tmac:<stdin>:245: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument."
an.tmac:<stdin>:247: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument."
an.tmac:<stdin>:251: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument."
an.tmac:<stdin>:297: misuse, warning: .RI is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument."
an.tmac:<stdin>:303: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument."
* 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.12.5-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.2-1
fakeroot recommends no packages.
fakeroot suggests no packages.
-- no debconf information
Input file is fakeroot-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 fakeroot-sysv.1": (shortened list)
6 line scope broken
-.-.
Output from "test-groff -mandoc -t -ww -z fakeroot-sysv.1": (shortened list)
4 .BI is for at least 2 arguments, got 1
7 .BR is for at least 2 arguments, got 1
1 .IB is for at least 2 arguments, got 1
1 .RI is for at least 2 arguments, got 1
11 Use macro '.B' for one argument or split argument."
2 Use macro '.I' for one argument or split argument."
1 font name 'CW' is deprecated
-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.
105:.BR fakeroot
118:.BI \-h
121:.BI \-v
303:.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 "\&".
N.B.
The number of lines affected can be too large to be in a patch.
52:stat(2) etc.) by ones that simulate the effect the real library
53:functions would have had, had the user really been root. These wrapper
59:mechanism of the dynamic loader. (See
67:versions). If those tests fail (for example because you have
73:themselves under fakeroot. Especially configure and friends don't like
87:Any command you want to be run as fakeroot. Use \(oq\-\-\(cq if in the
command
91:Save the fakeroot environment to save-file on exit. This file can be
92:used to restore the environment later using \-i. However, this file will
94:touched inside the fakeroot alone when outside the environment. Still,
95:this can be useful. For example, it can be used with rsync(1) to back up
97:information without needing to be root. See
104:that behaviour. Using the same file for both \-i and \-s in a single
113:Specify fd base (TCP mode only). fd is the minimum file descriptor
170:is a regular, non-setuid program. It does not enhance a user's
178:The key used to communicate with the fakeroot daemon. Any program
214:fakeroot doesn't wrap open(), create(), etc. So, if user
234:uid=gid=0, is always OK. The real way around this is to wrap
239:package. This package wrapped many more functions, and tried to do a
260:operating system. Thus I decided to keep the number of functions
266:behaves. Programs that probe the system like GNU configure may get
268:that fakeroot itself becomes confused). So, it's advisable not to run
269:"configure" from within fakeroot. As configure should be called in the
273:It doesn't wrap open(). This isn't bad by itself, but if a program
276:the mode of the file will be 000. The bug is that if root does the
278:all for root. I choose not to wrap open(), as open() is used by many
-.-.
Split a punctuation mark from a single argument for a two-font macro
297:.RI <[email protected]>,
-.-.
Name of a manual is set in bold, the section in roman.
See man-pages(7).
160:.BR deb(5)
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
fakeroot-sysv.1:113:Specify fd base (TCP mode only). fd is the minimum file
descriptor
fakeroot-sysv.1:248:function that did (in some cases) use
fakeroot-sysv.1:264:.IP "GNU configure (and other such programs)"
fakeroot-sysv.1:274:does open("file", O_WRONLY, 000), writes to file "file",
closes it,
fakeroot-sysv.1:279:other functions in libc (also those that are already
wrapped), thus
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:25: misuse, warning: .IB is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument."
an.tmac:<stdin>:36: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument."
an.tmac:<stdin>:37: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument."
an.tmac:<stdin>:105: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument."
an.tmac:<stdin>:118: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument."
an.tmac:<stdin>:121: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument."
troff:<stdin>:129: warning: font name 'CW' is deprecated
an.tmac:<stdin>:160: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument."
an.tmac:<stdin>:243: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument."
an.tmac:<stdin>:245: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument."
an.tmac:<stdin>:247: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument."
an.tmac:<stdin>:251: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument."
an.tmac:<stdin>:297: misuse, warning: .RI is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument."
an.tmac:<stdin>:303: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument."
Additionally (general):
Abbreviations get a '\&' added after their final full stop (.) to mark them
as such and not as an end of a sentence.
There is no need to add a '\&' before a full stop (.) if it has a character
before it!
--- fakeroot-sysv.1 2024-12-24 09:07:01.212187617 +0000
+++ fakeroot-sysv.1.new 2024-12-24 09:28:32.601342745 +0000
@@ -5,7 +5,8 @@
.de CW
.sp
.nf
-.ft CW
+.ie \n(.g .ft CR
+.el .ft CW
..
.de CE
.ft
@@ -21,20 +22,20 @@ fakeroot \- run a command in an environm
manipulation
.SH SYNOPSIS
.B fakeroot
-.B [\-l|\-\-lib
-.IB library]
-.B [\-\-faked
-.IB faked-binary ]
-.B [\-i
-.IB load-file ]
-.B [\-s
-.IB save-file ]
-.B [\-u|\-\-unknown\-is\-real]
-.B [\-b|\-\-fd\-base ]
-.B [\-h|\-\-help ]
-.B [\-v|\-\-version ]
-.BI [\-\-]
-.BI [command]
+.RB [ \-l | \-\-lib
+.IR library ]
+.RB [ \-\-faked
+.IR faked-binary ]
+.RB [ \-i
+.IR load-file ]
+.RB [ \-s
+.IR save-file ]
+.RB [ \-u | \-\-unknown\-is\-real ]
+.RB [ \-b | \-\-fd\-base ]
+.RB [ \-h | \-\-help ]
+.RB [ \-v | \-\-version ]
+.RB [ \-\- ]
+.RI [ command ]
.SH DESCRIPTION
.B fakeroot
runs a command in an environment wherein it appears to have root privileges
@@ -102,7 +103,7 @@ for more details.
Load a fakeroot environment previously saved using \-s from load-file.
Note that this does not implicitly save the file, use \-s as well for
that behaviour. Using the same file for both \-i and \-s in a single
-.BR fakeroot
+.B fakeroot
invocation is safe.
.TP
\fB\-u\fR, \fB\-\-unknown\-is\-real\fR
@@ -115,10 +116,10 @@ number to use for TCP connections; this
conflicts with the file descriptors used by the programs being run
under fakeroot.
.TP
-.BI \-h
+.B \-h
Display help.
.TP
-.BI \-v
+.B \-v
Display version.
.SH EXAMPLES
@@ -157,7 +158,7 @@ could do anyway happen for real.
.B fakeroot
was specifically written to enable users to create Debian GNU/Linux
packages (in the
-.BR deb(5)
+.BR deb (5)
format) without giving them root privileges.
This can be done by commands like
.B dpkg-buildpackage \-rfakeroot
@@ -238,21 +239,21 @@ and
but that creates other problems, as demonstrated by the libtricks
package. This package wrapped many more functions, and tried to do a
lot more than
-.B fakeroot .
+.BR fakeroot .
It turned out that a minor upgrade of libc (from one where the
-.BR stat()
+.BR stat ()
function didn't use
-.BR open()
+.BR open ()
to one with a
-.BR stat()
+.BR stat ()
function that did (in some cases) use
-.BR open() ),
+.BR open "() ),"
would cause unexplainable segfaults (that is, the libc6
-.BR stat()
+.BR stat ()
called the wrapped
-.BR open() ,
+.BR open "() ,"
which would then call the libc6
-.BR stat() ,
+.BR stat "() ,"
etc).
Fixing them wasn't all that easy,
but once fixed, it was just a matter of time before another function
@@ -260,7 +261,6 @@ started to use open(), never mind trying
operating system. Thus I decided to keep the number of functions
wrapped by fakeroot as small as possible, to limit the likelihood
of \(oqcollisions\(cq.
-.B
.IP "GNU configure (and other such programs)"
fakeroot, in effect, is changing the way the system
behaves. Programs that probe the system like GNU configure may get
@@ -294,11 +294,11 @@ Clint Adams
Timo Savola
.SH MANUAL PAGE
mostly by J.H.M.\& Dassen
-.RI <[email protected]>,
+<[email protected]>,
with rather a lot of modifications and additions by joost and Clint.
.SH "SEE ALSO"
.BR debuild (1),
.BR dpkg\-buildpackage (1),
.BR faked (1),
-.BR /usr/share/doc/fakeroot/DEBUG
+.B /usr/share/doc/fakeroot/DEBUG
