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

Bug#1099449: marked as done (c89-gcc.1: Some remarks and a patch with editorial changes for this man page)

Your message dated Thu, 04 Sep 2025 00:05:00 +0000
with message-id <E1utxTI-005JCN-0i@fasolo.debian.org>
and subject line Bug#1099449: fixed in gcc-defaults 1.226
has caused the Debian Bug report #1099449,
regarding c89-gcc.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.)


-- 
1099449: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1099449
Debian Bug Tracking System
Contact owner@bugs.debian.org with problems
--- Begin Message --- 
Package: gcc
Version: 14.2.0-16
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>:34: style: .TH missing third argument; consider document modification date in ISO 8601 format (YYYY-MM-DD)
an.tmac:<stdin>:34: style: .TH missing fourth argument; consider package/project name and version (e.g., "groff 1.23.0")
an.tmac:<stdin>:40: misuse, warning: .RB is for at least 2 arguments, got 1
	Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:41: misuse, warning: .RB is for at least 2 arguments, got 1
	Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:42: misuse, warning: .RB 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 gcc-14 depends on:
ii  binutils                 2.44-2
ii  cpp-14                   14.2.0-16
ii  gcc-14-base              14.2.0-16
ii  gcc-14-x86-64-linux-gnu  14.2.0-16

Versions of packages gcc-14 recommends:
ii  libc6-dev  2.40-7

Versions of packages gcc-14 suggests:
ii  gcc-14-doc       14.2.0-1
pn  gcc-14-locales   <none>
pn  gcc-14-multilib  <none>

-- no debconf information

Input file is c89-gcc.1

Output from "mandoc -T lint  c89-gcc.1": (shortened list)


      1 line scope broken: RB breaks I
      1 missing date, using "": TH

-.-.

Output from "test-groff -mandoc -t -ww -z c89-gcc.1": (shortened list)


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

-.-.

Use the correct macro for the font change of a single argument or
split the argument into two.

40:.RB "[\-pedantic]"
41:.RB "[\-pedantic-errors]"
42:.RB "[\-D_ANSI_SOURCE]"

-.-.

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

59:cc(1) for a description of all options.

-.-.

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

an.tmac:<stdin>:34: style: .TH missing third argument; consider document modification date in ISO 8601 format (YYYY-MM-DD)
an.tmac:<stdin>:34: style: .TH missing fourth argument; consider package/project name and version (e.g., "groff 1.23.0")
an.tmac:<stdin>:40: misuse, warning: .RB is for at least 2 arguments, got 1
	Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:41: misuse, warning: .RB is for at least 2 arguments, got 1
	Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:42: misuse, warning: .RB 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.

--- c89-gcc.1	2025-03-03 15:34:35.142121174 +0000
+++ c89-gcc.1.new	2025-03-03 15:41:25.454690618 +0000
@@ -36,10 +36,9 @@
 c89 \- ANSI (1989) C compiler
 .SH SYNOPSIS
 .B c89
-.I
-.RB "[\-pedantic]"
-.RB "[\-pedantic-errors]"
-.RB "[\-D_ANSI_SOURCE]"
+.RB [ \-pedantic ]
+.RB [ \-pedantic-errors ]
+.RB [ \-D_ANSI_SOURCE ]
 options ...
 .SH DESCRIPTION
 Calls the C compiler (cc) with the given
@@ -49,14 +48,15 @@ using a C language environment compatibl
 .PP
 This includes proper handling of trigraphs,
 disabling non-ANSI compiler features (such as
-.B asm ,
-.B inline ,
-.B typeof ,
+.BR asm ,
+.BR inline ,
+.BR typeof ,
 and the $ character in identifiers),
 and definition of the preprocessor symbol
 __STRICT_ANSI__ .
 .SH SEE ALSO
-cc(1) for a description of all options.
+.BR cc (1)
+for a description of all options.
 .SH HISTORY
 Appeared in
 NetBSD 1.4 .

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

