Bug#1112463: drmHandleEvent.3: Some remarks and a patch with editorial changes for this man page
Package: libdrm-dev
Version: 2.4.125-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
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-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:73: 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: forky/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.12.38+deb13-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 libdrm-dev depends on:
ii libdrm-amdgpu1 2.4.125-2
ii libdrm-intel1 2.4.125-2
ii libdrm-nouveau2 2.4.125-2
ii libdrm-radeon1 2.4.125-2
ii libdrm2 2.4.125-2
ii libpciaccess-dev 0.17-3+b3
libdrm-dev recommends no packages.
libdrm-dev suggests no packages.
-- no debconf information
Input file is drmHandleEvent.3
Output from "mandoc -T lint drmHandleEvent.3": (shortened list)
1 STYLE: whitespace at end of input line
5 WARNING: skipping paragraph macro: sp after SH
Find most trailing spaces with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
-.-.
Output from
test-nroff -mandoc -t -ww -z drmHandleEvent.3: (shortened list)
1 line(s) with a trailing space
-.-.
Show if generated from reStructuredText or rd2
1:.\" Man page generated from reStructuredText.
78:.\" Generated by docutils manpage writer.
Latest version: docutils (Docutils 0.21.2, Python 3.13.7, on linux)
-.-.
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
1
-.-.
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"
41:file\-descriptor passed as \fBfd\fP\&. This function should be called after
68:read from the file\-descriptor. Returns \-1 if the read on the
-.-.
No need for '\&' to be in front of a period (.),
if there is a character in front of it.
Remove with "sed -e 's/\(.\)\\&\./\1./g'".
41:file\-descriptor passed as \fBfd\fP\&. This function should be called after
-.-.
Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).
drmHandleEvent.3:41:file\-descriptor passed as \fBfd\fP\&. This function should be called after
drmHandleEvent.3:68:read from the file\-descriptor. Returns \-1 if the read on the
-.-.
Remove quotes when there is a printable
but no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.
drmHandleEvent.3:30:.TH "DRMHANDLEEVENT" "3" "September 2012" "" "Direct Rendering Manager"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:73: warning: trailing space in the line
-.-
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- drmHandleEvent.3 2025-08-29 16:33:15.514083961 +0000
+++ drmHandleEvent.3.new 2025-08-29 16:42:35.004364380 +0000
@@ -31,12 +31,10 @@ level margin: \\n[rst2man-indent\\n[rst2
.SH NAME
drmHandleEvent \- read and process pending DRM events
.SH SYNOPSIS
-.sp
\fB#include <xf86drm.h>\fP
.sp
\fBint drmHandleEvent(int fd, drmEventContextPtr evctx);\fP
.SH DESCRIPTION
-.sp
\fBdrmHandleEvent\fP processes outstanding DRM events on the DRM
file\-descriptor passed as \fBfd\fP\&. This function should be called after
the DRM file\-descriptor has polled readable; it will read the events and
@@ -63,16 +61,13 @@ typedef struct _drmEventContext {
.UNINDENT
.UNINDENT
.SH RETURN VALUE
-.sp
\fBdrmHandleEvent\fP returns 0 on success, or if there is no data to
read from the file\-descriptor. Returns \-1 if the read on the
file\-descriptor fails or returns less than a full event record.
.SH REPORTING BUGS
-.sp
Bugs in this function should be reported to
- <https://gitlab.freedesktop.org/mesa/libdrm/\-/issues>
+ <https://gitlab.freedesktop.org/mesa/libdrm/\-/issues>
.SH SEE ALSO
-.sp
\fBdrm\fP(7), \fBdrm\-kms\fP(7), \fBdrmModePageFlip\fP(3),
\fBdrmWaitVBlank\fP(3)
.\" Generated by docutils manpage writer.
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.
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: