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

Bug#1094300: marked as done (x86_64-linux-gnu-gcc-nm-14.1: Some remarks and a patch with editorial changes for this man page)

Your message dated Mon, 27 Jan 2025 13:21:01 +0000
with message-id <E1tcP2z-00Esy8-Cv@fasolo.debian.org>
and subject line Bug#1094300: fixed in gcc-14 14.2.0-15
has caused the Debian Bug report #1094300,
regarding x86_64-linux-gnu-gcc-nm-14.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.)


-- 
1094300: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1094300
Debian Bug Tracking System
Contact owner@bugs.debian.org with problems
--- Begin Message --- 
Package: gcc-14-x86-64-linux-gnu
Version: 14.2.0-12
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>:17: 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.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)

Versions of packages gcc-14-x86-64-linux-gnu depends on:
ii  binutils-x86-64-linux-gnu  2.43.50.20250108-1
ii  cpp-14-x86-64-linux-gnu    14.2.0-12
ii  gcc-14-base                14.2.0-12
ii  libc6                      2.40-5
ii  libcc1-0                   14.2.0-12
ii  libgcc-14-dev              14.2.0-12
ii  libgcc-s1                  14.2.0-12
ii  libgmp10                   2:6.3.0+dfsg-3
ii  libisl23                   0.27-1
ii  libmpc3                    1.3.1-1+b3
ii  libmpfr6                   4.2.1-1+b2
ii  libstdc++6                 14.2.0-12
ii  libzstd1                   1.5.6+dfsg-2
ii  zlib1g                     1:1.3.dfsg+really1.3.1-1+b1

Versions of packages gcc-14-x86-64-linux-gnu recommends:
ii  libc6-dev  2.40-5

Versions of packages gcc-14-x86-64-linux-gnu suggests:
ii  gcc-14-doc      14.2.0-1
pn  gcc-14-locales  <none>

-- no debconf information

Input file is x86_64-linux-gnu-gcc-nm-14.1

Output from "mandoc -T lint  x86_64-linux-gnu-gcc-nm-14.1": (shortened list)


-.-.

Output from "test-groff -mandoc -t -ww -z x86_64-linux-gnu-gcc-nm-14.1": (shortened list)

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

-.-.

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 "\-\-".

x86_64-linux-gnu-gcc-nm-14.1:3:gcc-nm \- a wrapper around nm adding the --plugin option

-.-.

Name of a manual is set in bold, the section in roman.
See man-pages(7).

14:See nm(1) for a list of options that nm understands.
17:.BR nm(1)

-.-.

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

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

--- x86_64-linux-gnu-gcc-nm-14.1	2025-01-26 23:39:32.997615069 +0000
+++ x86_64-linux-gnu-gcc-nm-14.1.new	2025-01-26 23:43:24.707976365 +0000
@@ -1,17 +1,21 @@
 .TH GCC-nm-14 1 "May 8, 2012" gcc-nm-14 ""
 .SH NAME
-gcc-nm \- a wrapper around nm adding the --plugin option
+gcc-nm \- a wrapper around nm adding the \-\-plugin option
 
 .SH SYNOPSIS
 gcc-nm [\fB\s-1OPTION\s0\fR] ... [\fI\s-1ARGS\s0\fR...]
 
 .SH DESCRIPTION
 
-\fBgcc-nm\fR is a wrapper around nm(1) adding the appropriate
+\fBgcc-nm\fR is a wrapper around
+.BR nm (1)
+adding the appropriate
 \fB\-\-plugin\fR option for the GCC 14 compiler.
 
 .SH OPTIONS
-See nm(1) for a list of options that nm understands.
+See
+.BR nm (1)
+for a list of options that nm understands.
 
 .SH "SEE ALSO"
