[Pkg-kbd-devel] Bug#1089610: codepage.1: Some remarks and editorial changes for this man page

[Bjarni Ingi Gislason]

Package: kbd
Version: 2.6.4-3
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 -ww -z < "man page"

  [Use "groff -e ' $' <file>" to find 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?


troff:<stdin>:8: warning: trailing space in the line
troff:<stdin>:10: warning: trailing space in the line
troff:<stdin>:12: warning: trailing space in the line
troff:<stdin>:16: warning: trailing space in the line
troff:<stdin>:18: 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.11.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 kbd depends on:
ii  libc6  2.40-4

Versions of packages kbd recommends:
ii  console-setup  1.233

kbd suggests no packages.

-- no debconf information
-------------- next part --------------
Input file is codepage.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

-.-

  So any 'generator' should check its products with the above mentioned
'groff', 'mandoc',  and additionally with 'nroff ...'.

  This is just a simple quality control measure.

  The 'generator' may have to be corrected to get a better man page,
the source file may, and any additional file may.

  Common defects:

  Input text line longer than 80 bytes.

  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.
Lines should thus be shorter.

  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 of '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)


-.-.

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

     12 whitespace at end of input line

-.-.

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

      5 trailing space in the line

-.-.

Output from "mandoc -T lint  codepage.1":

mandoc: codepage.1:7:13: STYLE: whitespace at end of input line
mandoc: codepage.1:8:2: STYLE: whitespace at end of input line
mandoc: codepage.1:9:8: STYLE: whitespace at end of input line
mandoc: codepage.1:10:2: STYLE: whitespace at end of input line
mandoc: codepage.1:12:2: STYLE: whitespace at end of input line
mandoc: codepage.1:13:8: STYLE: whitespace at end of input line
mandoc: codepage.1:15:8: STYLE: whitespace at end of input line
mandoc: codepage.1:16:2: STYLE: whitespace at end of input line
mandoc: codepage.1:18:2: STYLE: whitespace at end of input line
mandoc: codepage.1:28:8: STYLE: whitespace at end of input line
mandoc: codepage.1:32:8: STYLE: whitespace at end of input line
mandoc: codepage.1:36:8: STYLE: whitespace at end of input line

-.-.

Remove space characters at the end of lines.

Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".

7:.B codepage 
9:.I \-c 
13:.I \-L 
15:.I \-a 
28:.I \-c 
32:.I \-L 
36:.I \-l 

-.-.

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

troff:<stdin>:8: warning: trailing space in the line
troff:<stdin>:10: warning: trailing space in the line
troff:<stdin>:12: warning: trailing space in the line
troff:<stdin>:16: warning: trailing space in the line
troff:<stdin>:18: warning: trailing space in the line

-.-.

Additional:

Options are typset bold,
see
.BR man-pages (7).
-------------- next part --------------
--- codepage.1	2024-12-09 02:45:23.867870125 +0000
+++ codepage.1.new	2024-12-09 03:00:41.867013871 +0000
@@ -4,18 +4,18 @@
 codepage \- extract a codepage from an MSDOS codepage file
 
 .SH SYNOPSIS
-.B codepage 
-[ 
-.I \-c 
-| 
-.I \-l
-| 
-.I \-L 
+.B codepage
+[
+.B \-c
+|
+.B \-l
+|
+.B \-L
+|
+.B \-a
 |
-.I \-a 
-| 
 .I nnn
-] 
+]
 .I file.cpi
 
 .SH DESCRIPTION
@@ -25,19 +25,19 @@ command extracts codepages from an MSDOS
 
 .SH OPTIONS
 .TP
-.I \-c 
+.B \-c
 Input file is a single codepage
 
 .TP
-.I \-L 
+.B \-L
 Print header info (you don't want to see this).
 
 .TP
-.I \-l 
+.B \-l
 List all codepages contained in the file.
 
 .TP
-.I \-a
+.B \-a
 Extract all codepages from the file
 
 .TP
@@ -60,4 +60,3 @@ ega.cpi, execute:
 .\" Andries Brouwer <aeb at cwi.nl>
 .\" .br
 .\" Manpage by Alastair McKinstry <mckinstry at computer.org>
-