Package: valgrind
Version: 1:3.24.0-2
Severity: minor
Tags: upstream
* 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?
troff:<stdin>:41: warning: trailing space in the line
troff:<stdin>:46: warning: trailing space in the line
troff:<stdin>:51: warning: trailing space in the line
troff:<stdin>:63: 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.12.17-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 valgrind depends on:
ii libc6 2.41-4
ii libc6-dbg 2.41-4
Versions of packages valgrind recommends:
ii gdb 16.2-2
ii python3 3.13.2-2
pn valgrind-dbg <none>
Versions of packages valgrind suggests:
pn kcachegrind <none>
pn valgrind-mpi <none>
-- no debconf information
Input file is ms_print.1
Output from "mandoc -T lint ms_print.1": (shortened list)
1 input text line longer than 80 bytes: takes an output file...
4 skipping paragraph macro: PP after SH
-.-.
Output from "test-nroff -mandoc -t -ww -z ms_print.1": (shortened list)
4 trailing space in the line
Remove trailing space with: sed -e 's/ *$//'
-.-.
Show if docman-to-man created this.
Who is actually creating this man page? Debian or upstream?
Is the generating software out of date?
4:.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.-.
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 38, length 113
takes an output file produced by the Valgrind tool Massif and prints the
information in an easy\-to\-read form\&.
Longest line is: 113 characters.
-.-.
The name of a man page is typeset in bold and the section in roman
(see man-pages(7)).
69:valgrind(1),
-.-.
No need for '\&' to be in front of a period (.),
if there is a character in front of it.
Remove with "sed -e 's/\\&\././g'".
10:.TH "MS_PRINT" "1" "01/22/2025" "Release 3\&.24\&.0" "ms_print"
38:takes an output file produced by the Valgrind tool Massif and prints the
information in an easy\-to\-read form\&.
43:Show the help message\&.
48:Show the version number\&.
51:\fB\-\-threshold=<m\&.n> [default: 1\&.0] \fR
55:option, but applied after profiling rather than during\&.
58:\fB\-\-x=<4\&.\&.1000> [default: 72]\fR
60:Width of the graph, in columns\&.
63:\fB\-\-y=<4\&.\&.1000> [default: 20] \fR
65:Height of the graph, in rows\&.
70:$INSTALL/share/doc/valgrind/html/index\&.html
72:http://www\&.valgrind\&.org/docs/manual/index\&.html\&;.
75:Nicholas Nethercote\&.
-.-.
Put a subordinate sentence (after a comma) on a new line.
ms_print.1:55:option, but applied after profiling rather than during\&.
ms_print.1:60:Width of the graph, in columns\&.
ms_print.1:65:Height of the graph, in rows\&.
-.-.
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.
ms_print.1:10:.TH "MS_PRINT" "1" "01/22/2025" "Release 3\&.24\&.0" "ms_print"
ms_print.1:30:.SH "NAME"
ms_print.1:32:.SH "SYNOPSIS"
ms_print.1:35:.SH "DESCRIPTION"
ms_print.1:39:.SH "OPTIONS"
ms_print.1:73:.SH "AUTHOR"
-.-.
Use ".na" (no adjustment) instead of ".ad l" (and ".ad" to begin the
same adjustment again as before).
26:.ad l
-.-.
Section headings (.SH and .SS) do not need quoting their arguments.
30:.SH "NAME"
32:.SH "SYNOPSIS"
35:.SH "DESCRIPTION"
39:.SH "OPTIONS"
67:.SH "SEE ALSO"
73:.SH "AUTHOR"
-.-.
Use "\-" instead of "-" in web addresses.
16:.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
-.-.
Put a (long) web address on a new line to reduce the posibility of
splitting the address between two output lines.
Or inhibit hyphenation with "\%" in front of the name.
72:http://www\&.valgrind\&.org/docs/manual/index\&.html\&;.
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:41: warning: trailing space in the line
troff:<stdin>:46: warning: trailing space in the line
troff:<stdin>:51: warning: trailing space in the line
troff:<stdin>:63: warning: trailing space in the line
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
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)
-.-
