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

Bug#1099134: marked as done (update-texmf.8: Some remarks and a patch with editorial changes for this man page)

Your message dated Fri, 28 Feb 2025 22:51:50 +0000
with message-id <E1to9Cw-001Hiq-T0@fasolo.debian.org>
and subject line Bug#1088249: fixed in tex-common 6.19
has caused the Debian Bug report #1088249,
regarding update-texmf.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.)


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

an.tmac:<stdin>:1: style: .TH missing third argument; consider document modification date in ISO 8601 format (YYYY-MM-DD)
an.tmac:<stdin>:1: style: .TH missing fourth argument; consider package/project name and version (e.g., "groff 1.23.0")
an.tmac:<stdin>:12: misuse, warning: .BR is for at least 2 arguments, got 1
	Use macro '.B' for one argument or split argument.
troff:<stdin>:18: warning: trailing space in the line
troff:<stdin>:21: warning: trailing space in the line
troff:<stdin>:30: 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 tex-common depends on:
ii  ucf  3.0050

tex-common recommends no packages.

Versions of packages tex-common suggests:
pn  debhelper  <none>

Versions of packages texlive-base depends on:
ii  debconf [debconf-2.0]  1.5.89
ii  libpaper-utils         2.2.5-0.3+b1
ii  sensible-utils         0.0.24
ii  texlive-binaries       2024.20240313.70630+ds-5+b1
ii  ucf                    3.0050
ii  xdg-utils              1.2.1-2

Versions of packages texlive-base recommends:
ii  lmodern  2.005-1

Versions of packages texlive-base suggests:
ii  ghostscript [postscript-viewer]  10.04.0~dfsg-2+b1
ii  gv [postscript-viewer]           1:3.7.4-2+b2
ii  mupdf [pdf-viewer]               1.25.1+ds1-5+b2
pn  perl-tk                          <none>
ii  xpdf [pdf-viewer]                3.04+git20250103-1+b1
pn  xzdec                            <none>

Versions of packages texlive-binaries depends on:
ii  libc6            2.40-7
ii  libcairo2        1.18.2-2
ii  libfontconfig1   2.15.0-2
ii  libfreetype6     2.13.3+dfsg-1
ii  libgcc-s1        14.2.0-16
ii  libgraphite2-3   1.3.14-2+b1
ii  libharfbuzz0b    10.2.0-1
ii  libicu72         72.1-6
ii  libkpathsea6     2024.20240313.70630+ds-5+b1
ii  libmpfi0         1.5.4+ds-4
ii  libmpfr6         4.2.1-1+b2
ii  libpaper2        2.2.5-0.3+b1
ii  libpixman-1-0    0.44.0-3
ii  libpng16-16t64   1.6.47-1
ii  libpotrace0      1.16-2+b2
ii  libptexenc1      2024.20240313.70630+ds-5+b1
ii  libstdc++6       14.2.0-16
ii  libsynctex2      2024.20240313.70630+ds-5+b1
ii  libteckit0       2.5.12+ds1-1+b1
ii  libtexlua53-5    2024.20240313.70630+ds-5+b1
ii  libx11-6         2:1.8.10-2
ii  libxaw7          2:1.0.16-1
ii  libxi6           2:1.8.2-1
ii  libxmu6          2:1.1.3-3+b4
ii  libxpm4          1:3.5.17-1+b3
ii  libxt6t64        1:1.2.1-1.2+b2
ii  libzzip-0-13t64  0.13.72+dfsg.1-1.2+b1
ii  perl             5.40.1-2
ii  t1utils          1.41-4
ii  zlib1g           1:1.3.dfsg+really1.3.1-1+b1

Versions of packages texlive-binaries recommends:
pn  dvisvgm       <none>
ii  texlive-base  2024.20250114-1

Versions of packages texlive-binaries suggests:
pn  hintview               <none>
pn  texlive-binaries-sse2  <none>

-- debconf information excluded

Input file is update-texmf.8

Output from "mandoc -T lint  update-texmf.8": (shortened list)


      1 missing date, using "": TH
      1 skipping paragraph macro: PP after SH
      1 skipping paragraph macro: PP empty
      1 skipping paragraph macro: br at the end of SH
      3 whitespace at end of input line


Remove trailing space with: sed -e 's/  *$//'

-.-.

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


      1 	Use macro '.B' for one argument or split argument.
      1 .BR is for at least 2 arguments, got 1
      3 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

3

-.-.