-.BR nm(1)
+.BR nm (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

-.-

  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: gcc-14
Source-Version: 14.2.0-15
Done: Matthias Klose <doko@debian.org>

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

Debian distribution maintenance software
pp.
Matthias Klose <doko@debian.org> (supplier of updated gcc-14 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: Mon, 27 Jan 2025 13:41:39 +0100
Source: gcc-14
Architecture: source
Version: 14.2.0-15
Distribution: unstable
Urgency: medium
Maintainer: Debian GCC Maintainers <debian-gcc@lists.debian.org>
Changed-By: Matthias Klose <doko@debian.org>
Closes: 1091161 1094299 1094300 1094302
Changes:
 gcc-14 (14.2.0-15) unstable; urgency=medium
 .
   * Update to git 20250127 from the gcc-14 branch.
     - Fix PR rtl-optimization/117186, PR target/118184 (AArch64),
       PR target/118067 (x86), PR target/118329 (AVR), PR gcov-profile/116743,
       PR c++/117153, PR c++/118509, PR c++/118049, PR c++/118255,
       PR c++/118147, PR c++/117775, PR d/114434, PR d/115249, PR d/116373,
       PR fortran/81978, PR libfortran/118571, PR libstdc++/109849,
       PR libstdc++/90389.
   * Fix nroff warnings for gcc-TOOL manpages (Bjarni Ingi Gislason).
     Closes: #1094299, #1094300, #1094302.
   * Fix PR target/118501, taken from the trunk. Closes: #1091161.
Checksums-Sha1:
 afb413347d773fc106844cefcf234cacbc476e78 47356 gcc-14_14.2.0-15.dsc
 53e325a78e84c5ff0bc2d256aa1f86155fd855b0 2524800 gcc-14_14.2.0-15.debian.tar.xz
 b56cdff0ee1736088a6a1f602ddc038e89c65b8d 7525 gcc-14_14.2.0-15_source.buildinfo
Checksums-Sha256:
 d5bc3d46c3e10183780ab9700dc45c22b950e610c97c6210b2049a7ac6600fa7 47356 gcc-14_14.2.0-15.dsc
 a577b8ba454b68eab8bfcd2765503b4c4c6d24052910162b3e2c429ec7f79513 2524800 gcc-14_14.2.0-15.debian.tar.xz
 2218a788becf391802b2a427190523e8e8d1f44a02bbb3468cd8249b5414bb4e 7525 gcc-14_14.2.0-15_source.buildinfo
Files:
 a8f0249f535d5651acf676bf729ea13c 47356 devel optional gcc-14_14.2.0-15.dsc
 0b3703d384551cdb29b8f04efc225828 2524800 devel optional gcc-14_14.2.0-15.debian.tar.xz
 a757382d8aa244ac78b2cc0e2c15eb4b 7525 devel optional gcc-14_14.2.0-15_source.buildinfo
-----BEGIN PGP SIGNATURE-----

iQJEBAEBCgAuFiEE1WVxuIqLuvFAv2PWvX6qYHePpvUFAmeXf9EQHGRva29AZGVi
aWFuLm9yZwAKCRC9fqpgd4+m9UHpD/48jRqNFqrcTZgioVgDpCGpbbWNWi+UKXYp
AYEPSeIg2PrD/wNeecjK8w8jN9IZHV10CUJGvJ28UE9RKfq++KmQPc6/QSM2zqG3
Z1MVWvt2Ky7Vmq1GhsK0qt+qdzfWQzieTxt9W3ISgm8JIWTgDQEdoW6wlAlDTFvM
KCd3tvZFDI7TTq8iV/oX1ubSgpmLUHM1mb9yJ6e4IyLLVbosGv6lNv3X4bizGi/+
klYJr6Y0Cr8Jx99QiyWq/aiVhYgQgjwhROKECOVlYhH6gSvDayXWU867SXFG5C6m
gqnozzQj4cHpl5jRgUbey6H9tvxLiyLSWI0WbxjqFTLYDuGBqzrEnqoRR2HNtSNm
wonMsoFhcxIoso1Pr14/+Pa6OdrOotFbE2Y+Scm+yhTnpfNbjOe9QwwwdmevMDWh
3FlAJFVO4WXTtnjdvmzYq8hteIcXPbxJWVxQ4y/wEs6/qV/zoEx5EKhOCuw7Q2xN
5UjLaWwUXG0xFKyaDwX5kefkBjNOg3HRKnWrScr3iQRPeFeNLzmPRuHxF3tHs5M4
YCWjydAo5GhogD5Brh4fII6vti+6sY/eTJz5LAKHu5lq7Eo2g82TBZknVOq39Az3
YjRySvp8ktNiQCjr5BkdBLURssx7LjGh3Pxc1RjKBAeoHfe25O8yxWOJfDe+zizk
3rxoA/Tzvg==
=k/Td
-----END PGP SIGNATURE-----

Attachment: pgplu3QKXkDN9.pgp
Description: PGP signature


--- End Message ---
Reply to: