Your message dated Mon, 13 Jan 2025 19:19:35 +0000
with message-id <e1txpyj-00g2iv...@fasolo.debian.org>
and subject line Bug#1089856: fixed in developers-reference 13.16
has caused the Debian Bug report #1089856,
regarding developers-reference.1: Some remarks and a patch for 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 ow...@bugs.debian.org
immediately.)
--
1089856: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1089856
Debian Bug Tracking System
Contact ow...@bugs.debian.org with problems
--- Begin Message ---
Package: developers-reference
Version: 13.15
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 -ww -z < "man page"
[Use "groff -e ' $' <file>" to find 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>:17: 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.11.10-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)
developers-reference depends on no packages.
Versions of packages developers-reference recommends:
ii debian-policy 4.7.0.1
ii libjs-jquery 3.6.1+dfsg+~3.5.14-1
ii libjs-sphinxdoc 7.4.7-4
ii sensible-utils 0.0.24
ii sphinx-rtd-theme-common 3.0.2+dfsg-1
Versions of packages developers-reference suggests:
ii doc-base 0.11.2
ii firefox-esr [www-browser] 128.5.0esr-1
ii lynx [www-browser] 2.9.2-1
ii w3m [www-browser] 0.5.3+git20230121-2+b3
-- no debconf information
Input file is developers-reference.1
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
-.-
So any 'generator' should check its products with the above mentioned
'groff', 'mandoc', 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.
Common defects:
Input text line longer than 80 bytes.
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.
Lines should thus be shorter.
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 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 -b -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-.
Output from "mandoc -T lint developers-reference.1": (shortened list)
1 skipping paragraph macro
1 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z developers-reference.1": (shortened
list)
1 trailing space in the line
-.-.
Output from "mandoc -T lint developers-reference.1":
mandoc: developers-reference.1:5:2: WARNING: skipping paragraph macro: br after
SH
mandoc: developers-reference.1:17:31: STYLE: whitespace at end of input line
-.-.
Remove space characters at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
17:Osamu Aoki (os...@debian.org).
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:17: warning: trailing space in the line
-.-
Additional:
Add enougth place for the "BROWSER" item.
--- developers-reference.1 2024-12-14 06:44:24.221677419 +0000
+++ developers-reference.1.new 2024-12-14 07:01:56.872612965 +0000
@@ -2,19 +2,20 @@
.SH NAME
developers-reference \- guidelines and information for Debian developers
.SH SYNOPSIS
-.br
.B developers-reference
.SH DESCRIPTION
-This is a small script that starts your favorite browser and displays
-the index page
+This is a small script
+that starts your favorite browser
+and displays the index page
.I file:///usr/share/developers-reference/index.html
of the developers-reference package.
.SH ENVIRONMENT
-.IP BROWSER
+.nr width \w'BROWSER '
+.IP BROWSER \n[width]u
The browser used to display the HTML files.
.SH AUTHOR
-Osamu Aoki (os...@debian.org).
+Osamu Aoki (os...@debian.org).
.PP
This document may be used under the terms of the GNU General Public
License version 2 or higher.
--- End Message ---
--- Begin Message ---
Source: developers-reference
Source-Version: 13.16
Done: Holger Levsen <hol...@debian.org>
We believe that the bug you reported is fixed in the latest version of
developers-reference, 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 1089...@bugs.debian.org,
and the maintainer will reopen the bug report if appropriate.
Debian distribution maintenance software
pp.
Holger Levsen <hol...@debian.org> (supplier of updated developers-reference
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: SHA512
Format: 1.8
Date: Mon, 13 Jan 2025 18:52:48 +0100
Source: developers-reference
Architecture: source
Version: 13.16
Distribution: unstable
Urgency: medium
Maintainer: Developers Reference Maintainers <debian-policy@lists.debian.org>
Changed-By: Holger Levsen <hol...@debian.org>
Closes: 1089856
Changes:
developers-reference (13.16) unstable; urgency=medium
.
[ Bjarni Ingi Gislason ]
* developers-reference.1: patch for editorial changes. Closes: #1089856.
.
[ Dorle Osterode ]
* (de) developer-duties.po: small fixes.
.
[ Holger Levsen ]
* d/copyright and index.rst: bump my copyright years.
Checksums-Sha1:
d9b6a34b4c5082e97732b1514902ee032bd203d7 2527 developers-reference_13.16.dsc
7a105196d3ebe03711694d5d89ed436790dc02b3 575820
developers-reference_13.16.tar.xz
2f5d8304ac1545ceb841beeb659e027fdf6dd642 7065
developers-reference_13.16_source.buildinfo
Checksums-Sha256:
0e6987372b1ca07089272ba0f4e576b0d67c79165a36353a39b1f981545baa01 2527
developers-reference_13.16.dsc
018a5d03ec7213db0d24e1d1b155b7005c53ba42cc736069c24d060222c5d755 575820
developers-reference_13.16.tar.xz
0c075bf5ab52dbb3afa610187cdb89ac9b922c3d01328cf568fa35794404329f 7065
developers-reference_13.16_source.buildinfo
Files:
6c4d5329186f6121a941583d1272fa01 2527 doc optional
developers-reference_13.16.dsc
6ba47da66c8cc9f7783e88e3f80cc4ad 575820 doc optional
developers-reference_13.16.tar.xz
067dccf5cf24e3293c08f5e89cf9afb3 7065 doc optional
developers-reference_13.16_source.buildinfo
-----BEGIN PGP SIGNATURE-----
iQIzBAEBCgAdFiEEuL9UE3sJ01zwJv6dCRq4VgaaqhwFAmeFZOUACgkQCRq4Vgaa
qhzmvg//cQrHuMQp1lizv+1YeX2tJQJlRzruy+Pj8yNK/bVLEIh+wqXqJgj8r1UY
UwgHcl0YXcVKkTzApEuxtqjfSt5exShETD+nESu4g3ciM60/VDMcc5hifjw1/JXg
KdYkxbvm93ZGfAm282HHttMAipfJAyauVaQX/l4hPZFfOEJ9i5vCdyvccH3hl+Uk
OiRPtul1MDCsBzYhW4nsmPDqcf3AH1+Urlou1Op4ehEZVS18cnytABUG2jeXxr1G
f6c7Oml1aFRrfrpb576VOLV4tLXSMaHo1XoMIC+joZ68WbT3e7yzdtabQMti3jSV
Kt0m8AinsJfu+BbfHd7mZjYuY68a1T/BGCK0L+AkN5DtHtX/au36DHQg7SEfIvTL
OVxBWlss2h0ROgoLAdg2QyC+VBz5Wb5qnpvlqoP03anBZyBjU1Md3pxkv+dV/w50
zvVi5a0Re20DXRhz0DfL0e7b8gJ0Xone0BMJ/ka0FHPC0feiJiAoai+FKrEp2C+n
gatVQNVrr7TLQ3SnGKljqC/3t4zZN9+Hm3rJSYBfZV6r7QGfAmjl38klj7HzLJoz
FqcTy4myCPcErPbvlexU9hAqKn0ksAeoy688o/UDMPUSltHYYAlckqwYRbfJjICG
fY0pc9DL2jD5o5e5X7xkxE2ClZfZlDQwr0uVwjjHrHcN+4sHtYs=
=DdX8
-----END PGP SIGNATURE-----
pgpLDm8eK_MA7.pgp
Description: PGP signature
--- End Message ---
