Bug#1088253: update-tl-stacked-conffile.8: Some remarks and editorial changes for this man page
Package: tex-common
Version: 6.18
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with
test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -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?
troff: backtrace: file '<stdin>':22
troff:<stdin>:22: warning: trailing space in the line
troff: backtrace: file '<stdin>':44
troff:<stdin>:44: warning: trailing space in the line
troff: backtrace: file '<stdin>':49
troff:<stdin>:49: warning: trailing space in the line
troff: backtrace: file '<stdin>':50
troff:<stdin>:50: warning: trailing space in the line
troff: backtrace: file '<stdin>':130
troff:<stdin>:130: warning: trailing space in the line
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":
troff: backtrace: file '<stdin>':22
troff:<stdin>:22: warning: trailing space in the line
troff: backtrace: file '<stdin>':44
troff:<stdin>:44: warning: trailing space in the line
troff: backtrace: file '<stdin>':49
troff:<stdin>:49: warning: trailing space in the line
troff: backtrace: file '<stdin>':50
troff:<stdin>:50: warning: trailing space in the line
troff: backtrace: file '<stdin>':130
troff:<stdin>:130: 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.11.9-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 tex-common depends on:
ii ucf 3.0043+nmu1
tex-common recommends no packages.
Versions of packages tex-common suggests:
pn debhelper <none>
Versions of packages texlive-base depends on:
ii debconf [debconf-2.0] 1.5.87
ii libpaper-utils 1.1.29+b2
ii sensible-utils 0.0.24
ii texlive-binaries 2024.20240313.70630+ds-5
ii ucf 3.0043+nmu1
ii xdg-utils 1.1.3-4.1
Versions of packages texlive-base recommends:
pn lmodern <none>
Versions of packages texlive-base suggests:
ii ghostscript [postscript-viewer] 10.04.0~dfsg-1
ii gv [postscript-viewer] 1:3.7.4-2+b2
ii mupdf [pdf-viewer] 1.24.10+ds1-1
pn perl-tk <none>
ii xpdf [pdf-viewer] 3.04+git20240613-1+b1
pn xzdec <none>
Versions of packages texlive-binaries depends on:
ii libc6 2.40-3
ii libcairo2 1.18.2-2
ii libfontconfig1 2.15.0-1.1+b1
ii libfreetype6 2.13.3+dfsg-1
ii libgcc-s1 14.2.0-8
ii libgraphite2-3 1.3.14-2+b1
ii libharfbuzz0b 10.0.1-1
ii libicu72 72.1-5+b1
ii libkpathsea6 2024.20240313.70630+ds-5
ii libmpfi0 1.5.4+ds-4
ii libmpfr6 4.2.1-1+b2
ii libpaper1 1.1.29+b2
ii libpixman-1-0 0.44.0-3
ii libpng16-16t64 1.6.44-2
ii libpotrace0 1.16-2+b2
ii libptexenc1 2024.20240313.70630+ds-5
ii libstdc++6 14.2.0-8
ii libsynctex2 2024.20240313.70630+ds-5
ii libteckit0 2.5.12+ds1-1+b1
ii libtexlua53-5 2024.20240313.70630+ds-5
ii libx11-6 2:1.8.10-2
ii libxaw7 2:1.0.16-1
ii libxi6 2:1.8.2-1
ii libxmu6 2:1.1.3-3+b3
ii libxpm4 1:3.5.17-1+b2
ii libxt6t64 1:1.2.1-1.2+b1
ii libzzip-0-13t64 0.13.72+dfsg.1-1.2+b1
ii perl 5.40.0-7
ii t1utils 1.41-4
ii zlib1g 1:1.3.dfsg+really1.3.1-1+b1
Versions of packages texlive-binaries recommends:
pn dvisvgm <none>
ii texlive-base 2024.20241115-1
Versions of packages texlive-binaries suggests:
pn hintview <none>
pn texlive-binaries-sse2 <none>
-- debconf information excluded
Input file is update-tl-stacked-conffile.8
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 update-tl-stacked-conffile.8 ": (shortened list)
3 new sentence, new line
1 normalizing date format to
1 operating system explicitly specified
1 prologue macros out of order
1 referenced manual not found
6 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -b -z update-tl-stacked-conffile.8 ": (shortened list)
5 trailing space in the line
-.-.
Output from "mandoc -T lint update-tl-stacked-conffile.8 ":
mandoc: update-tl-stacked-conffile.8:1:5: STYLE: normalizing date format to: Dd July 17, 2013
mandoc: update-tl-stacked-conffile.8:2:5: STYLE: operating system explicitly specified: Os Debian (NetBSD)
mandoc: update-tl-stacked-conffile.8:3:2: WARNING: prologue macros out of order: Dt after Os
mandoc: update-tl-stacked-conffile.8:22:4: STYLE: whitespace at end of input line
mandoc: update-tl-stacked-conffile.8:23:6: STYLE: referenced manual not found: Xr updmap-sys 8
mandoc: update-tl-stacked-conffile.8:44:46: STYLE: whitespace at end of input line
mandoc: update-tl-stacked-conffile.8:49:58: STYLE: whitespace at end of input line
mandoc: update-tl-stacked-conffile.8:50:42: STYLE: whitespace at end of input line
mandoc: update-tl-stacked-conffile.8:51:17: STYLE: whitespace at end of input line
mandoc: update-tl-stacked-conffile.8:52:27: WARNING: new sentence, new line
mandoc: update-tl-stacked-conffile.8:57:20: WARNING: new sentence, new line
mandoc: update-tl-stacked-conffile.8:70:54: WARNING: new sentence, new line
mandoc: update-tl-stacked-conffile.8:130: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".
22:and
44:should also provide files in one of the above
49:In order to configure (enable additional entries, disable
50:system provided entries, etc), the normal
51:.Xr updmap 1 Ns
130:and
-.-.
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.
52:mechanism should be used. Please see the man page details.
57:kpathsea database. Don't use this in maintainer scripts.
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
update-tl-stacked-conffile.8:132:for the Debian distribution (and may be used by others).
-.-.
Two or more space charaters between printable characters.
When the distance is between sentences,
start the beginning of the second one on a separate line
("semantic newline").
70:option, which turns on verbose mode, is deprecated. We are currently in a
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":
troff: backtrace: file '<stdin>':22
troff:<stdin>:22: warning: trailing space in the line
troff: backtrace: file '<stdin>':44
troff:<stdin>:44: warning: trailing space in the line
troff: backtrace: file '<stdin>':49
troff:<stdin>:49: warning: trailing space in the line
troff: backtrace: file '<stdin>':50
troff:<stdin>:50: warning: trailing space in the line
troff: backtrace: file '<stdin>':130
troff:<stdin>:130: warning: trailing space in the line
-.-
Additionally:
Add a '.' after 'etc'.
Remove 'Ns' in an '.Xr' line.
--- update-tl-stacked-conffile.8 2024-11-25 19:43:03.720505021 +0000
+++ update-tl-stacked-conffile.8.new 2024-11-25 20:19:32.524576384 +0000
@@ -1,6 +1,6 @@
-.Dd Jul 17, 2013
-.Os Debian
+.Dd July 17, 2013
.Dt UPDATE-UPDMAP 8 SMM
+.Os Debian
.Sh NAME
.Nm update-updmap
.Nd generate
@@ -19,7 +19,7 @@ a program that was written for the Debia
.Nm
is used to generate
.Xr updmap 1 Ns 's
-and
+and
.Xr updmap-sys 8 Ns 's
configurations files
.Pa /var/lib/texmf/updmap.cfg-TEXLIVEDIST ,
@@ -41,20 +41,23 @@ Any TeX package shipping map files in on
.Pa /usr/share/texlive/texmf-dist
or
.Pa /usr/share/texmf
-should also provide files in one of the above
+should also provide files in one of the above
directories containing the respective lines for
.Pa updmap.cfg
file.
.Pp
-In order to configure (enable additional entries, disable
-system provided entries, etc), the normal
-.Xr updmap 1 Ns
-mechanism should be used. Please see the man page details.
+In order to configure
+(enable additional entries, disable system provided entries, etc.),
+the normal
+.Xr updmap 1
+mechanism should be used.
+Please see the man page details.
.Sh OPTIONS
.Bl -tag -width ".Fl -version"
.It Fl -check
Executes additional checks that all necessary files are present in the
-kpathsea database. Don't use this in maintainer scripts.
+kpathsea database.
+Don't use this in maintainer scripts.
.It Fl -quiet
don't write anything to the standard output during normal operation
.It Fl -help
@@ -67,10 +70,15 @@ output version information and exit
.Pp
Note that the
.Fl v
-option, which turns on verbose mode, is deprecated. We are currently in a
-transition phase where quiet mode is still the default (therefore,
+option,
+which turns on verbose mode,
+is deprecated.
+We are currently in a transition phase
+where quiet mode is still the default
+(therefore,
.Fl -quiet
-has no effect), but
+has no effect),
+but
.Nm
will be verbose by default as soon as enough packages use
.Fl -quiet
@@ -91,9 +99,11 @@ KanjiMap <baz.map>
.Pp
The
.Li MixedMap
-form should only be used if the font is available in both bitmap and scalable
-formats (this way, it won't be declared in the default map file for Dvips that
-is used
+form should only be used
+if the font is available in both bitmap
+and scalable formats
+(this way,
+it won't be declared in the default map file for Dvips that is used
when
.Li dvipsPreferOutline
is set to
@@ -127,9 +137,10 @@ This manual page was written by
.An Atsuhito Kohda Aq kohda@debian.org
and updated by
.An "Florent Rougon" Aq f.rougon@free.fr
-and
+and
.An "Frank Kuester" Aq frank@debian.org
-for the Debian distribution (and may be used by others).
+for the Debian distribution
+(and may be used by others).
.\" For Emacs:
.\" Local Variables:
.\" fill-column: 72
Reply to: