Package: procps
Version: 2:4.0.4-7
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>:41: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:44: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' 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 procps depends on:
ii init-system-helpers 1.68
ii libc6 2.40-6
ii libncursesw6 6.5+20250125-2
ii libproc2-0 2:4.0.4-7
ii libsystemd0 257.2-3
ii libtinfo6 6.5+20250125-2
Versions of packages procps recommends:
ii linux-sysctl-defaults 4.11
ii psmisc 23.7-1
procps suggests no packages.
-- no debconf information
Input file is sysctl.conf.5
Output from "mandoc -T lint sysctl.conf.5": (shortened list)
1 input text line longer than 80 bytes: If a line begins wit...
1 input text line longer than 80 bytes: file is used to over...
1 input text line longer than 80 bytes: to list all possible...
1 skipping paragraph macro: PP empty
-.-.
Output from "test-groff -mandoc -t -ww -z sysctl.conf.5": (shortened list)
1 Use macro '.B' for one argument or split argument.
1 Use macro '.I' for one argument or split argument.
1 .BR is for at least 2 arguments, got 1
1 .IR 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.
47:to list all possible parameters. The description of individual parameters
can be found in the kernel documentation.
-.-.
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Add "\:" to split the string for the output, "\<newline>" in the source.
Line 36, length 82
If a line begins with a single \-, any attempts to set the value that fail will
be
Line 42, length 118
file is used to override default kernel parameter values, only a small number
of parameters is predefined in the file.
Line 47, length 115
to list all possible parameters. The description of individual parameters can
be found in the kernel documentation.
-.-.
The macro .MT is for e-mail, not the .UR macro; end with .ME.
86:.UR stai...@0wned.org
91:.UR pro...@freelists.org
-.-.
Remove quotes when there is a printable
but no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.
13:.TH SYSCTL.CONF "5" "2021-09-15" "procps-ng" "File Formats"
-.-.
Section headings (.SH and .SS) do not need quoting.
89:.SH "REPORTING BUGS"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:41: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:44: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
--- sysctl.conf.5 2025-02-16 03:08:16.124496705 +0000
+++ sysctl.conf.5.new 2025-02-16 03:23:46.665744707 +0000
@@ -10,7 +10,7 @@
.\" (at your option) any later version.
.\"
.\"
-.TH SYSCTL.CONF "5" "2021-09-15" "procps-ng" "File Formats"
+.TH SYSCTL.CONF 5 2021-09-15 procps-ng "File Formats"
.SH NAME
sysctl.conf \- sysctl preload/configuration file
.SH DESCRIPTION
@@ -33,18 +33,21 @@ Note that blank lines are ignored, and w
value is ignored, although a value can contain whitespace within. Lines which
begin with a \fI#\fR or \fI;\fR are considered comments and ignored.
-If a line begins with a single \-, any attempts to set the value that fail
will be
-ignored.
+If a line begins with a single \-,
+any attempts to set the value that fail will be ignored.
.SH NOTES
As the
-.BR /etc/sysctl.conf
-file is used to override default kernel parameter values, only a small number
of parameters is predefined in the file.
+.B /etc/sysctl.conf
+file is used to override default kernel parameter values,
+only a small number of parameters is predefined in the file.
Use
-.IR /sbin/sysctl\ \-a
+.I /sbin/sysctl\ \-a
or follow
.BR sysctl (8)
-to list all possible parameters. The description of individual parameters can
be found in the kernel documentation.
+to list all possible parameters.
+The description of individual parameters can be found in the kernel
+documentation.
Maximum supported line length of the value is 4096 characters due
to a limitation of \fI/proc\fR entries in Linux kernel.
@@ -60,7 +63,6 @@ to a limitation of \fI/proc\fR entries i
kernel.modprobe = /sbin/mod probe
.fi
.RE
-.PP
.SH FILES
.I /etc/sysctl.d/*.conf
.br
@@ -83,10 +85,10 @@ option
.SH SEE ALSO
.BR sysctl (8)
.SH AUTHOR
-.UR stai...@0wned.org
+.MT stai...@0wned.org
George Staikos
-.UE
-.SH "REPORTING BUGS"
+.ME
+.SH REPORTING BUGS
Please send bug reports to
-.UR pro...@freelists.org
-.UE
+.MT pro...@freelists.org
+.ME
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)
-.-