Change two HYPHEN-MINUSES (code 0x2D) to an em-dash (\(em),
if one is intended.
  " \(em " creates a too big gap in the text (in "troff").

An en-dash is usually surrounded by a space,
while an em-dash is used without spaces.
"man" (1 byte characters in input) transforms an en-dash (\(en) to one
HYPHEN-MINUS,
and an em-dash to two HYPHEN-MINUSES without considering the space
around it.
If "--" are two single "-"
(begin of an option or end of options)
then use "\-\-".

update-texmf.8:25:.B \-v, --verbose
update-texmf.8:28:.B \-d, --debug
update-texmf.8:30:--verbose. 
update-texmf.8:32:.B \-o, --output FILE

-.-.

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"

29:Show debugging information, and don't delete temporary files. Implies
30:--verbose. 

-.-.

Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".

Not considered in a patch, too many lines.

update-texmf.8:41:for the Debian GNU/Linux system (but may be used by others).

-.-.

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

an.tmac:<stdin>:1: style: .TH missing third argument; consider document modification date in ISO 8601 format (YYYY-MM-DD)
an.tmac:<stdin>:1: style: .TH missing fourth argument; consider package/project name and version (e.g., "groff 1.23.0")
an.tmac:<stdin>:12: misuse, warning: .BR is for at least 2 arguments, got 1
	Use macro '.B' for one argument or split argument.
troff:<stdin>:18: warning: trailing space in the line
troff:<stdin>:21: warning: trailing space in the line
troff:<stdin>:30: warning: trailing space in the line

-.-.

Generally:

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

--- update-texmf.8	2025-02-28 18:24:48.130979098 +0000
+++ update-texmf.8.new	2025-02-28 18:24:41.163236635 +0000
@@ -5,37 +5,37 @@
 update-texmf \- shell script to generate /etc/texmf/texmf.cnf
 .SH SYNOPSIS
 .B update-texmf
-.I "[options]"
-.br
+.RI [ options ]
 .SH DESCRIPTION
 This manual page documents briefly the
-.BR update-texmf
+.B update-texmf
 command.
 This manual page was written for the Debian GNU/Linux distribution
 because the original script was designed for Debian packaging system.
 .PP
 .B update-texmf
-is a shell script to generate /etc/texmf/web2c/texmf.cnf from files in 
+is a shell script to generate /etc/texmf/web2c/texmf.cnf from files in
 /etc/texmf/texmf.d/*.cnf
 .PP
-A user who wants to customize /etc/texmf/web2c/texmf.cnf should add, 
-for example, 22mymacro.cnf in /etc/texmf/texmf.d/ and run 'update-texmf'.
+A user who wants to customize /etc/texmf/web2c/texmf.cnf should add,
+for example,
+22mymacro.cnf in /etc/texmf/texmf.d/ and run 'update-texmf'.
 .SH OPTIONS
 .TP
-.B \-v, --verbose
+.B \-v, \-\-verbose
 Show verbose messages.
 .TP
-.B \-d, --debug
-Show debugging information, and don't delete temporary files. Implies
---verbose. 
+.B \-d, \-\-debug
+Show debugging information,
+and don't delete temporary files.
+Implies \-\-verbose.
 .TP
-.B \-o, --output FILE
+.B \-o, \-\-output FILE
 Generate output in FILE instead of /etc/texmf/web2c/texmf.cnf.
 .SH SEE ALSO
-.PP
 Further information can be found in
 /usr/share/doc/tex-common/README.Debian.{txt,pdf.html}
-.PP
 .SH AUTHOR
 This manual page was written by Atsuhito Kohda <kohda@debian.org>,
-for the Debian GNU/Linux system (but may be used by others).
+for the Debian GNU/Linux system
+(but may be used by others).

  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: tex-common
Source-Version: 6.19
Done: Hilmar Preuße <hille42@debian.org>

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

Debian distribution maintenance software
pp.
Hilmar Preuße <hille42@debian.org> (supplier of updated tex-common 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: Fri, 28 Feb 2025 23:18:19 +0100
Source: tex-common
Architecture: source
Version: 6.19
Distribution: unstable
Urgency: medium
Maintainer: Debian TeX Task Force <debian-tex-maint@lists.debian.org>
Changed-By: Hilmar Preuße <hille42@debian.org>
Closes: 1088249 1088253 1099137
Changes:
 tex-common (6.19) unstable; urgency=medium
 .
   [ Debian Janitor ]
   * Remove constraints unnecessary since buster (oldstable):
     + tex-common: Drop versioned constraint on cm-super-minimal, ko.tex-base,
       ko.tex-extra, latex-cjk-chinese, latex-cjk-chinese-arphic-bkai00mp,
       latex-cjk-chinese-arphic-bsmi00lp, latex-cjk-chinese-arphic-gbsn00lp,
       latex-cjk-chinese-arphic-gkai00mp, latex-cjk-thai,
       latex-fonts-sipa-arundina, scalable-cyrfonts-tex and texlive-binaries in
       Breaks.
 .
   * Add patches from Bjarni Ingi Gislason <bjarniig@simnet.is> for
     - update-tl-stacked-conffile.8 (Closes: #1088253)
     - update-texmf.8 (Closes: #1088249)
     - update-texmf-config.8 (Closes: #1099137)
Checksums-Sha1:
 4dc85bfc64e51611903e25a12954ed99a4f7e73a 1819 tex-common_6.19.dsc
 09a32aa2f22c8913896b0c5bd125ae2aec8b7bb0 42172 tex-common_6.19.tar.xz
 483bedc032333b3d3443365ea37d103795ab849e 5888 tex-common_6.19_source.buildinfo
Checksums-Sha256:
 b81775c3fe55685893860db00d6a8d1df9ab78b2277e7ff451a2f52cff422e67 1819 tex-common_6.19.dsc
 df77c8170840ecec0fe559c11b41d6e6059a4983f1f6622cd478411e76d7034f 42172 tex-common_6.19.tar.xz
 aebd3443fd6111b26054cf250971c7154c84d46b823f9c83bd5318a5a039dad4 5888 tex-common_6.19_source.buildinfo
Files:
 63df2812739b31f71160e91319a8fcf0 1819 tex optional tex-common_6.19.dsc
 312feff0b0ca4fd40887b51289fb9a98 42172 tex optional tex-common_6.19.tar.xz
 f7f0ce66d8911620ed94f86044892983 5888 tex optional tex-common_6.19_source.buildinfo

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

iQKTBAEBCgB9FiEEaXGmC/nkbIhxf16kxiZYRqvgLIsFAmfCNmVfFIAAAAAALgAo
aXNzdWVyLWZwckBub3RhdGlvbnMub3BlbnBncC5maWZ0aGhvcnNlbWFuLm5ldDY5
NzFBNjBCRjlFNDZDODg3MTdGNUVBNEM2MjY1ODQ2QUJFMDJDOEIACgkQxiZYRqvg
LIvxZA//WQMxYbcD3TEgodstTM+T8ZIM3i/TNGcvayr6gF7Ce7FQSdCEaC5Nu7j8
1jDAV+1MJpDZWgsQX/mKbp+nLmfyGg/sdVsgw679UG/hhBLNhuH0umDu3j8JwZQ5
oYxdLSaCV6la26yp5RP+o9W/Pv2mRe7Qq1epgS9VoCdIQ22ERpKD/y9KizAZJJld
DCDWGZodUu06gC2UKTN5U1vNCO7X6m1MckvF/cxUIbFEz76fhXyEkzK+k8W1ZhgQ
3TaKJI5FewV3Cau3HfhTqHJ1oHeIF29O7Q7MyD84iLzm1cM02DFkSWoni+eS1OyA
YnOzHMOklqp5ygCS5dXQlQxspRSU2nX3kSiGKlyKz/XDaj3kAlZhupS3UIqHmAME
wyP/PVIGnpMBqbTN7kiFGMjukIte9aKns7k3LNbzbM0iLiiCekWeKdHWg/0TGlpz
fJpzxD+aNcIYJnjjC06lhfBjsihzqnnkiAZfgPVHph3PRkllpdvG1Duxj3QfHi+2
2mh3egMZyeRHgRtMD3NCu2GZI+Xj19LqFRI8rfnKQcWs4pT2v4Y/6eWJtCbLI8NJ
EuDpUyT3tSHxsiuTvG9jqnGUyXXVYUWsKC7yyMF1Z5nLtkkKl7J7s0BWzvyUq0nG
tkvaiOOlhdde6V4xSOhbNCWC6OfuwskQ/JaNb1pikeH9XEVtXNo=
=FUcZ
-----END PGP SIGNATURE-----

Attachment: pgpe8gaf3dwVl.pgp
Description: PGP signature


--- End Message ---
Reply to: