Package: libc-bin
Version: 2.43-4
Severity: minor
Tags: patch

  Additional remarks.

  Mails from me to "[email protected]" are no longer acknowledged.  A
Debian maintainer told me, that he would contact the mail administrator
about me not wanting to send bugs upstream.

-.-

Dear Maintainer,

>From "/usr/share/doc/debian/bug-reporting.txt.gz":

  Don't file bugs upstream

   If you file a bug in Debian, don't send a copy to the upstream software
   maintainers yourself, as it is possible that the bug exists only in
   Debian. If necessary, the maintainer of the package will forward the
   bug upstream.

-.-

  For forwarding bug reports to upstream see:

https://www.debian.org/Bugs/Developer#forward

-.-

  "Handling bug reports" in
http://people.debian.org/~enrico/dcg/ch03s02.html

-.-

  I do not send reports upstream if I have to get an account there.
The Debian maintainers have one already.

-.-

   * 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=0 -ww -z < "man page"

  [Use 

grep -n -e ' $' -e '\\~$' -e ' \\f.$' -e ' \\"' -e ' "$' <file>

  to find (most) 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  -K utf8 -rF0 -rHY=0 -ww -z ":

troff:<stdin>:114: warning: interpreting second argument to font emboldening 
request as emboldening amount; use a font name instead of a mounting position 
as the first argument if conditional emboldening desired [-w style]

Output from "test-nroff  -mandoc  -K utf8 -rF0 -rHY=0 -ww -z ":

Bad use of \s0 in a string definition, the string "X" could be resized,
for example with "\s-1\*X\s0".

102:.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
156:.ds v 
\\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
159:.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]

   * 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: forky/sid
  APT prefers testing
  APT policy: (500, 'testing')
Architecture: amd64 (x86_64)

Kernel: Linux 7.1.12+deb14-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 libc-bin depends on:
ii  libc6  2.43-4

Versions of packages libc-bin recommends:
ii  manpages  6.18-1

libc-bin suggests no packages.

-- no debconf information
Input file is getconf.1


Output from
test-groff mandoc -Kutf8 -ww -z getconf.1: (shortened list)

      1 .UC

-.-.


Add a backslash, if it is missing after \{ at the end of a line.

91:.if \nF \{

-.-.

Wrong distance (not two spaces, not a new line character (\n)) between
sentences in the input file.

mandoc(1) says: "New sentence, new line."

  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.

  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"

222:\&        A system configuration variable as defined by pathconf(3). This

-.-.

Do not use "\s0" in a string definition but an absolute number,
as the size of the string could be changed.
Then a situation of "\s+X...\s+Y...\s0...\s0" could emerge.
Type size changes have an effect in "troff", but not in "nroff".

102:.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
156:.ds v 
\\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
159:.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]

-.-.

The name of a man page is typeset in bold (or italic) and the section in
roman (see man-pages(7)).

216:\&        A system configuration variable, as defined by sysconf(3) or
217:\&        confstr(3).
222:\&        A system configuration variable as defined by pathconf(3). This

-.-.

Add a zero (0) in front of a decimal fraction that begins with a period
(.)

18:.if t .sp .5v
118:.   ds #V .8m
119:.   ds #F .3m
125:.   ds #V .6m

-.-.

Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).
Start a new sentence on a new line.

mandoc(1) says "New sentence, new line."

getconf.1:222:\&        A system configuration variable as defined by 
pathconf(3). This

-.-.

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.

getconf.1:192:.SH "NAME"
getconf.1:194:.SH "SYNOPSIS"
getconf.1:200:.SH "DESCRIPTION"
getconf.1:225:.SH "AUTHOR"
getconf.1:237:.IX Header "NAME"
getconf.1:239:.IX Header "SYNOPSIS"
getconf.1:241:.IX Header "DESCRIPTION"
getconf.1:243:.IX Header "AUTHOR"

-.-.

Change comment lines of type '.\" ====', '.\" ---', and an empty
'.\"' line) to a single period, as they contain no information and waste
work each time they are processed.

3:.\"
7:.\"
8:.\"
37:.\"
38:.\"
42:.\"

-.-.

Additionally:

Use request ".in +8n" to indent a line instead of "\&        ...".
and ".in -8n" to reverse it.

-,-

Size/bytes:

 5405 getconf.1
 5390 getconf.1.new

-.-

Generally:

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

-.-

Tables:

  Use the preprocessor 'tbl' to make tables.

  Put data, that are wider than the header in the (centered) last column,
in a "T{...\nT}" block.

  Table headings, that are wider than any data in the corresponding
column, do not need to be centered, so left adjustment (l, L) is
sufficient.  There is thereby no change in the standard output.
--- getconf.1   2026-09-05 03:00:26.099673494 +0000
+++ getconf.1.new       2026-09-05 04:01:27.385462961 +0000
@@ -1,11 +1,11 @@
 .rn '' }`
 .\" $RCSfile: getconf.1,v $$Revision: 1.1.2.1 $$Date: 2003/09/22 21:33:35 $
-.\"
+.
 .\" $Log: getconf.1,v $
 .\" Revision 1.1.2.1  2003/09/22 21:33:35  jbailey
 .\" New directory for things we add to the package
-.\"
-.\"
+.
+.
 .de Sh
 .br
 .if t .Sp
@@ -15,7 +15,7 @@
 .PP
 ..
 .de Sp
-.if t .sp .5v
+.if t .sp 0.5v
 .if n .sp
 ..
 .de Ip
@@ -34,12 +34,12 @@
 
 .fi
 ..
-.\"
-.\"
+.
+.
 .\"     Set up \*(-- to give an unbreakable dash;
 .\"     string Tr holds user defined translation string.
 .\"     Bell System Logo is used as a dummy character.
-.\"
+.
 .tr \(*W-
 .ie n \{\
 .ds -- \(*W-
@@ -88,7 +88,7 @@
 .\"            X<>     Xref  (embedded
 .\"    Of course, you have to process the output yourself
 .\"    in some meaningful fashion.
-.if \nF \{
+.if \nF \{\
 .de IX
 .tm Index:\\$1\t\\n%\t"\\$2"
 ..
@@ -99,14 +99,14 @@
 .UC
 .if n .hy 0
 .if n .na
-.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s+2\v'.1v'\h'-1p'
 .de CQ          \" put $1 in typewriter font
 .ft CW
 'if n "\c
-'if t \\&\\$1\c
-'if n \\&\\$1\c
+'if t \&\\$1\c
+'if n \&\\$1\c
 'if n \&"
-\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
+\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
 '.ft R
 ..
 .\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
@@ -115,14 +115,14 @@
 .      \" fudge factors for nroff and troff
 .if n \{\
 .      ds #H 0
-.      ds #V .8m
-.      ds #F .3m
+.      ds #V 0.8m
+.      ds #F 0.3m
 .      ds #[ \f1
 .      ds #] \fP
 .\}
 .if t \{\
 .      ds #H ((1u-(\\\\n(.fu%2u))*.13m)
-.      ds #V .6m
+.      ds #V 0.6m
 .      ds #F 0
 .      ds #[ \&
 .      ds #] \&
@@ -153,10 +153,10 @@
 .      \" troff and (daisy-wheel) nroff accents
 .ds : 
\\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
-.ds v 
\\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
+.ds v 
\\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s+4\v'\*(#V'\h'|\\n:u'\*(#]
 .ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
 .ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
-.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
+.ds 3 \*(#[\v'.2m'\s-2\&3\s+2\v'-.2m'\*(#]
 .ds o 
\\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
@@ -189,15 +189,15 @@
 .      ds Oe OE
 .\}
 .rm #[ #] #H #V #F C
-.SH "NAME"
+.SH NAME
 getconf \- Query system configuration variables (sysconf)
-.SH "SYNOPSIS"
+.SH SYNOPSIS
 \fBgetconf\fR \-a
 .P
 \fBgetconf\fR [\fB\-v specification\fR] system_var
 .PP
 \fBgetconf\fR [\fB\-v specification\fR] path_var pathname
-.SH "DESCRIPTION"
+.SH DESCRIPTION
 \fB\-a\fR
 .PP
 .Vb 2
@@ -213,16 +213,22 @@ getconf \- Query system configuration va
 \fBsystem_var\fR
 .PP
 .Vb 2
-\&        A system configuration variable, as defined by sysconf(3) or
-\&        confstr(3).
+.in +8n
+A system configuration variable, as defined by \c
+.BR sysconf (3)
+or \c
+.BR confstr (3).
+.in -8n
 .Ve
 \fBpath_var\fR
 .PP
 .Vb 2
-\&        A system configuration variable as defined by pathconf(3). This
-\&        must be used with a pathname.
+.in +8n
+A system configuration variable as defined by \c
+.BR pathconf (3).
+This must be used with a pathname.
 .Ve
-.SH "AUTHOR"
+.SH AUTHOR
 \fIgetconf\fR was written by Roland McGrath for the GNU C Library
 .PP
 This man page was written by Ben Collins <[email protected]> for
@@ -234,13 +240,13 @@ the Debian GNU/Linux system.
 .IX Title "GETCONF 1"
 .IX Name "getconf - Query system configuration variables (sysconf)"
 
-.IX Header "NAME"
+.IX Header NAME
 
-.IX Header "SYNOPSIS"
+.IX Header SYNOPSIS
 
-.IX Header "DESCRIPTION"
+.IX Header DESCRIPTION
 
-.IX Header "AUTHOR"
+.IX Header AUTHOR
 
 .IX Header "SEE ALSO"
 
  Check the output from "lintian" in the Debian distribution.

  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>

  To find most trailing spaces use

grep -n -e ' $' -e ' \\f.$' -e ' \\"' -e ' "$' <man page>

  The same goes for man pages that are used as an input.

-.-

  For a style guide use

  mandoc -T lint

-.-

  For general input conventions consult the man page "nroff(7)" (item
"Input conventions") or the Texinfo manual about the same item.

-.-

  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.

  Debian can fix simple bugs in the used generators and distribute them,
and does not need to wait for upstream to do that and distribute them.

-.-

  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 when that has been fixed.

  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 a script "cmp.manuals" in the attachment.

  Or

  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)

-.-

Attachment: cmp.manuals.gz
Description: application/gzip

Reply via email to