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>:43: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:46: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:52: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:58: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:62: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:92: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:98: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:103: misuse, warning: .BI 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 inputtestdrv.4
Output from "mandoc -T lint inputtestdrv.4": (shortened list)
-.-.
Output from "test-groff -mandoc -t -ww -z inputtestdrv.4": (shortened list)
8 Use macro '.B' for one argument or split argument.
8 .BI is for at least 2 arguments, got 1
-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.
43:.BI Keyboard
46:.BI Pointer
52:.BI PointerAbsolute
58:.BI PointerAbsoluteProximity
62:.BI Touch
103:.BI xf86ITEventWaitForSync
-.-.
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 "\&".
19:server as input events. It supports the full set of the xf86 driver APIs
20:exposed by Xorg. The primary use cases of this input driver are various
29:is created after the driver is initialized. The paths to the socket is passed
37:Sets the path where the driver will create a named socket. Any existing file
47:Initializes a relative-mode pointer device. It will have four valuators -
53:Initializes an absolute-mode pointer device. It will have four valuators -
87:specifies the protocol version supported by it. If this version is lower than
91:to the driver. Each event is an instance of one of the
93:structs. The length field defines the full length of the struct in bytes and
96:The responses from the server follow the same structure. Each response is an
99:structs. The length field defines the full length of the struct in bytes and
104:event. After sending such event, the client must read of a
106:events. The completion of the read operation indicates that Xorg has fully
-.-.
The name of a man page is typeset in bold and the section in roman
(see man-pages(7)).
24:Please refer to xorg.conf(5) for general configuration
112:Xorg(1), xorg.conf(5), Xserver(1), X(7)
-.-.
Section headings (.SH and .SS) do not need quoting.
111:.SH "SEE ALSO"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:43: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:46: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:52: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:58: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:62: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:92: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:98: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:103: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
-.-
Additionally:
"read of a xf86... event" -> "read an xf86... event"
--- inputtestdrv.4 2025-02-08 01:39:13.409398290 +0000
+++ inputtestdrv.4.new 2025-02-08 02:12:24.399643500 +0000
@@ -15,57 +15,67 @@ inputtest \- An X.Org input driver for t
.SH DESCRIPTION
.B inputtest
-is an Xorg input driver that passes events received over a socket on to the
-server as input events. It supports the full set of the xf86 driver APIs
-exposed by Xorg. The primary use cases of this input driver are various
-integration tests that need to interface with the input subsystem.
+is an Xorg input driver
+that passes events received over a socket on to the server as input events.
+It supports the full set of the xf86 driver APIs exposed by Xorg.
+The primary use cases of this input driver are various integration tests
+that need to interface with the input subsystem.
.SH CONFIGURATION DETAILS
-Please refer to xorg.conf(5) for general configuration
-details and for options that can be used with all input drivers. This
-section only covers configuration details specific to this driver.
-.PP
-External process can communicate with the input driver via a named socket that
-is created after the driver is initialized. The paths to the socket is passed
-via input driver options.
+Please refer to
+.BR xorg.conf (5)
+for general configuration details
+and for options
+that can be used with all input drivers.
+This section only covers configuration details specific to this driver.
+.PP
+External process can communicate with the input driver via a named socket
+that is created after the driver is initialized.
+The paths to the socket is passed via input driver options.
.PP
The following driver
.B Options
are supported:
.TP 7
.BI "Option \*qSocketPath\*q \*q" string \*q
-Sets the path where the driver will create a named socket. Any existing file
-at that location will be removed.
+Sets the path where the driver will create a named socket.
+Any existing file at that location will be removed.
.TP 7
.BI "Option \*qDeviceType\*q \*q" string \*q
Sets the type of the device to be emulated.
.IP
-.BI Keyboard
+.B Keyboard
Initializes a keyboard device.
.IP
-.BI Pointer
-Initializes a relative-mode pointer device. It will have four valuators -
-a "Rel X" valuator at axis 0 and a "Rel Y" valuator at axis 1.
+.B Pointer
+Initializes a relative-mode pointer device.
+It will have four valuators \(en
+a "Rel X" valuator at axis 0
+and a "Rel Y" valuator at axis 1.
A horizontal scroll valuator will be set up at axis 2.
A vertical scroll valuator will be set up at axis 3.
.IP
-.BI PointerAbsolute
-Initializes an absolute-mode pointer device. It will have four valuators -
-an "Abs X" valuator at axis 0 and an "Abs Y" valuator at axis 1.
+.B PointerAbsolute
+Initializes an absolute-mode pointer device.
+It will have four valuators \(en
+an "Abs X" valuator at axis 0
+and an "Abs Y" valuator at axis 1.
A horizontal scroll valuator will be set up at axis 2.
A vertical scroll valuator will be set up at axis 3.
.IP
-.BI PointerAbsoluteProximity
+.B PointerAbsoluteProximity
Initializes an absolute-mode pointer device with proximity support.
-The valuators are initialized in the same way as for \fBPointerAbsolute\fR
type.
+The valuators are initialized in the same way
+as for \fBPointerAbsolute\fR type.
.IP
-.BI Touch
+.B Touch
Initializes a touch device.
-It will have 5 valuators: an "Abs MT Position X" at axis 0,
+It will have 5 valuators:
+an "Abs MT Position X" at axis 0,
an "Abs MT Position Y" valuator at axis 1,
a horizontal scroll valuator on axis 2,
-a vertical scroll valuator on axis 3 and an "Abs MT Pressure" valuator
-at axis 4.
+a vertical scroll valuator on axis 3
+and an "Abs MT Pressure" valuator at axis 4.
.TP 7
.BI "Option \*qTouchCount\*q \*q" int \*q
Sets the maximum number of simultaneous touches for touch devices.
@@ -80,33 +90,44 @@ Selects whether "Abs Pressure" is availa
The communication with the driver is a binary protocol defined in
include/xf86-input-inputtest-protocol.h
.PP
-At the beginning, the client process that communicates with the driver must
-connect to the socket that is created by the driver at SocketPath.
-Once the connection is established, it must write a xf86ITEventClientVersion
-event and read a xf86ITResponseServerVersion response where the driver
-specifies the protocol version supported by it. If this version is lower than
-requested by the client, then the driver will disconnect.
+At the beginning,
+the client process
+that communicates with the driver must connect to the socket
+that is created by the driver at SocketPath.
+Once the connection is established,
+it must write a xf86ITEventClientVersion event
+and read a xf86ITResponseServerVersion response
+where the driver specifies the protocol version supported by it.
+If this version is lower than requested by the client,
+then the driver will disconnect.
.PP
After receiving xf86ITResponseServerVersion message the client may send events
-to the driver. Each event is an instance of one of the
-.BI xf86ITEvent*
-structs. The length field defines the full length of the struct in bytes and
-the event field defines the type of the struct.
-.PP
-The responses from the server follow the same structure. Each response is an
-instance of one of the
-.BI xf86ITResponse*
-structs. The length field defines the full length of the struct in bytes and
-the event field defines the type of the struct.
+to the driver.
+Each event is an instance of one of the
+.BI xf86ITEvent *
+structs.
+The length field defines the full length of the struct in bytes
+and the event field defines the type of the struct.
+.PP
+The responses from the server follow the same structure.
+Each response is an instance of one of the
+.BI xf86ITResponse *
+structs.
+The length field defines the full length of the struct in bytes
+and the event field defines the type of the struct.
.PP
The synchronization with Xorg is performed via
-.BI xf86ITEventWaitForSync
-event. After sending such event, the client must read of a
-.BI xf86ITResponseSyncFinished event from the socket without sending additional
-events. The completion of the read operation indicates that Xorg has fully
-processed all input events sent to it so far.
+.B xf86ITEventWaitForSync
+event.
+After sending such event,
+the client must read a
+.B xf86ITResponseSyncFinished
+event from the socket
+without sending additional events.
+The completion of the read operation indicates
+that Xorg has fully processed all input events sent to it so far.
.SH AUTHORS
Povilas Kanapickas <povi...@radix.lt>
-.SH "SEE ALSO"
-Xorg(1), xorg.conf(5), Xserver(1), X(7)
+.SH SEE ALSO
+.BR Xorg "(1), " xorg.conf "(5), " Xserver "(1), " X (7)
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)
-.-
