Dear Bjarni,
thanks very much for the corrections/patches to the man pages.
I reviewed the diff and it looks good. Something I was wondering: why
are you inserting the zero width characters '\&' in various places? I
thought that there were only needed to avoid an input sequence being
misinterpreted as a control character. But in many places where you
have inserted it, I did not realize that this was a possibility.
Cheers,
Bruce
On 17.07.23 04:46, Bjarni Ingi Gislason wrote:
Package: smartmontools
Version: 7.3-1+b1
Severity: minor
Tags: patch
Dear Maintainer,
here are some notes and editorial fixes for the man page.
Patch is in the attachment.
-.-.
The difference between the formatted outputs can be seen with:
nroff -man <file1> > <out1>
nroff -man <file2> > <out2>
diff -u <out1> <out2>
and for groff, using
"groff -man -Z" instead of "nroff -man"
Add the option "-t", if the file contains a table.
Read the output of "diff -u" with "less -R" or similar.
-.-.
If "man" (man-db) is used to check the manual, 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 -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-.
Output from "mandoc -T lint smartd.conf.5":
mandoc: smartd.conf.5:250:2: WARNING: line scope broken: SH breaks TP
mandoc: smartd.conf.5:600:81: STYLE: input text line longer than 80 bytes: It
may also be used ...
mandoc: smartd.conf.5:1080:84: STYLE: input text line longer than 80 bytes: If
\*(Aq@ALL\*(Aq is...
-.-.
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.
smartd.conf.5:2:Copyright (C) 2002-10 Bruce Allen
smartd.conf.5:3:Copyright (C) 2004-21 Christian Franke
smartd.conf.5:122:# Start short self\-tests daily between 1\-2, 2\-3, and
smartd.conf.5:123:# 3\-4 am.
smartd.conf.5:142:# Start short self\-tests daily between 1\-2, 2\-3, and
smartd.conf.5:143:# 3\-4 am.
smartd.conf.5:152:# 1 am and 2\-3 am
smartd.conf.5:173:# Start short self\-tests daily between 1\-2, 2\-3, and
smartd.conf.5:174:# 3\-4 am.
smartd.conf.5:192:# between midnight and 1 am and 2\-3 am.
smartd.conf.5:225:# Start short self\-tests daily between 1\-2, 2\-3, and
smartd.conf.5:226:# 3\-4 am.
smartd.conf.5:964: smartctl \-t select,0\-99999999 /dev/sda
smartd.conf.5:969:\fB \-s n/../../[1\-5]/12\fP
-.-.
Wrong distance between sentences.
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.
Seach for two words are 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.
167:# uses the cciss driver. Start long tests on Sunday nights and short
248:then the corresponding block device (/dev/sd?) must be listed,
371:then the corresponding SCSI (/dev/sd?) or character device (/dev/twe?,
372:/dev/twa?, /dev/twl? or /dev/tws?) must be listed, along with the
379:then the corresponding device (SCSI /dev/sg? on Linux or /dev/arcmsr0 on
-.-.
Protect a period (.) or a apostrophe (') with '\&' from becoming a
control character, if it could end up at the start of a line
(by splitting the line into more lines).
115:# flagged with the '\-d sat' option. This situation
648:\fBsmartd\fP checks it. This is the default behavior if the '\-n'
786:Appending ',ns' (no standby) to this directive is not implemented \"#
801:Appending ',ns' (no standby) to this directive is not implemented \"#
934:0, ... hours, use:
938:To enable staggered tests with delays 0, 1, 2, ..., 9, 10, 0, ... hours,
-.-.
Split a punctuation from a single argument, if a two-font macro is meant
64:.B /etc/smartd.conf.
-.-.
Use \(en for a dash (en-dash) between space characters and at the
beginning of a line, not a minus (\-) or a hyphen (-), except in the
NAME section.
smartd.conf.5:394:\- attempt to guess the device type from the device name or
from
[... and more]
smartd.conf.5:1644:\- show the presets that are available for all drives and
then exit.
-.-.
[ "test-groff" is a developmental version of "groff" ]
Input file is ./smartd.conf.5
Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z ":
troff: backtrace: file '<stdin>':33
troff:<stdin>:33: warning: trailing space in the line
troff: backtrace: file '<stdin>':34
troff:<stdin>:34: warning: trailing space in the line
troff: backtrace: file '<stdin>':786
troff:<stdin>:786: warning: trailing space in the line
troff: backtrace: file '<stdin>':787
troff:<stdin>:787: warning: trailing space in the line
troff: backtrace: file '<stdin>':801
troff:<stdin>:801: warning: trailing space in the line
troff: backtrace: file '<stdin>':802
troff:<stdin>:802: warning: trailing space in the line
-.-.
-- System Information:
Debian Release: trixie/sid
APT prefers testing-proposed-updates
APT policy: (500, 'testing-proposed-updates'), (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.3.7-1 (SMP w/2 CPU threads; PREEMPT)
Kernel taint flags: TAINT_WARN
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.8-1
ii libc6 2.37-5
ii libcap-ng0 0.8.3-1+b3
ii libgcc-s1 13.1.0-6
ii libselinux1 3.4-1+b6
ii libstdc++6 13.1.0-6
ii libsystemd0 253.5-1
ii lsb-base 11.6
ii sysvinit-utils [lsb-base] 3.07-1
smartmontools recommends no packages.
Versions of packages smartmontools suggests:
ii bsd-mailx [mailx] 8.1.2-0.20220412cvs-1
ii curl 7.88.1-10
ii gpg 2.2.40-1.1
pn gsmartcontrol <none>
ii lynx 2.9.0dev.12-1
pn smart-notifier <none>
ii wget 1.21.3-1+b2
-- no debconf information
--
--------------------------------------------------------------------
Bruce Allen, Adjunct Professor of Physics
Leonard E. Parker Center for Gravitation, Cosmology and Astrophysics
Physics Department
University of Wisconsin - Milwaukee
3135 N Maryland Ave
Milwaukee, 53211 USA
Tel: +1 414-229-4474
Fax: +1 414-229-5589
bal...@uwm.edu
