Package: smartmontools
Version: 7.4-3
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?
troff:<stdin>:39: warning: trailing space in the line
troff:<stdin>:40: warning: trailing space in the line
troff:<stdin>:196: warning: font name 'CW' is deprecated
* 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 smartmontools depends on:
ii debianutils 5.21
ii libc6 2.40-7
ii libcap-ng0 0.8.5-4+b1
ii libgcc-s1 14.2.0-16
ii libselinux1 3.8-4
ii libstdc++6 14.2.0-16
ii libsystemd0 257.3-1
ii sysvinit-utils 3.14-1
smartmontools recommends no packages.
Versions of packages smartmontools suggests:
ii curl 8.12.1-3
ii gpg 2.2.46-1+b1
pn gsmartcontrol <none>
ii lynx 2.9.2-1
pn mailx | mailutils <none>
pn smart-notifier <none>
ii wget 1.24.5-2+b1
-- no debconf information
Input file is update-smart-drivedb.8
Output from "mandoc -T lint update-smart-drivedb.8": (shortened list)
-.-.
Output from "test-groff -mandoc -t -ww -z update-smart-drivedb.8": (shortened
list)
1 font name 'CW' is deprecated
2 trailing space in the line
Remove trailing space with: sed -e 's/ *$//'
-.-.
Change '-' (\-) to '\(en' (en-dash) for a (numeric) range.
GNU gnulib has recently (2023-06-18) updated its
"build_aux/update-copyright" to recognize "\(en" in man pages.
update-smart-drivedb.8:3:Copyright (C) 2014-23 Christian Franke
-.-.
Change two HYPHEN-MINUSES (code 0x2D) to an em-dash (\(em),
if one is intended.
" \(em " creates a too big gap in the text (in "troff").
An en-dash is usually surrounded by a space,
while an em-dash is used without spaces.
"man" (1 byte characters in input) transforms an en-dash (\(en) to one
HYPHEN-MINUS,
and an em-dash to two HYPHEN-MINUSES without considering the space
around it.
If "--" are two single "-"
(begin of an option or end of options)
then use "\-\-".
update-smart-drivedb.8:203:# update-smart-drivedb --force \e
update-smart-drivedb.8:204: --file /var/lib/smartmontools/drivedb/drivedb.h.old
update-smart-drivedb.8:210:$ update-smart-drivedb --trunk --no-verify -s - -u
trac drivedb-trunk.h
-.-.
Remove space in the first column, if not indented.
Use ".in +<number>n" and ".in" to end it; ".nf" and ".fi" to end
it, for an extra indention.
update-smart-drivedb.8:204: --file /var/lib/smartmontools/drivedb/drivedb.h.old
-.-.
Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.
203:# update-smart-drivedb --force \e
204: --file /var/lib/smartmontools/drivedb/drivedb.h.old
210:$ update-smart-drivedb --trunk --no-verify -s - -u trac drivedb-trunk.h
-.-.
Strings longer than 3/4 of a standard line length (80)
Use "\:" to split the string at the end of an output line, for example a
long URL (web address)
263 <\fBhttps://listi.jpberlin.de/mailman/listinfo/smartmontools-support\fB>.
-.-.
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.
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"
39:[This man page is generated for the Linux version of smartmontools. \"#
-.-.
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 28, length 84
.TH UPDATE-SMART-DRIVEDB 8 "2023-08-01" "smartmontools-7.4" "SMART Monitoring
Tools"
-.-.
Add lines to use the CR font for groff instead of CW.
.if t \{\
. ie \n(.g .ft CR
. el .ft CW
.\}
16:.if t .ft CW
-.-.
Section headings (.SH and .SS) do not need quoting their arguments.
32:.SH "SYNOPSIS"
37:.SH "DESCRIPTION"
78:.SH "OPTIONS"
194:.SH "EXAMPLES"
214:.SH "EXIT STATUS"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:39: warning: trailing space in the line
troff:<stdin>:40: warning: trailing space in the line
troff:<stdin>:196: warning: font name 'CW' is deprecated
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
