Package: linux-base Version: 4.17 Severity: minor Tags: patch Additional remarks.
Mails from me to "[email protected]" are no longer acknowledged. A Debian maintainer told me, that he would contact the mail administrator about me not wanting to send bugs upstream. -.- Dear Maintainer, >From "ftp.debian.org/debian/doc/bug-reporting.txt" Don't file bugs upstream If you file a bug in Debian, don't send a copy to the upstream software maintainers yourself to start with, as it is possible that the bug exists only in Debian. If necessary, the maintainer of the package will forward the bug upstream, or ask you to do so after they've checked that it isn't Debian-specific. -.- For forwarding bug reports to upstream see: https://www.debian.org/Bugs/Developer#forward -.- "Handling bug reports" in http://people.debian.org/~enrico/dcg/ch03s02.html -.- I do not send reports upstream if I have to get an account there. The Debian maintainers have one already. -.- * 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=0 -ww -z < "man page" [Use grep -n -e ' $' -e '\\~$' -e ' \\f.$' -e ' \\"' -e ' "$' <file> to find (most) 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? Output from "test-groff -mandoc -K utf8 -rF0 -rHY=0 -ww -z ": an.tmac:<stdin>:46: warning: tbl preprocessor failed, or it or soelim was not run; table(s) likely not rendered (TE macro called with TW register undefined) troff:<stdin>:67: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:71: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:76: warning: end of sentence detected before end of text line [-w style] * 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: forky/sid APT prefers testing APT policy: (500, 'testing') Architecture: amd64 (x86_64) Kernel: Linux 7.1.13+deb14-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 linux-base depends on: ii debconf [debconf-2.0] 1.5.92 linux-base recommends no packages. linux-base suggests no packages. -- debconf information excluded
Input file is kernel-img.conf.5
Output from
test-groff mandoc -Kutf8 -Tutf8 -ww -z kernel-img.conf.5: (shortened list)
3 end of sentence detected before end of text line [-w style]
1 tbl preprocessor failed, or it or soelim was not run; table(s) likely
not rendered (TE macro called with TW register undefined)
-.-.
Wrong distance (not two spaces, not a new line character (\n)) between
sentences in the input file.
mandoc(1) says: "New sentence, new line."
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"
50:pair. Boolean values may be specified as
-.-.
Change comment lines of type '.\" ====', '.\" ---', and an empty
'.\"' line) to a single period, as they contain no information and waste
work each time they are processed.
4:.\"
9:.\"
14:.\"
19:.\"
24:.\"
-.-.
The first line of the man page should only contain information about the
preprocessing of tables, see man(1), chapter "DEFAULTS".
1: .\" Hey, Emacs! This is an -*- nroff -*- source file.
-.-.
The first line of the man page should only contain information about the
preprocessing of tables, see man(1), chapter "DEFAULTS".
40: .TS
-.-.
Additionally:
Size/bytes:
2954 kernel-img.conf.5
2947 kernel-img.conf.5.new
-.-
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
-.-
Tables:
Use the preprocessor 'tbl' to make tables.
Put data, that are wider than the header in the (centered) last column,
in a "T{...\nT}" block.
Table headings, that are wider than any data in the corresponding
column, do not need to be centered, so left adjustment (l, L) is
sufficient. There is thereby no change in the standard output.
--- kernel-img.conf.5 2026-09-11 22:10:06.259782936 +0000 +++ kernel-img.conf.5.new 2026-09-11 22:20:09.014002099 +0000 @@ -1,27 +1,28 @@ +'\" t .\" Hey, Emacs! This is an -*- nroff -*- source file. .\" Copyright (c) 2000 Manoj Srivastava <[email protected]> .\" Copyright 2019 Ben Hutchings <[email protected]> -.\" +. .\" This is free documentation; you can redistribute it and/or .\" modify it under the terms of the GNU General Public License as .\" published by the Free Software Foundation; either version 2 of .\" the License, or (at your option) any later version. -.\" +. .\" The GNU General Public License's references to "object code" .\" and "executables" are to be interpreted as the output of any .\" document formatting or typesetting system, including .\" intermediate and printed output. -.\" +. .\" This manual is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. -.\" +. .\" You should have received a copy of the GNU General Public .\" License along with this manual; if not, write to the Free .\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, .\" USA. -.\" +. .TH KERNEL\-IMG.CONF 5 "25 May 2025" Debian "Debian GNU/Linux manual" .\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection .\" other parms are allowed: see man(7), man(1) @@ -47,7 +48,8 @@ make deb\-pkg ignored .PP The format of the file is a simple .IB VAR = VALUE -pair. Boolean values may be specified as +pair. +Boolean values may be specified as .IR Yes , .IR True , .IR 1 , @@ -64,17 +66,18 @@ At the moment, the user modifiable varia .B do_symlinks If set, the postinst and postrm scripts will maintain symlinks to default kernel and initramfs images, as described in -\fIlinux\-update\-symlinks\fR(8). This variable is set by default. +\fIlinux\-update\-symlinks\fR(8). +This variable is set by default. .TP .B image_dest Set this variable to the directory in which symlinks to the -default kernel and initramfs images should be maintained. The -default value is \fI/\fR. +default kernel and initramfs images should be maintained. +The default value is \fI/\fR. .TP .B link_in_boot If set, this has the same effect as \fIimage_dest\ =\ /boot\fR -and overrides any other setting of \fBimage_dest\fR. This -variable is unset by default. +and overrides any other setting of \fBimage_dest\fR. +This variable is unset by default. .SH FILES The file described here is .IR /etc/kernel\-img.conf .
Check the output from "lintian" in the Debian distribution. 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> To find most trailing spaces use grep -n -e ' $' -e ' \\f.$' -e ' \\"' -e ' "$' <man page> The same goes for man pages that are used as an input. -.- For a style guide use mandoc -T lint -.- For general input conventions consult the man page "nroff(7)" (item "Input conventions") or the Texinfo manual about the same item. -.- 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. Debian can fix simple bugs in the used generators and distribute them, and does not need to wait for upstream to do that and distribute them. -.- 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 when that has been fixed. 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 a script "cmp.manuals" in the attachment. Or 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) -.-
cmp.manuals.gz
Description: application/gzip
