Package: xserver-xorg-video-fbdev
Version: 1:0.5.0-2
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?
troff:<stdin>:22: warning: trailing space in the line
troff:<stdin>:33: warning: trailing space in the line
troff:<stdin>:36: warning: trailing space in the line
troff:<stdin>:42: 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.12.11-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 xserver-xorg-video-fbdev depends on:
ii libc6 2.40-6
ii xserver-xorg-core [xorg-video-abi-25] 2:21.1.15-2
xserver-xorg-video-fbdev recommends no packages.
xserver-xorg-video-fbdev suggests no packages.
-- no debconf information
Input file is fbdev.4
Output from "mandoc -T lint fbdev.4": (shortened list)
4 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z fbdev.4": (shortened list)
4 trailing space in the line
-.-.
Remove space characters (whitespace) at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
Number of lines affected is
4
-.-.
Wrong distance 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 "\&".
47:The framebuffer device to use. Default: /dev/fb0.
50:Enable or disable use of the shadow framebuffer layer. Mandatory for 24bpp
51:framebuffers on newer servers. Default: on.
54:Enable rotation of the display. The supported values are "CW" (clockwise,
56:270 degrees). Implies use of the shadow framebuffer layer. Disabled for 24bpp
57:framebuffers. Default: off.
-.-.
The name of a man page is typeset in bold and the section in roman
(see man-pages(7)).
25:fbdev uses the os-specific submodule fbdevhw(4) to talk
29:Please refer to xorg.conf(5) for general configuration
59:Xorg(1), xorg.conf(5), Xserver(1),
60:X(7), fbdevhw(4)
-.-.
Use the name of units in text; use symbols in tables and
calculations.
The rule is to have a (no-break, \~) space between a number and
its units (see "www.bipm.org/en/publications/si-brochure")
50:Enable or disable use of the shadow framebuffer layer. Mandatory for 24bpp
56:270 degrees). Implies use of the shadow framebuffer layer. Disabled for 24bpp
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
fbdev.4:55:90 degrees), "UD" (upside down, 180 degrees) and "CCW" (counter
clockwise,
-.-.
Section headings (.SH and .SS) do not need quoting.
58:.SH "SEE ALSO"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:22: warning: trailing space in the line
troff:<stdin>:33: warning: trailing space in the line
troff:<stdin>:36: warning: trailing space in the line
troff:<stdin>:42: warning: trailing space in the line
17,20c17,23
< is an Xorg driver for framebuffer devices. This is a non-accelerated
< driver, the following framebuffer depths are supported: 8, 15, 16, 24.
< All visual types are supported for depth 8, and TrueColor visual is
< supported for the other depths. Multi-head configurations are supported.
---
> is an Xorg driver for framebuffer devices.
> This is a non-accelerated driver,
> the following framebuffer depths are supported:
> 8, 15, 16, 24.
> All visual types are supported for depth 8,
> and TrueColor visual is supported for the other depths.
> Multi-head configurations are supported.
22c25
< The
---
> The
24c27,28
< driver supports all hardware where a framebuffer driver is available.
---
> driver supports all hardware
> where a framebuffer driver is available.
26,27c30,31
< to the kernel
< device driver. Currently a fbdevhw module is available for linux.
---
> to the kernel device driver.
> Currently a fbdevhw module is available for linux.
29,31c33,34
< Please refer to xorg.conf(5) for general configuration
< details. This section only covers configuration details specific to
< this driver.
---
> Please refer to xorg.conf(5) for general configuration details.
> This section only covers configuration details specific to this driver.
33,34c36,39
< For this driver it is not required to specify modes in the screen
< section of the config file. The
---
> For this driver
> it is not required to specify modes in the screen section of the config
> file.
> The
36,37c41,44
< driver can pick up the currently used video mode from the framebuffer
< driver and will use it if there are no video modes configured.
---
> driver can pick up the currently used video mode from the framebuffer
> driver
> and will use it
> if there are no video modes configured.
40c47,48
< section. See above for a sample line.
---
> section.
> See above for a sample line.
42c50
< The following driver
---
> The following driver
47c55,56
< The framebuffer device to use. Default: /dev/fb0.
---
> The framebuffer device to use.
> Default: /dev/fb0.
50,51c59,61
< Enable or disable use of the shadow framebuffer layer. Mandatory for 24bpp
< framebuffers on newer servers. Default: on.
---
> Enable or disable use of the shadow framebuffer layer.
> Mandatory for 24\~bpp framebuffers on newer servers.
> Default: on.
54,60c64,76
< Enable rotation of the display. The supported values are "CW" (clockwise,
< 90 degrees), "UD" (upside down, 180 degrees) and "CCW" (counter clockwise,
< 270 degrees). Implies use of the shadow framebuffer layer. Disabled for 24bpp
< framebuffers. Default: off.
< .SH "SEE ALSO"
< Xorg(1), xorg.conf(5), Xserver(1),
< X(7), fbdevhw(4)
---
> Enable rotation of the display.
> The supported values are "CW"
> (clockwise, 90 degrees),
> "UD"
> (upside down, 180 degrees)
> and "CCW"
> (counter clockwise, 270 degrees).
> Implies use of the shadow framebuffer layer.
> Disabled for 24\~bpp framebuffers.
> Default: off.
> .SH SEE ALSO
> .BR Xorg "(1), " xorg.conf "(5), " Xserver "(1), " \
> X "(7), " fbdevhw (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.
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 -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)
-.-
