Package: ucf
Version: 3.0049
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>:8: warning: trailing space in the line
an.tmac:<stdin>:11: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
troff:<stdin>:19: warning: trailing space in the line
troff:<stdin>:31: warning: trailing space in the line
troff:<stdin>:54: 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.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 ucf depends on:
ii debconf [debconf-2.0] 1.5.89
ii libtext-wrapi18n-perl 0.06-10
ii procps 2:4.0.4-7
ii sensible-utils 0.0.24
ucf recommends no packages.
ucf suggests no packages.
-- debconf information excluded
Input file is ucf.conf.5
Output from "mandoc -T lint ucf.conf.5": (shortened list)
7 whitespace at end of input line
Remove trailing space with: sed -e 's/ *$//'
-.-.
Output from "test-groff -mandoc -t -ww -z ucf.conf.5": (shortened list)
1 Use macro '.B' for one argument or split argument.
1 .BR is for at least 2 arguments, got 1
5 trailing space in the line
Remove trailing space with: sed -e 's/ *$//'
-.-.
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
7
-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.
11:.BR "POSIX Shell"
-.-.
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.
12:snippet sourced by ucf(1) and ucfr(1). It can contain any shell directive
(just
30:information is printed). To enable debugging output, set the value to
34:Verbosity: The default value is 0 (quiet). To change the default
38:Force the installed file to be retained. The default is to have this
44:Force the installed file to be overwritten. The default is to have this
68:There are no bugs. Any resemblance thereof is delirium. Really.
-.-.
The name of a man page is typeset in bold and the section in roman
(see man-pages(7)).
12:snippet sourced by ucf(1) and ucfr(1). It can contain any shell directive
(just
-.-.
Split a punctuation from a single argument, if a two-font macro is meant.
53:.I ${filename}.md5sum,
64:.I /etc/ucf.conf,
-.-.
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.
1:.TH UCF.CONF 5 "Dec 31 2024" "Debian" "Debian GNU/Linux manual"
7:.SH "DESCRIPTION"
-.-.
Trailing space in a macro call.
Remove with "sed -i -e 's/ *$//'"
20:.I /etc/ucf.conf.
55:.I ${filename}.md5sum.d/
-.-.
Section headings (.SH and .SS) do not need quoting.
7:.SH "DESCRIPTION"
25:.SH "Configuration File options"
65:.SH "SEE ALSO"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:8: warning: trailing space in the line
an.tmac:<stdin>:11: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
troff:<stdin>:19: warning: trailing space in the line
troff:<stdin>:31: warning: trailing space in the line
troff:<stdin>:54: warning: trailing space in the line
troff:<stdin>:63: warning: trailing space in the line
--- ucf.conf.5 2025-02-17 08:55:14.114773502 +0000
+++ ucf.conf.5.new 2025-02-17 09:06:42.795452927 +0000
@@ -1,71 +1,87 @@
-.TH UCF.CONF 5 "Dec 31 2024" "Debian" "Debian GNU/Linux manual"
+.TH UCF.CONF 5 "Dec 31 2024" Debian "Debian GNU/Linux manual"
.SH NAME
ucf.conf \- site\-wide configuration file for
.B ucf
.SH SYNOPSIS
.I /etc/ucf.conf
-.SH "DESCRIPTION"
-The file
+.SH DESCRIPTION
+The file
.I /etc/ucf.conf
is a
-.BR "POSIX Shell"
-snippet sourced by ucf(1) and ucfr(1). It can contain any shell directive (just
-ensure you know what you are doing).
+.B POSIX Shell
+snippet sourced by
+.BR ucf (1)
+and
+.BR ucfr (1).
+It can contain any shell directive
+(just ensure you know what you are doing).
.PP
-All the variables have reasonable default values, but they be
-overridden on a site\-wide or per\-run basis.
+All the variables have reasonable default values,
+but they be overridden on a site\-wide or per\-run basis.
.TP 3
a)
-Some variables can be set in the config file
-.I /etc/ucf.conf.
+Some variables can be set in the config file
+.IR /etc/ucf.conf .
These values override the defaults.
.IP b)
Some variables can also be set by setting a corresponding environment
-variable. These values take precedence over the config file.
-.SH "Configuration File options"
-At the moment, the user modifiable variables supported are:
+variable.
+These values take precedence over the config file.
+.SH Configuration File options
+At the moment,
+the user modifiable variables supported are:
.TP 18
.B DEBUG
-Debugging information: The default value is 0 (no debugging
-information is printed). To enable debugging output, set the value to
-1.
+Debugging information:
+The default value is 0
+(no debugging information is printed).
+To enable debugging output,
+set the value to
+1.
.TP
.B VERBOSE
-Verbosity: The default value is 0 (quiet). To change the default
-behavior, set the value to 1.
+Verbosity:
+The default value is 0 (quiet).
+To change the default behavior,
+set the value to 1.
.TP
.B conf_force_conffold
-Force the installed file to be retained. The default is to have this
-variable unset, which makes the script ask in case of doubt. This can
-also be overridden by the environment variable
+Force the installed file to be retained.
+The default is to have this variable unset,
+which makes the script ask in case of doubt.
+This can also be overridden by the environment variable
.B UCF_FORCE_CONFFOLD
.TP
.B conf_force_conffnew
-Force the installed file to be overwritten. The default is to have this
-variable unset, which makes the script ask in case of doubt. This can
-also be overridden by the environment variable
+Force the installed file to be overwritten.
+The default is to have this variable unset,
+which makes the script ask in case of doubt.
+This can also be overridden by the environment variable
.B UCF_FORCE_CONFFNEW
.TP
.B conf_source_dir
This is the directory where the historical md5sums for a file are
-looked for. Specifically, the historical md5sums are looked for in
-either the file
-.I ${filename}.md5sum,
-or the subdirectory
-.I ${filename}.md5sum.d/
+looked for.
+Specifically,
+the historical md5sums are looked for in either the file
+.IR ${filename}.md5sum ,
+or the subdirectory
+.I ${filename}.md5sum.d/
.TP
.B conf_old_mdsum_file
-Force the historical md5sums to be read from this file, rather than
-defaulting to living in the source directory. Setting this option
-overrides settings in the environment variable
+Force the historical md5sums to be read from this file,
+rather than defaulting to living in the source directory.
+Setting this option overrides settings in the environment variable
.B UCF_OLD_MDSUM_FILE
.SH Files
-System\-wide defaults are placed in
-.I /etc/ucf.conf,
-.SH "SEE ALSO"
+System\-wide defaults are placed in
+.IR /etc/ucf.conf ,
+.SH SEE ALSO
.BR ucf (1), ucfr (1)
.SH BUGS
-There are no bugs. Any resemblance thereof is delirium. Really.
+There are no bugs.
+Any resemblance thereof is delirium.
+Really.
.SH AUTHOR
This manual page was written by Manoj Srivastava <sriva...@debian.org>,
for the Debian GNU/Linux system.
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)
-.-
