Package: libproc-processtable-perl
Version: 0.636-1+b3
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
grep -n -e ' $' -e '\\~$' -e ' \\f.$' -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?
troff:<stdin>:122: warning: trailing space in the line
troff:<stdin>:129: warning: trailing space in the line
troff:<stdin>:134: 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.21-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 libproc-processtable-perl depends on:
ii libc6 2.41-6
ii perl 5.40.1-2
ii perl-base [perlapi-5.40.0] 5.40.1-2
libproc-processtable-perl recommends no packages.
libproc-processtable-perl suggests no packages.
-- no debconf information
Input file is Proc::ProcessTable::Process.3pm
Output from "mandoc -T lint Proc::ProcessTable::Process.3pm": (shortened list)
-.-.
Output from
test-nroff -mandoc -t -ww -z Proc::ProcessTable::Process.3pm: (shortened list)
3 line(s) with a trailing space
Find trailing space with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
-.-.
Show if Pod::Man generated this.
Who is actually creating this man page? Debian or upstream?
Is the generating software out of date?
2:.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
-.-.
Remove space characters (whitespace) at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
Number of lines affected is
3
-.-.
-.-.
Wrong distance (not two spaces) 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"
77:Proc::ProcessTable. Proc::ProcessTable::Process objects are
85:kill. Takes the signal (name or number) as an argument. Returns number
91:function. Returns the process priority.
98:they are named. Currently supported are:
144:J. Bargsten, D. Urist
-.-.
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 58, length 99
.TH Proc::ProcessTable::Process 3pm 2024-10-15 "perl v5.40.0" "User Contributed
Perl Documentation"
-.-.
The name of a man page is typeset in bold and the section in roman
(see man-pages(7)).
68:\& $process\->kill(9);
-.-.
Add a zero (0) in front of a decimal fraction that begins with a period
(.)
7:.if t .sp .5v
-.-.
Use a character "\(->" instead of plain "->" or "\->".
68:\& $process\->kill(9);
69:\& $process\->priority(19);
70:\& $process\->pgrp(500);
71:\& $uid = $process\->uid;
-.-.
Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).
Proc::ProcessTable::Process.3pm:77:Proc::ProcessTable.
Proc::ProcessTable::Process objects are
Proc::ProcessTable::Process.3pm:85:kill. Takes the signal (name or number) as
an argument. Returns number
Proc::ProcessTable::Process.3pm:91:function. Returns the process priority.
Proc::ProcessTable::Process.3pm:98:they are named. Currently supported are:
Proc::ProcessTable::Process.3pm:144:J. Bargsten, D. Urist
-.-.
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.
Proc::ProcessTable::Process.3pm:66:.IX Header "SYNOPSIS"
Proc::ProcessTable::Process.3pm:75:.IX Header "DESCRIPTION"
Proc::ProcessTable::Process.3pm:81:.IX Header "METHODS"
Proc::ProcessTable::Process.3pm:139:.IX Header "AUTHOR"
-.-.
Use ".na" (no adjustment) instead of ".ad l" (and ".ad" to begin the
same adjustment again as before).
61:.if n .ad l
-.-.
Add lines to use the CR font for groff instead of CW.
.if t \{\
. ie \\n(.g .ft CR
. el .ft CW
.\}
11:.ft CW
-.-.
Section headings (.SH and .SS) do not need quoting their arguments.
145:.SH "SEE ALSO"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:122: warning: trailing space in the line
troff:<stdin>:129: warning: trailing space in the line
troff:<stdin>:134: warning: trailing space in the line
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- Proc::ProcessTable::Process.3pm 2025-04-08 01:47:13.216557450 +0000
+++ Proc::ProcessTable::Process.3pm.new 2025-04-08 01:52:31.053080081 +0000
@@ -119,19 +119,19 @@ they are named. Currently supported are:
\& stime kernel mode time (Linux only)
\& cutime child utime (Linux only)
\& cstime child stime (Linux only)
-\& time user + system time
+\& time user + system time
\& ctime child user + system time
\& timensec user + system nanoseconds part (Solaris only)
\& ctimensec child user + system nanoseconds (Solaris only)
\& qtime cumulative cpu time (IRIX only)
\& size virtual memory size (bytes)
\& rss resident set size (bytes)
-\& wchan address of current system call
+\& wchan address of current system call
\& fname file name
\& start start time (seconds since the epoch)
\& pctcpu percent cpu used since process started
\& state state of process
-\& pctmem percent memory
+\& pctmem percent memory
\& cmndline full command line of process
\& ttydev path of process\*(Aqs tty
\& clname scheduling class name (IRIX only)
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 trailing space use
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <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)
-.-
