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

Bug#1123995: xkeyboard-config-2.7: Some remarks and a patch with editorial changes for this man page



Package: xkb-data
Version: 2.46-2
Severity: minor
Tags: patch, 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.

-.-

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

  If I get a negative (or no) response from upstream, I send henceforth
bugs to Debian.

-.-

   * 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 ' \\"' <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-nroff  -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":

troff:<stdin>:504: warning: special character 'u2011' not defined
troff:<stdin>:695: warning: special character 'u0055_0304' not defined
an.tmac:<stdin>:926: warning: .l = 1920u = 80n = 80m, .i = 120u, TW (table width) = 2112u = 88n = 88m
an.tmac:<stdin>:929: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:933: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1080: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1095: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1161: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1218: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1239: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1254: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1290: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1326: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1398: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1455: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1524: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1599: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1629: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1668: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1722: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1743: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1767: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1788: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1803: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1818: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1833: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the 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: forky/sid
  APT prefers testing
  APT policy: (500, 'testing')
Architecture: amd64 (x86_64)

Kernel: Linux 6.17.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)

-- no debconf information
Input file is xkeyboard-config-2.7

Output from "mandoc -T lint  xkeyboard-config-2.7": (shortened list)

      2 STYLE: input text line longer than 80 bytes: 

-.-.

Output from
test-nroff -mandoc -t -ww -z xkeyboard-config-2.7: (shortened list)

     23 	Use macro '.B' for one argument or split the argument.
     23 .BR is for at least 2 arguments, got 0
      1 .l = 1920u = 80n = 80m, .i = 120u, TW (table width) = 2112u = 88n = 88m
      1 special character 'u0055_0304' not defined
      1 special character 'u2011' not defined

-.-.

Input file is xkeyboard-config-2.7

Reduce space between words.

xkeyboard-config-2.7:1178:Caps Lock as Ctrl,  Left Control switches to another layout

-.-.

Wrong distance (not two spaces) between sentences in the input file.

  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"

7:Extension (XKB) and for libxkbcommon. Typically it is
9:requested configuration. Users running an X server can also use the
16:/usr/share/xkeyboard-config-2. User-specific data files may be elsewhere but it depends on
17:the tool whether those files are loaded. For example, the libxkbcommon
27:xkeyboard-config data files. This is primarily aimed at systems running X
1538:Num Lock on: digits; Shift for arrows. Num Lock off: arrows (as in Windows)

-.-.

Split lines longer than 80 characters (fill completely
an A4 sized page line on a terminal)
into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Add "\:" to split the string for the output, "\<newline>" in the source.  

[List of affected lines removed.]

Longest line is number 1712 with 117 characters
Zero-width non-joiner at the 2nd level, non-breaking space at the 3rd level, thin non-breaking space at the 4th level

-.-.

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

10:setxkbmap(1) tool to apply keyboard configuration at runtime or configure XKB
11:settings in the xorg.conf(5).
1866:setxkbmap(1)

-.-.

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

xkeyboard-config-2.7:7:Extension (XKB) and for libxkbcommon. Typically it is
xkeyboard-config-2.7:9:requested configuration. Users running an X server can also use the
xkeyboard-config-2.7:16:/usr/share/xkeyboard-config-2. User-specific data files may be elsewhere but it depends on
xkeyboard-config-2.7:17:the tool whether those files are loaded. For example, the libxkbcommon
xkeyboard-config-2.7:27:xkeyboard-config data files. This is primarily aimed at systems running X
xkeyboard-config-2.7:223:yahoo	Yahoo! Internet
xkeyboard-config-2.7:1538:Num Lock on: digits; Shift for arrows. Num Lock off: arrows (as in Windows)

-.-.

Reduce space between words.

temp.table:1121:Caps Lock as Ctrl,  Left Control switches to another layout

-.-.

Wrong distance (not two spaces) between sentences in the input file.

  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"

[List of affected lines removed.]

190:yahoo	Yahoo! Internet
206:am(phonetic-alt)	Armenian (alt. phonetic)
208:am(eastern-alt)	Armenian (alt. eastern)
398:us(alt-intl)	English (US, alt. intl.)
410:us(dvorak-alt-intl)	English (Dvorak, alt. intl.)
605:in(urd-phonetic3)	Urdu (alt. phonetic)
1441:Num Lock on: digits; Shift for arrows. Num Lock off: arrows (as in Windows)

-.-.

Split lines longer than 80 characters (fill completely
an A4 sized page line on a terminal)
into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Add "\:" to split the string for the output, "\<newline>" in the source.  

[List of affected lines removed.]
Longest line is number 1600 with 117 characters
Zero-width non-joiner at the 2nd level, non-breaking space at the 3rd level, thin non-breaking space at the 4th level

-.-.

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

