Package: xserver-xorg-core
Version: 2:21.1.15-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?
an.tmac:<stdin>:40: misuse, warning: .BR 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.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-core depends on:
ii keyboard-configuration 1.233
ii libaudit1 1:4.0.2-2+b1
ii libc6 2.40-6
ii libdbus-1-3 1.16.0-1
ii libdrm2 2.4.123-1
ii libegl1 1.7.0-1+b2
ii libepoxy0 1.5.10-2
ii libgbm1 24.2.8-1
ii libgcrypt20 1.11.0-7
ii libgl1 1.7.0-1+b2
ii libpciaccess0 0.17-3+b3
ii libpixman-1-0 0.44.0-3
ii libselinux1 3.7-3.1
ii libsystemd0 257.2-3
ii libudev1 257.2-3
ii libunwind8 1.8.1-0.1
ii libxau6 1:1.0.11-1
ii libxcvt0 0.1.2-1+b2
ii libxdmcp6 1:1.1.5-1
ii libxfont2 1:2.0.6-1+b3
ii libxshmfence1 1.3-1+b3
ii udev 257.2-3
ii xserver-common 2:21.1.15-2
Versions of packages xserver-xorg-core recommends:
pn default-logind | logind <none>
ii libgl1-mesa-dri 24.2.8-1
pn xcvt <none>
Versions of packages xserver-xorg-core suggests:
ii xfonts-100dpi 1:1.0.5
ii xfonts-75dpi 1:1.0.5
pn xfonts-scalable <none>
-- no debconf information
Input file is exa.4
Output from "mandoc -T lint exa.4": (shortened list)
-.-.
Output from "test-groff -mandoc -t -ww -z exa.4": (shortened list)
1 Use macro '.B' for one argument or split argument.
1 .BR is for at least 2 arguments, got 1
-.-.
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 "\&".
25:Disables acceleration of uploading pixmap data to the framebuffer. Default:
No.
-.-.
Split a punctuation mark from a single argument for a two-font macro
40:.BR xorg.conf(5).
-.-.
Section headings (.SH and .SS) do not need quoting.
38:.SH "SEE ALSO"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:40: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
--- exa.4 2025-02-08 00:34:09.606439702 +0000
+++ exa.4.new 2025-02-08 00:52:05.931421353 +0000
@@ -5,24 +5,30 @@
exa \- new 2D acceleration architecture for X.Org
.SH DESCRIPTION
.B EXA
-provides a simple API for video drivers to implement for 2D acceleration. It
-is a module loaded by drivers, and is not intended to be loaded on its own.
+provides a simple API for video drivers to implement for 2D acceleration.
+It is a module loaded by drivers,
+and is not intended to be loaded on its own.
See your driver's manual page for how to enable
.BR EXA .
.PP
The
.B EXA
-architecture is designed to make accelerating the Render extension simple and
-efficient, and results in various performance tradeoffs compared to XAA. Some
-xorg.conf options are available for debugging performance issues or
-driver rendering problems. They are not intended for general use.
+architecture is designed to make accelerating the Render extension simple
+and efficient,
+and results in various performance tradeoffs compared to XAA.
+Some xorg.conf options are available for debugging performance issues
+or driver rendering problems.
+They are not intended for general use.
.TP
.BI "Option \*qEXANoComposite\*q \*q" boolean \*q
-Disables acceleration of the Composite operation, which is at the heart of
-the Render extension. Not related to the Composite extension. Default: No.
+Disables acceleration of the Composite operation,
+which is at the heart of the Render extension.
+Not related to the Composite extension.
+Default: No.
.TP
.BI "Option \*qEXANoUploadToScreen\*q \*q" boolean \*q
-Disables acceleration of uploading pixmap data to the framebuffer. Default: No.
+Disables acceleration of uploading pixmap data to the framebuffer.
+Default: No.
.TP
.BI "Option \*qEXANoDownloadFromScreen\*q \*q" boolean \*q
Disables acceleration of downloading of pixmap data from the framebuffer.
@@ -31,12 +37,16 @@ Not usable with drivers which rely on Do
Default: No.
.TP
.BI "Option \*qMigrationHeuristic\*q \*q" anystr \*q
-Chooses an alternate pixmap migration heuristic, for debugging purposes. The
-default is intended to be the best performing one for general use, though
others
-may help with specific use cases. Available options include \*qalways\*q,
-\*qgreedy\*q, and \*qsmart\*q. Default: always.
-.SH "SEE ALSO"
+Chooses an alternate pixmap migration heuristic,
+for debugging purposes.
+The default is intended to be the best performing one for general use,
+though others may help with specific use cases.
+Available options include \*qalways\*q,
+\*qgreedy\*q,
+and \*qsmart\*q.
+Default: always.
+.SH SEE ALSO
.BR Xorg (1),
-.BR xorg.conf(5).
+.BR xorg.conf (5).
.SH AUTHORS
Authors include: Keith Packard, Eric Anholt, Zack Rusin, and Michel D\(:anzer
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)
-.-
