--- Begin Message ---
Package: ucf
Version: 3.0043+nmu1
Severity: minor
Tags: patch
Dear Maintainer,
* What led up to the situation?
Checking for defects with
[test-][g|n]roff -mandoc -t -K utf8 -ww -b -z <man page>
[test-groff is a script in the repository for "groff"]
* What was the outcome of this action?
troff: backtrace: file '<stdin>':193
troff:<stdin>:193: warning: macro 'C`' not defined
troff: backtrace: file '<stdin>':193
troff:<stdin>:193: warning: macro 'C'' not defined
troff: backtrace: file '<stdin>':219
troff:<stdin>:219: warning: trailing space in the line
* What outcome did you expect instead?
No output (warnings).
-.-
Remarks and a patch are in the attachments.
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.7.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.86
ii sensible-utils 0.0.22
ucf recommends no packages.
ucf suggests no packages.
-- debconf information excluded
Any program (person), that produces man pages, should check its content for
defects by using
groff -mandoc -t -ww -b -z [ -K utf8 | k ] <man page>
The same goes for man pages that are used as an input.
For a style guide use
mandoc -T lint
-.-
So any generator should check its products with the above mentioned
'groff' and additionally with 'nroff ...'.
This is just a simple quality control measure.
The generator may have to be corrected to get a better man page,
the source file may, and any additional file may.
-.-
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
"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | 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 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 -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-.
Output from "mandoc -T lint ucfq.1": (possibly shortened list)
mandoc: ucfq.1:1:52: STYLE: whitespace at end of input line
mandoc: ucfq.1:2:15: STYLE: whitespace at end of input line
mandoc: ucfq.1:3:90: STYLE: whitespace at end of input line
mandoc: ucfq.1:11:23: STYLE: whitespace at end of input line
mandoc: ucfq.1:12:23: STYLE: whitespace at end of input line
mandoc: ucfq.1:13:4: STYLE: whitespace at end of input line
mandoc: ucfq.1:15:4: STYLE: whitespace at end of input line
mandoc: ucfq.1:78:1: WARNING: skipping paragraph macro: br after sp
mandoc: ucfq.1:188:2: WARNING: empty block: RS
mandoc: ucfq.1:197:2: WARNING: empty block: RS
mandoc: ucfq.1:219:49: STYLE: whitespace at end of input line
mandoc: ucfq.1:229:83: STYLE: input text line longer than 80 bytes: but
\s-1WITHOUT\s0 \...
mandoc: ucfq.1:235:89: STYLE: input text line longer than 80 bytes: Foundation,
Inc., 59...
-.-.
Remove space characters at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
1:.\" -*- Mode: Nroff -*-
2:.\" ucfq.1 ---
3:.\" Author : Manoj Srivastava (
sriva...@glaurung.internal.golden-gryphon.com )
11:.\" HISTORY :
12:.\" Description :
13:.\"
15:.\"
219:This script is a part of the Ucf package, and is
-.-.
Change (or include a "FIXME" paragraph about) misused SI (metric)
numeric prefixes (or names) to the binary ones, like Ki (kibi), Mi
(mebi), Gi (gibi), or Ti (tebi), if indicated.
If the metric prefixes are correct, add the definitions or an
explanation to avoid misunderstanding.
14:.\" arch-tag: daf13e00-a69c-45f0-80a1-b6f3b8bdb14b
-.-.
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.
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.
N.B
The number of lines affected can be too large to be in the patch.
183:tabular format, but that may be harder for a machine to parse. With
-.-.
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.
ucfq.1: line 229 length 83
but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied
warranty of
ucfq.1: line 230 length 98
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0
\s-1PURPOSE\s0. See the
ucfq.1: line 235 length 88
Foundation, Inc., 59 Temple Place, Suite 330, Boston, \s-1MA\s0 02111\-1307
\s-1USA\s0
-.-.
Do not use "\s0" in a string definition but an absolute number,
as the size of the string could be changed.
Then a situation of "\s+X...\s+Y...\s0...\s0" could emerge.
Type size changes have an effect in "troff", but not in "nroff".
68:.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
-.-.
Add a zero (0) in front of a decimal fraction that begins with a period
(.)
49:.if t .sp .5v
108:. ds #V .8m
109:. ds #F .3m
115:. ds #V .6m
-.-.
Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -K utf8 -t -ww -z -K
utf8":
troff: backtrace: file '<stdin>':193
troff:<stdin>:193: warning: macro 'C`' not defined
troff: backtrace: file '<stdin>':193
troff:<stdin>:193: warning: macro 'C'' not defined
troff: backtrace: file '<stdin>':219
troff:<stdin>:219: warning: trailing space in the line
Bad use of \s0 in a string definition, the string could be resized.
68:.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
--- ucfq.1 2024-05-31 22:55:47.681249147 +0000
+++ ucfq.1.new 2024-05-31 23:28:24.000083484 +0000
@@ -1,6 +1,6 @@
-.\" -*- Mode: Nroff -*-
-.\" ucfq.1 ---
-.\" Author : Manoj Srivastava (
sriva...@glaurung.internal.golden-gryphon.com )
+.\" -*- Mode: Nroff -*-
+.\" ucfq.1 ---
+.\" Author : Manoj Srivastava (
sriva...@glaurung.internal.golden-gryphon.com )
.\" Created On : Sun Apr 16 16:29:21 2006
.\" Created On Node : glaurung.internal.golden-gryphon.com
.\" Last Modified By : Manoj Srivastava
@@ -8,11 +8,11 @@
.\" Last Machine Used: glaurung.internal.golden-gryphon.com
.\" Update Count : 2
.\" Status : Unknown, Use with caution!
-.\" HISTORY :
-.\" Description :
-.\"
+.\" HISTORY :
+.\" Description :
+.\"
.\" arch-tag: daf13e00-a69c-45f0-80a1-b6f3b8bdb14b
-.\"
+.\"
.\" Copyright (c) 2006 Manoj Srivastava <sriva...@debian.org>
.\"
.\" This is free documentation; you can redistribute it and/or
@@ -46,10 +46,10 @@
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
+.if t .sp 0.5v
.if n .sp
..
-.de Vb \" Begin verbatim text
+.de Vb\" Begin verbatim text
.ft CW
.nf
.ne \\$1
@@ -65,7 +65,7 @@
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
-.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s+2\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
@@ -81,6 +81,8 @@
. ds PI \(*p
. ds L" ``
. ds R" ''
+. ds C` \" empty
+. ds C' \" empty
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
@@ -105,14 +107,14 @@
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
-. ds #V .8m
-. ds #F .3m
+. ds #V 0.8m
+. ds #F 0.3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
-. ds #V .6m
+. ds #V 0.6m
. ds #F 0
. ds #[ \&
. ds #] \&
@@ -171,7 +173,7 @@ ucfq \- query the ucf database
\& usage: ucfq [options] (/path/to/file|package)[/path/to/file|package ...]
.Ve
.SH "OPTIONS"
-.IP "\fB\-\-help\fR \fBh\fR Print out a usage message." 3
+.IP "\fB\-\-help\fR \fB\-h\fR Print out a usage message." 3
.PD 0
.IP "\fB\-\-debug\fR \fB\-d\fR Turn on debugging mode." 3
.IP "\fB\-\-verbose\fR \fB\-v\fR Make the script more verbose.." 3
@@ -180,9 +182,11 @@ ucfq \- query the ucf database
.PD
.RS 2
Normally, the script presents the information in a human readable
-tabular format, but that may be harder for a machine to parse. With
-this option, the output is a compact, colon separated line, with no
-dividers, headers, or footer.
+tabular format, but that may be harder for a machine to parse.
+With this option,
+the output is a compact,
+colon separated line,
+with no dividers, headers, or footer.
.RE
.RE
.RS 3
@@ -190,8 +194,8 @@ dividers, headers, or footer.
.IP "\fB\-\-state\-dr\fR dir" 3
.RS 3
.RS 2
-Set the state directory to \f(CW\*(C`/path/to/dir\*(C'\fR instead of the
default
-\&\f(CW\*(C`/var/lib/ucf\*(C'\fR. Used mostly for testing.
+Set the state directory to \f(CR\*(C`/path/to/dir\*(C'\fR instead of the
default
+\&\f(CR\*(C`/var/lib/ucf\*(C'\fR. Used mostly for testing.
.RE
.RE
.RS 3
@@ -216,20 +220,24 @@ None Known so far.
.SH "AUTHOR"
Manoj Srivastava <srivasta\e...@debian.org>
.SH "COPYRIGHT AND LICENSE"
-This script is a part of the Ucf package, and is
+This script is a part of the Ucf package, and is
.PP
Copyright (c) 2006 Manoj Srivastava <srivasta\e...@debian.org>
.PP
This program is free software; you can redistribute it and / or modify
-it under the terms of the \s-1GNU\s0 General Public License as published by
+it under the terms of the \s-1GNU\s+1 General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
-but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied
warranty of
-\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0
\s-1PURPOSE\s0. See the
-\&\s-1GNU\s0 General Public License for more details.
+but \s-1WITHOUT\s+1 \s-1ANY\s+1 \s-1WARRANTY\s+1; without even the implied
+warranty of
+\&\s-1MERCHANTABILITY\s+1 or \s-1FITNESS\s+1 \s-1FOR\s+1 A \s-1PARTICULAR\s+1
+\s-1PURPOSE\s+1.
+See the \s-1GNU\s+1 General Public License for more details.
.PP
-You should have received a copy of the \s-1GNU\s0 General Public License
+You should have received a copy of the \s-1GNU\s+1 General Public License
along with this program; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place, Suite 330, Boston, \s-1MA\s0 02111\-1307
\s-1USA\s0
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, \s-1MA\s+1 02111\-1307
+\s-1USA\s+1
+
--- End Message ---
--- Begin Message ---
Source: ucf
Source-Version: 3.0044
Done: Mark Hindley <lee...@debian.org>
We believe that the bug you reported is fixed in the latest version of
ucf, which is due to be installed in the Debian FTP archive.
A summary of the changes between this version and the previous one is
attached.
Thank you for reporting the bug, which will now be closed. If you
have further comments please address them to 1072...@bugs.debian.org,
and the maintainer will reopen the bug report if appropriate.
Debian distribution maintenance software
pp.
Mark Hindley <lee...@debian.org> (supplier of updated ucf package)
(This message was generated automatically at their request; if you
believe that there is a problem with it please contact the archive
administrators by mailing ftpmas...@ftp-master.debian.org)
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256
Format: 1.8
Date: Tue, 26 Nov 2024 11:07:16 +0000
Source: ucf
Architecture: source
Version: 3.0044
Distribution: unstable
Urgency: medium
Maintainer: Mark Hindley <lee...@debian.org>
Changed-By: Mark Hindley <lee...@debian.org>
Closes: 808277 816220 1019326 1033751 1055746 1063493 1072323 1086847
Changes:
ucf (3.0044) unstable; urgency=medium
.
* Acknowledge NMU from Arnaud Rebillout <arna...@kali.org>, with thanks.
* d/control:
- take over maintenance with thanks to Manoj Srivastava for his
previous work. (Closes: #1086847)
- bump Standards Version (no changes).
- update Vcs URLs.
- add missing Depends: procps, ${perl:Depends}
* d/copyright: update.
* Add initial testsuite (requires unshare(1)).
* Replace setq() with new function vset(), not utilising eval.
* Reduce use of eval to a single instance on the output of getopt(1) in
quoted mode.
* Sanitise environment on startup.
* Use grep BREs, with a common function for escaping. (Closes: #1019326)
* ucf:
- don't print empty lines on stderr. (Closes: #816220)
- fix quoting of variables (shellcheck SC2086). (Closes: #808277)
- separate local declaration and assignment (SC2155).
- rationalise handling of VERBOSE.
- avoid double negative in test.
* ucfr:
- remove unusued code.
- remove obsolete error check, errexit already set.
- silently ignore unused DEBUG.
* Makefile:
- add shellcheck recipe.
- when building, update versions from d/changelog.
* Add Romanian debconf translation.
Thanks to "Remus-Gabriel Chelu" <remusgabriel.ch...@disroot.org>
(Closes: #1033751)
* Updated Swedish debconf translations.
Thanks to Martin Bagge / brother <brot...@persilja.net> (Closes: #1055746)
* Updated Italian debconf translations.
Thanks to Ceppo <ce...@oziosi.org> (Closes: #1063493)
* ucfq.1: groff fixes.
Thanks to Bjarni Ingi Gislason <bjarn...@simnet.is> (Closes: #1072323)
* ucf.conf: is a POSIX, not bourne script fragment.
* Update ./examples to be more recent; partially addresses: #878904.
* Remove unused ucf_helper_functions.sh and examples/ChangeLog.
* Remove obsolete examples/ucf_helper_functions/.
* Cleanup code:
- rewrite syntax undefined in POSIX.
- remove unnecessary trailing ';'.
- move common functions to new ucf_library.sh.
- remove obsolete x"$var" prefix to test expressions.
- remove obsolete header boilerplate.
* Rename obsolete ChangeLog to ChangeLog.old.
* Drop broken lcf and its manpage.
* d/ucf.lintian-overrides: update and remove unused.
Checksums-Sha1:
9cb4ca3fd0e1c0fc3846799a10c5b0d2c513c5e8 1512 ucf_3.0044.dsc
8d70f50aeebdc6bbaca619d9bf09b93b466efb32 71388 ucf_3.0044.tar.xz
9dca6286bcf7223ff55c08a7c22d90900a31a836 6421 ucf_3.0044_amd64.buildinfo
Checksums-Sha256:
d4e45bd7178516b1f1fe806cb61a7490f5cabbd025cd522b20a9a360b5a2cd74 1512
ucf_3.0044.dsc
d41aec41e78c7c24286f6ca2307865d76f8596fc39a506e5ce86fb2065eb3ceb 71388
ucf_3.0044.tar.xz
5fe3ce8b2b307370e3108dcf22998ef4ca799bb4ccd3b967b1e8211417a6c187 6421
ucf_3.0044_amd64.buildinfo
Files:
a167ae60f8415aa5620f86ba9f8dbeeb 1512 utils standard ucf_3.0044.dsc
0fd7d68dfa2b55710f07fac4491ac087 71388 utils standard ucf_3.0044.tar.xz
dd883e2ef0c5d884e3cdc8e865782fa4 6421 utils standard ucf_3.0044_amd64.buildinfo
-----BEGIN PGP SIGNATURE-----
iQIzBAEBCAAdFiEEUGwVpCsK9aCoVCPu0opFvzKH1kkFAmdG4QgACgkQ0opFvzKH
1klmrBAAg72+D7ztLD1Im7q0JUiW4i3eXLkYss/irC8TBe4PIfeOu5/OGKMv4RNG
smgMJXLLVjqDTcutWfwffC4Io+7It+NdZ6HQlw5QzYXITHBfgWIGqZmglOZ24ei5
Dx/foWTcSDVU8+B2UxWPHg26DY11KyM6TnYMn0KXAx1MyVvQrsO+d6gizY9wesp9
7HlCNypS11djUmTSQBSp6oPO2720Tv+cPT96wpx+jcOoBOPNgq9SG6DY1iaAte4s
EKz/5LsZ/3sPOhHUNS86pFRSjQyoLBzO00QlDKpYNcw7MVmGhGSnmD0ypN3Pu+R2
lMXwMGp2e0nMckMk/BgoxM7+nfpmoowUtaC/eeIoL4YU5+ddKoPC+7tryHO0oeUe
4gaJ8lo7n/QuS7pCkDHrQbhyKi1eGItjjWhtSi3d6PCzIBjpUjjHDkl34ZUGcMc9
RM8M0yY0oC7EVWjiF3QBwT99xhoDrS53kYe9HJVRq9U1SCSNBySQ9EIxhnyRXitQ
cQjngu1ym2CsCd1Z33ICTXBHqIKh4kR8l4QitWIKU4I57W8DI1I7uJeezvVICE8B
vSQH354I4t6T6KNlUARUN3JcjgQL5FgaStNO4oEXTsY1ZuzUMUgRegxH87Nzx5iG
wxXAwyzY3V4Wq8hr3tvQZmJmsXJV9Q3CWUWX3M/ZqczFqAnRFtA=
=AAoM
-----END PGP SIGNATURE-----
pgpdX2aYPNZR4.pgp
Description: PGP signature
--- End Message ---
