[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#1098939: marked as done (popularity-contest.8: Some remarks and a patch with editorial changes for this man page)

Your message dated Thu, 27 Feb 2025 15:51:36 +0000
with message-id <E1tngAi-002WCT-VG@fasolo.debian.org>
and subject line Bug#1098939: fixed in popularity-contest 1.78
has caused the Debian Bug report #1098939,
regarding popularity-contest.8: 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 owner@bugs.debian.org
immediately.)


-- 
1098939: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1098939
Debian Bug Tracking System
Contact owner@bugs.debian.org with problems
--- Begin Message --- 
Package: popularity-contest
Version: 1.77
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?


Output from "test-groff  -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":

an.tmac:<stdin>:35: misuse, warning: .BR is for at least 2 arguments, got 1
	Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:40: 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.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 popularity-contest depends on:
ii  debconf [debconf-2.0]  1.5.89
ii  dpkg                   1.22.15

Versions of packages popularity-contest recommends:
ii  cron [cron-daemon]                         3.0pl1-192
ii  exim4-daemon-light [mail-transport-agent]  4.98-3+b1
ii  gpg                                        2.2.46-1+b1

Versions of packages popularity-contest suggests:
ii  anacron   2.3-41
pn  tor       <none>
pn  torsocks  <none>

-- debconf information excluded

Input file is popularity-contest.8

Output from "mandoc -T lint  popularity-contest.8": (shortened list)


-.-.

Output from "test-groff -mandoc -t -ww -z popularity-contest.8": (shortened list)


      2 	Use macro '.B' for one argument or split argument.
      2 .BR is for at least 2 arguments, got 1

-.-.

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.

Split (sometimes) lines after a punctuation mark; before a conjunction.

N.B.

  The number of lines affected can be too large to be in a patch.

  Lines with only one (or two) space(s) between sentences could be split,
so latter sentences begin on a new line.

Use

#!/usr/bin/sh

sed -e '/^\./n' \
-e 's/\([[:alpha:]]\)\.  */\1.\n/g' $1

to split lines after a sentence period.
Check result with the difference between the formatted outputs.
See also the attachment "general.bugs"

21:installed and never used.  This helps Debian maintainers make decisions such

-.-.

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.

4:.TH "POPULARITY-CONTEST" "8" "November 2001" "Debian/GNU Linux" ""
5:.SH "NAME"
7:.SH "SYNOPSIS"
9:.SH "DESCRIPTION"
46:.SH "AUTHOR"

-.-.

Output from "test-groff  -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":

an.tmac:<stdin>:35: misuse, warning: .BR is for at least 2 arguments, got 1
	Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:40: misuse, warning: .BR is for at least 2 arguments, got 1
	Use macro '.B' for one argument or split argument.

-.-.

Generally:

Split (sometimes) lines after a punctuation mark; before a conjunction.

--- popularity-contest.8	2025-02-26 09:06:32.712549050 +0000
+++ popularity-contest.8.new	2025-02-26 09:10:52.914386935 +0000
@@ -1,12 +1,12 @@
 .\" Hey, Emacs!  This is an -*- nroff -*- source file.
 .\"
 .\"
-.TH "POPULARITY-CONTEST" "8" "November 2001" "Debian/GNU Linux" ""
-.SH "NAME"
+.TH POPULARITY-CONTEST 8 "November 2001" "Debian/GNU Linux" ""
+.SH NAME
 popularity\-contest \- list the most popular Debian packages
-.SH "SYNOPSIS"
+.SH SYNOPSIS
 .B popularity\-contest
-.SH "DESCRIPTION"
+.SH DESCRIPTION
 The
 .B popularity\-contest
 command gathers information about Debian packages installed on the system,
@@ -18,8 +18,9 @@ When aggregated with the output of
 .B popularity\-contest
 from many other systems, this information is valuable because it can be used
 to determine which Debian packages are commonly installed, used, or
-installed and never used.  This helps Debian maintainers make decisions such
-as  which packages should be installed by default on new systems.
+installed and never used.
+This helps Debian maintainers make decisions such
+as which packages should be installed by default on new systems.
 .PP
 The resulting statistic is available from the project home page
 .BR https://popcon.debian.org/ .
@@ -32,16 +33,16 @@ job,
 .BR /etc/cron.daily/popularity\-contest ,
 which automatically submits the results to Debian package maintainers
 (only once a week) according to the settings in
-.BR /etc/popularity\-contest.conf
+.B /etc/popularity\-contest.conf
 and
 .BR /usr/share/popularity-contest/default.conf .
 .SH "SEE ALSO"
 The popularity\-contest FAQ at
-.BR /usr/share/doc/popularity\-contest/FAQ
+.B /usr/share/doc/popularity\-contest/FAQ
 .BR popcon\-largest\-unused (8),
 .BR cron (8)
 .LP
 Additional documentation is in
 .BR /usr/share/doc/popularity\-contest/ .