troff:<stdin>:504: warning: special character 'u2011' not defined
troff:<stdin>:695: warning: special character 'u0055_0304' not defined
an.tmac:<stdin>:926: warning: .l = 1920u = 80n = 80m, .i = 120u, TW (table width) = 2112u = 88n = 88m
an.tmac:<stdin>:929: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:933: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1080: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1095: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1161: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1218: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1239: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1254: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1290: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1326: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1398: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1455: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1524: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1599: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1629: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1668: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1722: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1743: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1767: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1788: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1803: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1818: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.
an.tmac:<stdin>:1833: misuse, warning: .BR is for at least 2 arguments, got 0
	Use macro '.B' for one argument or split the argument.

-.-

Generally:

Split (sometimes) lines after a punctuation mark; before a conjunction.
--- xkeyboard-config-2.7	2025-12-25 19:54:01.512165902 +0000
+++ xkeyboard-config-2.7.new	2025-12-25 20:26:16.671351510 +0000
@@ -7,8 +7,10 @@ xkeyboard-config provides the descriptio
 Extension (XKB) and for libxkbcommon. Typically it is
 the task of the desktop environment to apply the
 requested configuration. Users running an X server can also use the
-setxkbmap(1) tool to apply keyboard configuration at runtime or configure XKB
-settings in the xorg.conf(5).
+.BR setxkbmap (1)
+tool to apply keyboard configuration at runtime or configure XKB
+settings in the
+.BR xorg.conf (5).
 
 .SH XKB DATA FILES LOAD PATHS
 
@@ -18,7 +20,7 @@ the tool whether those files are loaded.
 library will by default load XKB data files from the user's home directory.
 See the libxkbcommon documentation for details.
 
-.SH THE "CUSTOM" LAYOUT
+.SH THE """CUSTOM""" LAYOUT
 
 The "custom" layout is a layout that is listed as available to tools
 reading the data files but is not actually provided by xkeyboard-config.
@@ -220,7 +222,7 @@ tm2030USB-106	TypeMatrix EZ-Reach 2030 U
 unitekkb1925	Unitek KB-1925
 vsonku306	ViewSonic KU-306 Internet
 winbook	Winbook Model XP5
-yahoo	Yahoo! Internet
+yahoo	Yahoo!\& Internet
 .TE
 .sp
 .SH LAYOUTS
@@ -238,9 +240,9 @@ et	Amharic
 _
 am	Armenian
 am(phonetic)	Armenian (phonetic)
-am(phonetic-alt)	Armenian (alt. phonetic)
+am(phonetic-alt)	Armenian (alt.\& phonetic)
 am(eastern)	Armenian (eastern)
-am(eastern-alt)	Armenian (alt. eastern)
+am(eastern-alt)	Armenian (alt.\& eastern)
 am(western)	Armenian (western)
 _
 ara	Arabic
@@ -430,7 +432,7 @@ _
 us	English (US)
 us(euro)	English (US, euro on 5)
 us(intl)	English (US, intl., with dead keys)
-us(alt-intl)	English (US, alt. intl.)
+us(alt-intl)	English (US, alt.\& intl.)
 us(altgr-intl)	English (intl., with AltGr dead keys)
 us(mac)	English (Macintosh, ABC, ANSI)
 us(mac-iso)	English (Macintosh, ABC, ISO)
@@ -442,7 +444,7 @@ us(colemak_dh_iso)	English (Colemak-DH I
 us(colemak_dh_wide_iso)	English (Colemak-DH Wide ISO)
 us(dvorak)	English (Dvorak)
 us(dvorak-intl)	English (Dvorak, intl., with dead keys)
-us(dvorak-alt-intl)	English (Dvorak, alt. intl.)
+us(dvorak-alt-intl)	English (Dvorak, alt.\& intl.)
 us(dvorak-l)	English (Dvorak, one-handed, left)
 us(dvorak-r)	English (Dvorak, one-handed, right)
 us(dvorak-classic)	English (classic Dvorak)
@@ -637,7 +639,7 @@ in(tel)	Telugu
 in(tel-kagapa)	Telugu (KaGaPa, phonetic)
 in(tel-sarala)	Telugu (Sarala)
 in(urd-phonetic)	Urdu (phonetic)
-in(urd-phonetic3)	Urdu (alt. phonetic)
+in(urd-phonetic3)	Urdu (alt.\& phonetic)
 in(urd-winkeys)	Urdu (Windows)
 in(iipa)	Indic IPA
 _
@@ -926,11 +928,9 @@ custom	A user-defined custom Layout
 .TE
 .sp
 .SH OPTIONS
-.BR
 
 .SS
 Switching to another layout
-.BR
 .TS
 nowarn,box;
 lw25B lxB
@@ -1077,7 +1077,6 @@ T}
 
 .SS
 Key to choose the 2nd level