We believe that the bug you reported is fixed in the latest version of
gcc-defaults, 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 1099449@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-defaults 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, 04 Sep 2025 01:22:32 +0200
Source: gcc-defaults
Architecture: source
Version: 1.226
Distribution: unstable
Urgency: medium
Maintainer: Debian GCC Maintainers <debian-gcc@lists.debian.org>
Changed-By: Matthias Klose <doko@debian.org>
Closes: 1099449 1107486
Changes:
 gcc-defaults (1.226) unstable; urgency=medium
 .
   * Fix some man page issues (Bjarni Ingi Gislason). Closes: #1099449.
   * Fix mod-version computation (Helmut Grohne). Closes: #1107486.
   * Depend on the native gfortran-N (Helmut Grohne).
   * Build libgphobos-dev on ppc64el.
   * Bump versions to 15.2 and 14.3.
Checksums-Sha1:
 4079a9eb7ea2d863e2c84286474be7c6e722581d 37750 gcc-defaults_1.226.dsc
 b87d12157f9498e64082f35f105ec5d0d7ec0ba6 55392 gcc-defaults_1.226.tar.xz
 f1aa6f7fd25aaef326557fb5f41358eaf0c69182 6211 gcc-defaults_1.226_source.buildinfo
Checksums-Sha256:
 0fdb11463f9750a4519dc05e791723d09b06de6dfc7f9787b1eab6c4c5350a90 37750 gcc-defaults_1.226.dsc
 2823e8a1958a4b0f2a0ccccf5ae84cfc20d52001bc7410b3a504a979a132264a 55392 gcc-defaults_1.226.tar.xz
 cee315a995120e9e4aae523d633bdff97084c18a17672244bd28245d1f1b829d 6211 gcc-defaults_1.226_source.buildinfo
Files:
 427560eb4a02c8d68a06e3eab88b714f 37750 devel standard gcc-defaults_1.226.dsc
 a287c9985a93d1afad7cefdf792f11bb 55392 devel standard gcc-defaults_1.226.tar.xz
 5338235623a3e694cbee16911d822f36 6211 devel standard gcc-defaults_1.226_source.buildinfo

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

iQJEBAEBCgAuFiEE1WVxuIqLuvFAv2PWvX6qYHePpvUFAmi40QAQHGRva29AZGVi
aWFuLm9yZwAKCRC9fqpgd4+m9QG/EADZt8IKY+/1cldgLQ7dOYVAtfRSxY2afHMA
WXQvjHuA3hm9RXIOUkU63wJMdSYRjFPA0yOxL3dZwvGM/Tqk6/VGDqauzKPAZJj7
8r2MVsff5gmQbsNcpk5IBxCVRdCptmk81Ivzqp+VvtPyct3oyHS7KrABH0+L4b4O
c7xdfavhc9AuYJcUi24OT4daG+HfuNWgVh/7UtoOV5YF53VzM6tuBxgFkdYnYWcu
Xy9jKPso2jQWtA2Mp/At6f5KecaT2Pz4JN/SBrW3gj5cY2ZMXKbT2PKni4ZbXEY/
icnJ88Z9eC2853Xqfd6GNZ5idpYnYzoXKtGxrKnFMwXHoJxWdXPwJjvz5nqrESLx
QMh+S6EUk/bjEfr8ED0965Frs2Fzbja63J7a9tAnb+k3pdB0WFyyeaYZJgcRc/8L
DG1UzS/9942jNgaoEnGAxf41nPg8J1HibVTNWpMTry9rV3R3whVjLFERzjuaWuTa
zn02kLHK2DDXJKnGUBbBYBkvRTPYfiIbj/d3TfwbMzYUdG1sx3EpwSdgv0TYHAq7
iow30zZ3I7wl9OGbSHbsWB5bjw4myVc0nhy6OhmzG+qxLi+KxE91oT2ud8F3vzWZ
ofMfqjZLYDcDRB6YdHD2fL7Vv66PmJiPLwFSHXdKvjLuiB9Vh9slSBZpdtJQQboS
SE3BWw6T2Q==
=yiND
-----END PGP SIGNATURE-----

Attachment: pgpIdO_qdukuo.pgp
Description: PGP signature


--- End Message ---
Reply to: