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

Bug#1100702: marked as done (linux-update-symlinks.1: Some remarks and a patch with editorial changes for this man page)

Your message dated Sun, 25 May 2025 19:34:34 +0000
with message-id <E1uJH7C-005Mb4-Nz@fasolo.debian.org>
and subject line Bug#1100702: fixed in linux-base 4.12
has caused the Debian Bug report #1100702,
regarding linux-update-symlinks.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 owner@bugs.debian.org
immediately.)


-- 
1100702: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1100702
Debian Bug Tracking System
Contact owner@bugs.debian.org with problems
--- Begin Message --- 
Package: linux-base
Version: 4.11
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 fourth argument; consider package/project name and version (e.g., "groff 1.23.0")
an.tmac:<stdin>:27: style: use of deprecated macro: .PD
an.tmac:<stdin>:36: style: use of deprecated macro: .PD
an.tmac:<stdin>:67: style: use of deprecated macro: .PD
an.tmac:<stdin>:69: misuse, warning: .IR is for at least 2 arguments, got 1
	Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:75: style: use of deprecated macro: .PD


   * 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.17-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 linux-base depends on:
ii  debconf [debconf-2.0]  1.5.89

linux-base recommends no packages.

linux-base suggests no packages.

-- debconf information excluded

Input file is linux-update-symlinks.1

Output from "mandoc -T lint  linux-update-symlinks.1": (shortened list)


-.-.

Output from "test-nroff -mandoc -t -ww -z linux-update-symlinks.1": (shortened list)

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

-.-.

Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.

18:\fBuname -r\fR and used in filenames.

-.-.

Put a subordinate sentence (after a comma) on a new line.


linux-update-symlinks.1:23:By default, this command maintains symlinks in the root directory.
linux-update-symlinks.1:32:If set to a true value, specifies that the directory is \fI/boot\fR
linux-update-symlinks.1:35:If set to a false value, disables maintenance of symlinks
linux-update-symlinks.1:44:If symlink maintenance is disabled, \fBlinux\-update\-symlinks\fR does
linux-update-symlinks.1:45:nothing, successfully.  Otherwise it makes a list of kernel versions
linux-update-symlinks.1:48:The given \fIVERSION\fR, if the first argument is \fBinstall\fR
linux-update-symlinks.1:50:The current primary default version, if it exists and is not already
linux-update-symlinks.1:53:The current secondary default version, if it exists and is not already
linux-update-symlinks.1:56:All other versions whose files are installed, excluding the specified
linux-update-symlinks.1:57:\fIVERSION\fR if the first argument is \fBremove\fR, in decreasing
linux-update-symlinks.1:61:default versions, and it updates the symlinks accordingly.  In case
linux-update-symlinks.1:62:there is only one entry, this is both the primary and secondary
linux-update-symlinks.1:63:default version.  If there are no entries, there are no default

-.-.

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

an.tmac:<stdin>:1: style: .TH missing fourth argument; consider package/project name and version (e.g., "groff 1.23.0")
an.tmac:<stdin>:27: style: use of deprecated macro: .PD
an.tmac:<stdin>:36: style: use of deprecated macro: .PD
an.tmac:<stdin>:67: style: use of deprecated macro: .PD
an.tmac:<stdin>:69: misuse, warning: .IR is for at least 2 arguments, got 1
	Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:75: style: use of deprecated macro: .PD

-.-.

Generally:

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

--- linux-update-symlinks.1	2025-03-17 15:01:46.543073112 +0000
+++ linux-update-symlinks.1.new	2025-03-17 15:07:19.984505210 +0000
@@ -15,7 +15,7 @@ postinst script must pass the first argu
 has taken place.
 .PP
 The \fIVERSION\fR argument must be the kernel version string as shown by
-\fBuname -r\fR and used in filenames.
+\fBuname \-r\fR and used in filenames.
 .PP
 The \fIIMAGE\-PATH\fR argument must be the absolute filename of the
 kernel image.
@@ -66,7 +66,7 @@ versions and it removes the default syml
 .SH ENVIRONMENT VARIABLES
 .PD 0
 .TP
-.IR INITRD
+.B INITRD
 When the first argument is \fBinstall\fR or \fBupgrade\fR,
 \fBlinux\-update\-symlinks\fR assumes that the given \fIVERSION\fR
 will use an initramfs unless this variable is set to \fBNo\fR.

  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: linux-base
Source-Version: 4.12
Done: Ben Hutchings <benh@debian.org>

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

Debian distribution maintenance software
pp.
Ben Hutchings <benh@debian.org> (supplier of updated linux-base 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: Sun, 25 May 2025 21:16:36 +0200
Source: linux-base
Architecture: source
Version: 4.12
Distribution: unstable
Urgency: medium
Maintainer: Debian Kernel Team <debian-kernel@lists.debian.org>
Changed-By: Ben Hutchings <benh@debian.org>
Closes: 1076510 1095744 1099472 1100702
Changes:
 linux-base (4.12) unstable; urgency=medium
 .
   * d/changelog: Word-wrap previous entry to under 80 characters
   * d/copyright: Replace old FSF addresses with current GNU license URL
   * Add linux-run-hooks command for use by package maintainer scripts
   * man: Fix some minor formatting issues, thanks to Bjarni Ingi Gislason
     (Closes: #1095744, #1100702)
   * kernel-img.conf(5): Remove documentation of kernel-package
     (Closes: #1099472)
   * kernel-img.conf(5): Simplify description of support status
   * linux-sysctl-defaults: Increase vm.max_map_count to 1048576
     (Closes: #1076510)
Checksums-Sha1:
 7c92a4e45f4d38cf8c36cad1713855060ec9b785 1746 linux-base_4.12.dsc
 a79ea1b8ca18f093d6997abdcae682c8a7011ee3 29444 linux-base_4.12.tar.xz
 ecd9e751b055b83f5efab6ab53f5d402b310eb04 7764 linux-base_4.12_source.buildinfo
Checksums-Sha256:
 df6e43a704cc6b67f47a0d1b843739d9199853da9e40be54a732eea0fcca6a3d 1746 linux-base_4.12.dsc
 23fd8ce524a68cebbc300119a956ad50614f705cec910c39fd1b58b0a27e0131 29444 linux-base_4.12.tar.xz
 2d939498b5244c5204e1443bda07a0105f37867a44829d3e8d149144ab0939c9 7764 linux-base_4.12_source.buildinfo
Files:
 91888629ccf3568ae96b3d8a62ec1cac 1746 kernel optional linux-base_4.12.dsc
 28526cd9db660957576693ab8e5ce56a 29444 kernel optional linux-base_4.12.tar.xz
 d73b5df024549bab9f0886fcf47f005b 7764 kernel optional linux-base_4.12_source.buildinfo

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

iQIzBAEBCgAdFiEErCspvTSmr92z9o8157/I7JWGEQkFAmgzbh8ACgkQ57/I7JWG
EQkDyBAA1OPkUcDPm0/1RlAMZ2Ox3VkLuJNGb4CCBoRUYeRCQeZIRWIog/rvXSGl
wuRThT10Ak/x1He2LqTmYkTVbGQOrNrqaZlYCl362NUEz33Td9BL13bI7MPilvT6
R/024zJAeMbRtUADkIyAQf4lgcNfUqIxU7yn3OxtOlFB0KGJP0uen3AC5D66A26M
COYpVea4P8rnsP5JAzeNgFyVRadq6WmKjj8/nKrgYc+n+oh7A+4l5k6Y3y3cUR18
3x+TNZT3ealn9Gbw6JtMqtW43hB45AkCzzxDncX+NK6DLOYu2elFrOlPto9gjomM
Fck3AH6SpxYQ1+fRSjoZi4jt2Mw5NXYmqy0hogpzR9WzTcM/a90GsfLVs4ilKFij
1CFLtGEA4RhmBSieeDNcYqzjv6WTsB8OYs2yVZh/h590UNo8iPFNRX+xuypYnx8E
JjVjsRHa7UZTaVIw66Xajq1jQfFNdh2G945FrigJCUtbME358R+5SCboBkbU+hIc
18koCQl9806cRs46EM65nsD1NoWLGuibg93W1elMWixF6IVDHlgNiR0kzaU72x8V
IEhACqlJGfYmoPRXaCUMrVgwIdQnwr0yafImDxq22nHr79ljs6gDFXqVtjXh7ykc
Zy6fPhDwLY1wyzj+C02O/Ou9VUP2jyIEQmAubP9HZsMO0Z4/qaQ=
=HCYC
-----END PGP SIGNATURE-----

Attachment: pgpDNMD6LxIm9.pgp
Description: PGP signature


--- End Message ---
Reply to: