Package: fakeroot
Version: 1.37-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 ' $' -e '\\~$' <file>" to find obvious 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>: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.12-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-7
ii libfakeroot 1.37-1
fakeroot recommends no packages.
fakeroot suggests no packages.
-- no debconf information
Input file is fakeroot-sysv.1
Output from "mandoc -T lint fakeroot-sysv.1": (shortened list)
5 line scope broken: IP breaks B
-.-.
Output from "test-nroff -mandoc -t -ww -z fakeroot-sysv.1": (shortened list)
1 Use macro '.B' for one argument or split argument.
1 .BR is for at least 2 arguments, got 1
-.-.
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 final abbreviation point as such by suffixing it with "\&".
Some sentences (etc.) do not begin on a new line.
Split (sometimes) lines after a punctuation mark; before a conjunction.
Lines with only one (or two) space(s) between sentences could be split,
so latter sentences begin on a new line.
Use
#!/usr/bin/sh
sed -e '/^\./n' \
-e 's/\([[:alpha:]]\)\. */\1.\n/g' $1
to split lines after a sentence period.
Check result with the difference between the formatted outputs.
See also the attachment "general.bugs"
[List of affected lines removed.]
-.-
The name of a man page is typeset in bold and the section in roman
(see man-pages(7)).
52:works by replacing the file manipulation library functions (chmod(2),
53:stat(2) etc.) by ones that simulate the effect the real library
96:this can be useful. For example, it can be used with rsync(1) to back up
-.-.
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:114:Specify fd base (TCP mode only). fd is the minimum file
descriptor
fakeroot-sysv.1:249:function that did (in some cases) use
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
-.-.
Space after an end of sentence.
[List of affected lines removed.]
-.-
Put a subordinate sentence (after a comma) on a new line.
[List of affected lines removed.]
-.-.
Section headings (.SH and .SS) do not need quoting their arguments.
299:.SH "SEE ALSO"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:303: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- fakeroot-sysv.1 2025-03-07 12:21:27.947366464 +0000
+++ fakeroot-sysv.1.new 2025-03-07 13:33:56.714663058 +0000
@@ -49,8 +49,9 @@ up, or one would have to construct the a
archiver.
.B fakeroot
-works by replacing the file manipulation library functions (chmod(2),
-stat(2) etc.) by ones that simulate the effect the real library
+works by replacing the file manipulation library functions
+.RB ( chmod "(2), " stat (2)
+etc.) by ones that simulate the effect the real library
functions would have had, had the user really been root. These wrapper
functions are in a shared library
.B /usr/lib/*/libfakeroot-*.so
@@ -93,7 +94,9 @@ Save the fakeroot environment to save-fi
used to restore the environment later using \-i. However, this file will
leak and fakeroot will behave in odd ways unless you leave the files
touched inside the fakeroot alone when outside the environment. Still,
-this can be useful. For example, it can be used with rsync(1) to back up
+this can be useful. For example, it can be used with
+.BR rsync (1)
+to back up
and restore whole directory trees complete with user, group and device
information without needing to be root. See
.I /usr/share/doc/fakeroot/README.saving
@@ -174,7 +177,6 @@ privileges, or decrease the system's sec
.I /usr/lib/*/libfakeroot-*.so
The shared library containing the wrapper functions.
.SH ENVIRONMENT
-.B
.IP FAKEROOTKEY
The key used to communicate with the fakeroot daemon. Any program
started with the right
@@ -185,9 +187,7 @@ of a running daemon will automatically c
have the same "fake" view of the file system's permissions/ownerships
(assuming the daemon and connecting program were started by the same
user).
-.B
.IP LD_LIBRARY_PATH
-.B
.IP LD_PRELOAD
fakeroot is implemented by wrapping system calls. This is
accomplished by setting LD_LIBRARY_PATH=/usr/lib/fakeroot and
@@ -203,14 +203,12 @@ given paths, as in
.B LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/foo/bar/
.SH LIMITATIONS
-.B
.IP "Library versions"
Every command executed within
.B fakeroot
needs to be linked to the same version of the C library as
.B fakeroot
itself.
-.B
.IP open()/create()
fakeroot doesn't wrap open(), create(), etc. So, if user
.B joost
@@ -293,11 +291,11 @@ Clint Adams
.TP
Timo Savola
.SH MANUAL PAGE
-mostly by J.H.M. Dassen
+mostly by J.H.M.\& Dassen
.BI < jdas...@debian.org >
with rather a lot of modsifications and additions by joost and Clint.
-.SH "SEE ALSO"
+.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
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
-.-
Any "autogenerator" should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
It should also check its input files for too long (> 80) lines.
This is just a simple quality control measure.
The "autogenerator" may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
Not removing trailing spaces (in in- and output).
The reason for these trailing spaces should be found and eliminated.
"git" has a "tool" to point out whitespace,
see for example "git-apply(1)" and git-config(1)")
Not beginning each input sentence on a new line.
Line length and patch size should thus be reduced.
The script "reportbug" uses 'quoted-printable' encoding when a line is
longer than 1024 characters in an 'ascii' file.
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 -d -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 from 'diff -d -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)
-.-
