Your message dated Thu, 03 Apr 2025 20:57:27 +0000
with message-id <[email protected]>
and subject line Bug#1094140: fixed in usbutils 1:018-2
has caused the Debian Bug report #1094140,
regarding usbreset.1: Some remarks and a patch with editorial changes for this
man page
to be marked as done.
This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
Bug report if necessary, and/or fix the problem forthwith.
(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact [email protected]
immediately.)
--
1094140: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1094140
Debian Bug Tracking System
Contact [email protected] with problems
--- Begin Message ---
Package: usbutils
Version: 1:018-1
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 ' $' <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?
an.tmac:<stdin>:19: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:22: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:25: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
* 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.9-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 usbutils depends on:
ii libc6 2.40-5
ii libudev1 257.2-1
ii libusb-1.0-0 2:1.0.27-1+b1
usbutils recommends no packages.
Versions of packages usbutils suggests:
pn usbutils-py <none>
-- no debconf information
Input file is usbreset.1
Output from "mandoc -T lint usbreset.1": (shortened list)
-.-.
Output from "test-groff -mandoc -t -ww -z usbreset.1": (shortened list)
3 Use macro '.B' for one argument or split argument.
3 .BR is for at least 2 arguments, got 1
-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.
19:.BR PPPP:VVVV
22:.BR BBB/DDD
25:.BR "Product"
-.-.
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 "\&".
15:is a utility that performs resets on USB devices. It is particularly useful
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:19: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:22: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:25: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
-.-
Additional
To be fixed:
Example
Reset device with vendor ID 1234 and product ID 5678:
usbreset 1234:5678
Uses "VVVV:PPPP" but "DESRCIPTION" says "PPPP:VVVV".
-.-
Add missing 'for'.
--- usbreset.1 2025-01-24 23:26:52.514319008 +0000
+++ usbreset.1.new 2025-01-24 23:39:55.113678916 +0000
@@ -12,17 +12,18 @@ usbreset \- send a USB port reset to a U
.SH DESCRIPTION
.B usbreset
-is a utility that performs resets on USB devices. It is particularly useful
+is a utility that performs resets on USB devices.
+It is particularly useful for
situations where a USB device is unresponsive or exhibits erratic behavior.
The USB \fIdevice\fP to be reset can be specified in one of three formats:
.TP
-.BR PPPP:VVVV
+.B PPPP:VVVV
Reset by product and vendor IDs
.TP
-.BR BBB/DDD
+.B BBB/DDD
Reset by bus and device number
.TP
-.BR "Product"
+.B "Product"
Reset by product name
.PP
When run without any arguments,
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.
Not beginning each input sentence on a new line.
Line length 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 -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 -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)
-.-
--- End Message ---
--- Begin Message ---
Source: usbutils
Source-Version: 1:018-2
Done: Aurelien Jarno <[email protected]>
We believe that the bug you reported is fixed in the latest version of
usbutils, 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 [email protected],
and the maintainer will reopen the bug report if appropriate.
Debian distribution maintenance software
pp.
Aurelien Jarno <[email protected]> (supplier of updated usbutils 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 [email protected])
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512
Format: 1.8
Date: Thu, 03 Apr 2025 22:06:59 +0200
Source: usbutils
Architecture: source
Version: 1:018-2
Distribution: unstable
Urgency: medium
Maintainer: Aurelien Jarno <[email protected]>
Changed-By: Aurelien Jarno <[email protected]>
Closes: 1094140
Changes:
usbutils (1:018-2) unstable; urgency=medium
.
[ Aurelien Jarno ]
* Rewrite debian/copyright in Machine-readable format
* Add a source lintian overrides file for files in the LICENSES/
directory
* Bump Standards-Version to 4.7.2 (no changes)
* Remove breaks against versions that are older than bullseye
* usbreset: fix swapped vendor and product ID in help/manpage
.
[ Bjarni Ingi Gislason ]
* usbreset.1: fix groff warnings and small fixes (Closes: #1094140)
Checksums-Sha1:
a3fd41d475292d102e24af0fe9004f9fd908e59d 1984 usbutils_018-2.dsc
e440e53df82a7721ce57479ddd6922e9533f3fd8 11816 usbutils_018-2.debian.tar.xz
46ccbd61c9dfb387c682cfdffaf27d8a00a18ba7 6369 usbutils_018-2_source.buildinfo
Checksums-Sha256:
e3dbee958f2ad0eb1dd3577b355cdb4019aa74d20730f3038bb06dba79f41d4e 1984
usbutils_018-2.dsc
18ea417fd3f3d84935b7d81ce1b423ad631de120972b5ade4aa8e0d9beb901d4 11816
usbutils_018-2.debian.tar.xz
7444f96abffe696e59254608f6befaa5d857e1c85e5342a189a5d70c6581c845 6369
usbutils_018-2_source.buildinfo
Files:
c14079981cdffb9dde18e0c57e726710 1984 utils optional usbutils_018-2.dsc
93261bd0fdc9723b3091424bab1d7d3a 11816 utils optional
usbutils_018-2.debian.tar.xz
2c4d5166ca2979fe4484cebea4a4e07e 6369 utils optional
usbutils_018-2_source.buildinfo
-----BEGIN PGP SIGNATURE-----
iQIzBAEBCgAdFiEEUryGlb40+QrX1Ay4E4jA+JnoM2sFAmfu6vYACgkQE4jA+Jno
M2uUYQ/9FHL6jmhZeIjrupLmbXkpwqluNg637kbiukeZLAPvIHeKu0BaN+6USQbC
Hb4LGEe9K+fqvesgqKvx9OIFlxXYwHgfmj1LWrSLO9spNRbpUwpl/PWQN7JIKl6S
JGfTVgmAR8xNg2GL3X4foCfvjjGSsTIfQ4RH3aSP3KK+t+ZAGDa/nPXaCV/4Gop/
/3oQ+uGmHxlPvN2XuT6WbVHyQLq6RcJR7brinh0fD+5rd1D8f/zoi6MsLC1wQj4U
gLca3vi4JLFSpzeVl5VwBQeg7L1ctOb57kXjauHjQc5pA2Ar9JImX++yx9AVZVGT
1nZAaLk4Exk06bdnrfaylXGHwFG93yhpToOS9Moph8GhVb3GaGugD/3ne7cp59qO
17u4eXnCxHs8PAL3EQ5qbNHpMlnngHunQRV6/OUh8KKbjHikCj9zODijqfcAHfFr
NsjaTzcmy8kBwMH6KQqMDol3PVoVawyX5QRya3acNXToe4jgc0ZUHcPhHzBeYkbX
mAGiZgvbKrnvIYDf183YhCQh827lrlXMMEglrTThGm8B1E1KXbEEE8fHd6FRp3k0
KHnp6kbj4ISIgCt/3LUZ0EPhV93fVX6+rzAWHgqVonThOuZmTqJ6X10mRtfYeCZp
jIOmMzG+PpW0DnfqYkUdMi+Bgo99wAEDTM9sWXcmkbM++e33OIg=
=fRwP
-----END PGP SIGNATURE-----
pgppI1AdymBkm.pgp
Description: PGP signature
--- End Message ---