-.BR
 .TS
 nowarn,box;
 lw25B lxB
@@ -1092,7 +1091,6 @@ T}
 
 .SS
 Key to choose the 3rd level
-.BR
 .TS
 nowarn,box;
 lw25B lxB
@@ -1158,7 +1156,6 @@ T}
 
 .SS
 Ctrl position
-.BR
 .TS
 nowarn,box;
 lw25B lxB
@@ -1175,7 +1172,7 @@ ctrl:swapcaps	T{
 Swap Ctrl and Caps Lock
 T}
 ctrl:grouptoggle_capscontrol	T{
-Caps Lock as Ctrl,  Left Control switches to another layout
+Caps Lock as Ctrl, Left Control switches to another layout
 T}
 ctrl:hyper_capscontrol	T{
 Caps Lock as Ctrl, Ctrl as Hyper
@@ -1215,7 +1212,6 @@ T}
 
 .SS
 Use keyboard LED to show alternative layout
-.BR
 .TS
 nowarn,box;
 lw25B lxB
@@ -1236,7 +1232,6 @@ T}
 
 .SS
 Use keyboard LED to indicate modifiers
-.BR
 .TS
 nowarn,box;
 lw25B lxB
@@ -1251,7 +1246,6 @@ T}
 
 .SS
 Layout of numeric keypad
-.BR
 .TS
 nowarn,box;
 lw25B lxB
@@ -1287,7 +1281,6 @@ T}
 
 .SS
 Numeric keypad Delete behavior
-.BR
 .TS
 nowarn,box;
 lw25B lxB
@@ -1323,7 +1316,6 @@ T}
 
 .SS
 Caps Lock behavior
-.BR
 .TS
 nowarn,box;
 lw25B lxB
@@ -1395,7 +1387,6 @@ T}
 
 .SS
 Alt and Win behavior
-.BR
 .TS
 nowarn,box;
 lw25B lxB
@@ -1452,7 +1443,6 @@ T}
 
 .SS
 Position of Compose key
-.BR
 .TS
 nowarn,box;
 lw25B lxB
@@ -1521,7 +1511,6 @@ T}
 
 .SS
 Compatibility options
-.BR
 .TS
 nowarn,box;
 lw25B lxB
@@ -1535,7 +1524,7 @@ numpad:mac	T{
 Numeric keypad always enters digits (as in macOS)
 T}
 numpad:microsoft	T{
-Num Lock on: digits; Shift for arrows. Num Lock off: arrows (as in Windows)
+Num Lock on: digits; Shift for arrows.  Num Lock off: arrows (as in Windows)
 T}
 numpad:shift3	T{
 Shift does not cancel Num Lock, chooses 3rd level instead
@@ -1596,7 +1585,6 @@ T}
 
 .SS
 Currency signs
-.BR
 .TS
 nowarn,box;
 lw25B lxB
@@ -1626,7 +1614,6 @@ T}
 
 .SS
 Key to choose the 5th level
-.BR
 .TS
 nowarn,box;
 lw25B lxB
@@ -1665,7 +1652,6 @@ T}
 
 .SS
 Non-breaking space input
-.BR
 .TS
 nowarn,box;
 lw25B lxB
@@ -1719,7 +1705,6 @@ T}
 
 .SS
 Japanese keyboard options
-.BR
 .TS
 nowarn,box;
 lw25B lxB
@@ -1740,7 +1725,6 @@ T}
 
 .SS
 Korean Hangul/Hanja keys
-.BR
 .TS
 nowarn,box;
 lw25B lxB
@@ -1764,7 +1748,6 @@ T}
 
 .SS
 Esperanto letters with superscripts
-.BR
 .TS
 nowarn,box;
 lw25B lxB
@@ -1785,7 +1768,6 @@ T}
 
 .SS
 Old Solaris keycodes compatibility
-.BR
 .TS
 nowarn,box;
 lw25B lxB
@@ -1800,7 +1782,6 @@ T}
 
 .SS
 Key sequence to kill the X server
-.BR
 .TS
 nowarn,box;
 lw25B lxB
@@ -1815,7 +1796,6 @@ T}
 
 .SS
 Function keys
-.BR
 .TS
 nowarn,box;
 lw25B lxB
@@ -1830,7 +1810,6 @@ T}
 
 .SS
 Miscellaneous options
-.BR
 .TS
 nowarn,box;
 lw25B lxB
@@ -1863,4 +1842,4 @@ T}
 /usr/share/xkeyboard-config-2/types
 
 .SH SEE ALSO
-setxkbmap(1)
+.BR setxkbmap (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>

  To find trailing space use

grep -n -e ' $' -e ' \\f.$' -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.

-.-

  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:

  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)

-.-

Reply to: