Package: rdtool
Version: 0.6.39-1
Severity: minor
Tags: patch
Dear Maintainer,
>From "/usr/share/doc/debian/bug-reporting.txt.gz":
Don't file bugs upstream
If you file a bug in Debian, don't send a copy to the upstream software
maintainers yourself, as it is possible that the bug exists only in
Debian. If necessary, the maintainer of the package will forward the
bug upstream.
-.-
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.
If I get a negative (or no) response from upstream, I send henceforth
bugs to Debian.
-.-
* 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 ' \\"' <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-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:15: warning: trailing whitespace [-w trail]
* 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.0.10+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 rdtool depends on:
ii ruby 1:3.3+b1
ii ruby-rd 0.6.39-1
rdtool recommends no packages.
rdtool suggests no packages.
-- no debconf information
Input file is rd2.1
Output from "mandoc -T lint rd2.1": (shortened list)
1 STYLE: whitespace at end of input line
Find trailing whitespace with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
-.-.
Output from
test-nroff -mandoc -t -Kutf8 -ww -z rd2.1: (shortened list)
1 trailing whitespace [-w trail]
Find trailing whitespace with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
-.-.
Show if generated from reStructuredText or rd2
A patch to a generated man page is to show where the generator
failed to make a "clean" man page rendering (that is without warnings) and
sometimes to show a better format for it.
1:.\" DO NOT MODIFY THIS FILE! it was generated by rd2
Latest version: docutils (Docutils 0.22.4, Python 3.13.12, on linux)
-.-.
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".
See more information in the attachment "trailing whitespace".
Number of lines affected is
1
-.-.
Wrong distance (not two spaces, not a new line character (\n)) 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"
10:rd2 inputs from <file> and outputs into \&\fBSTDOUT\fP. you can
11:choose <visitor> to select output format. For example, use
-.-.
The name of a man page is typeset in bold (or italic) and the section in
roman (see man-pages(7)).
30:ruby(1)
-.-.
Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).
rd2.1:10:rd2 inputs from <file> and outputs into \&\fBSTDOUT\fP. you can
rd2.1:11:choose <visitor> to select output format. For example, use
-.-.
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:15: warning: trailing whitespace [-w trail]
-.-
Spelling (codespell):
configration ==> configuration
tranlate ==> translate
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(, when the table gets wider than the output line).
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.
--- rd2.1 2026-06-05 09:13:31.326392803 +0000
+++ rd2.1.new 2026-06-05 09:23:02.509097179 +0000
@@ -10,9 +10,9 @@ rd2 \- converter from RD to other mark\-
rd2 inputs from <file> and outputs into \&\fBSTDOUT\fP. you can
choose <visitor> to select output format. For example, use
"rd/rd2html\-lib.rb" to translate it into HTML, and "rd/rd2man\-lib.rb"
-to tranlate it into roff with man macros.
+to translate it into roff with man macros.
.SH OPTIONS
-please read output of
+please read output of
.nf
\& % rd2 \-\-help
.fi
@@ -25,7 +25,7 @@ and
.IP
.B
\(bu
-~/.rd2rc \- User configration file.
+~/.rd2rc \- User configuration file.
.SH SEE ALSO
-ruby(1)
+.BR ruby (1)
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 ' \\"' <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.
-.-
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:
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)
-.-
--- Begin Message ---
Trailing whitespace is so unnecessary, that its presence may be removed
before files containing it are distributed.
Some programs have a tool to point out its presence, like
gcc
with option "-Wtrailing-whitespace"
git
with option "apply --whitespace=..."
and in ".git/config"
[core]
whitespace=...
grep
with option -e ' $'
less
with command "/ $"
mandoc -T lint
default action
--- End Message ---
_______________________________________________
Pkg-ruby-extras-maintainers mailing list
[email protected]
https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-ruby-extras-maintainers