-.SH "AUTHOR"
+.SH AUTHOR
 Avery Pennarun <apenwarr@debian.org>.

  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)

-.-

--- End Message ---
--- Begin Message --- 
Source: popularity-contest
Source-Version: 1.78
Done: Bill Allombert <ballombe@debian.org>

We believe that the bug you reported is fixed in the latest version of
popularity-contest, 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 1098939@bugs.debian.org,
and the maintainer will reopen the bug report if appropriate.

Debian distribution maintenance software
pp.
Bill Allombert <ballombe@debian.org> (supplier of updated popularity-contest 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 ftpmaster@ftp-master.debian.org)


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

Format: 1.8
Date: Thu, 27 Feb 2025 15:50:46 +0100
Source: popularity-contest
Architecture: source
Version: 1.78
Distribution: unstable
Urgency: medium
Maintainer: Popularity Contest Developers <debian-popcon@lists.debian.org>
Changed-By: Bill Allombert <ballombe@debian.org>
Closes: 1085020 1098939
Changes:
 popularity-contest (1.78) unstable; urgency=medium
 .
   * README: update to note that linuxcounter is dead.
   * debian-popcon.gpg: use new submission key.
   * debian/control:
     - Updated Standards-Version from 4.6.1 to 4.7.1.  No change needed.
     - Set Rules-Requires-Root: no
   * debian/cron.daily:
     - Remove /var/log/popularity-contest.$$ when submission fail.
       Closes: #1085020.
   * debian/popularity-contest.8:
     - Apply clean up patch from Bjarni Ingi Gislason. Closes: #1098939.
Checksums-Sha1:
 7359d216c84733e864712cd91f574704a0a316c0 1731 popularity-contest_1.78.dsc
 f3fb8802000352fa52597613a8181e19e39c102b 79888 popularity-contest_1.78.tar.xz
 fe3062f73aea26e71d6cbffd0a073b21696161ab 5563 popularity-contest_1.78_source.buildinfo
Checksums-Sha256:
 7711ddc5686ca1904c27d4daf52e6be23989c300eab6cf994b5a39e39f13d885 1731 popularity-contest_1.78.dsc
 b81c1601c0130ebd3e281ead0320db9d0d529682027003ec082aaecc6810845a 79888 popularity-contest_1.78.tar.xz
 784f15a481f2485e7d4b326443fffeae5f29f0564a8cbe9e645962c7a61050f8 5563 popularity-contest_1.78_source.buildinfo
Files:
 4e514abc3e137baf387655fafd45150e 1731 misc optional popularity-contest_1.78.dsc
 d5a4dbbfc387974cd9b0aec1e8fa4f7b 79888 misc optional popularity-contest_1.78.tar.xz
 a35140941b176cce8c38ae4ab38d6bf2 5563 misc optional popularity-contest_1.78_source.buildinfo

-----BEGIN PGP SIGNATURE-----

iQIzBAEBCgAdFiEEQgKOpASi6dgKxFMUjw58K0Ui44cFAmfAg1AACgkQjw58K0Ui
44fXVQ//bGrM+dgo8zQWTO5B25gbgb3Fe91NRxz/JHGrbw+rAGKkJuA71anm8Smj
xk8haOPFGVTMO0nTfIiEVDCrpoWhY0RZPjXE/6hem0oQxb8aNity0N8w3E6/Tclu
CtBCO0yf7pwMGhZoZrZhxv32AxZS21b6MGyKuBjeUJKL6IWbD4uE7qEAcH7tG9ji
zi4JxmlakKnGDDWxereqZtD/FEJ02BBqF3Kx1Hr/zHPHVxKPsQWldpy7hc7axIHW
aGoAqlKRcbgBj919F6JUbh6nCt2Mm2LNVkMCLERePri6DYURKvTVMzjwDLlUeeH5
0A9UzDJnt+a9li+Rw1eOAAmqGqImkd034e5wgSyZUAhCZ8m15xL+EIn4v+90qkPt
JZ+R9CcgQCX162ha/GYgd4Ul4k4152kJiHe54NZ4ok8ISxjCJ0dyyrV4s9TAMQVk
PCXF4ybJueveOhudbIimLQ4WFM/EIuFdkXN2+jTq8Kh76PQxiup4Ircor/BOQeqv
JkBqOZZdC78VKqcPRw9eHgL/qTW3GvhKTxD71ICK7dsrhTMYzZEUJqHqzKnXHrCH
lLiulpBi63UzhfqMVyxDhzwWuc1RbFiVVQsZ2cWfJ10/UVqGjR9NXoEM/nBeK0q/
om0mB3wscJWpJLQwZ7ecS+BX6dy//aEEW08s3+ZUwEVyPkCF8Hw=
=DkHM
-----END PGP SIGNATURE-----

Attachment: pgpvj6IZVIfhm.pgp
Description: PGP signature


--- End Message ---
Reply to: