Package: libdrm-dev
Version: 2.4.123-1
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>:30: style: .TH missing fourth argument; consider
package/project name and version (e.g., "groff 1.23.0")
an.tmac:<stdin>:49: style: 1 leading space(s) on input line
troff:<stdin>:49: 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.10-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.123-1
ii libdrm-intel1 2.4.123-1
ii libdrm-nouveau2 2.4.123-1
ii libdrm-radeon1 2.4.123-1
ii libdrm2 2.4.123-1
ii libpciaccess-dev 0.17-3+b3
libdrm-dev recommends no packages.
libdrm-dev suggests no packages.
-- no debconf information
Input file is drmAvailable.3
Output from "mandoc -T lint drmAvailable.3": (shortened list)
5 skipping paragraph macro: sp after SH
1 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z drmAvailable.3": (shortened list)
1 trailing space in the line
-.-.
Show if generated from reStructuredText
Who is actually generating this man page? Debian or upstream?
Is the generating software out of date?
1:.\" Man page generated from reStructuredText.
-.-.
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
-.-.
Remove space in the first column, if not indented.
Use ".in +<number>n" and ".in" to end it; ".nf" and ".fi" to end
it, for an extra indention.
drmAvailable.3:49: <https://gitlab.freedesktop.org/mesa/drm/\-/issues>
-.-.
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.
30:.TH "DRMAVAILABLE" "3" "September 2012" "" "Direct Rendering Manager"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:30: style: .TH missing fourth argument; consider
package/project name and version (e.g., "groff 1.23.0")
an.tmac:<stdin>:49: style: 1 leading space(s) on input line
troff:<stdin>:49: warning: trailing space in the line
--- drmAvailable.3 2025-01-30 23:56:02.581488326 +0000
+++ drmAvailable.3.new 2025-01-31 00:56:15.124811217 +0000
@@ -27,28 +27,22 @@ level margin: \\n[rst2man-indent\\n[rst2
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "DRMAVAILABLE" "3" "September 2012" "" "Direct Rendering Manager"
+.TH DRMAVAILABLE 3 "September 2012" "" "Direct Rendering Manager"
.SH NAME
drmAvailable \- determine whether a DRM kernel driver has been loaded
.SH SYNOPSIS
-.sp
\fB#include <xf86drm.h>\fP
.sp
\fBint drmAvailable(void);\fP
.SH DESCRIPTION
-.sp
\fBdrmAvailable\fP allows the caller to determine whether a kernel DRM
driver is loaded.
.SH RETURN VALUE
-.sp
\fBdrmAvailable\fP returns 1 if a DRM driver is currently loaded.
Otherwise 0 is returned.
.SH REPORTING BUGS
-.sp
Bugs in this function should be reported to
- <https://gitlab.freedesktop.org/mesa/drm/\-/issues>
+<https://gitlab.freedesktop.org/mesa/drm/\-/issues>
.SH SEE ALSO
-.sp
\fBdrm\fP(7), \fBdrmOpen\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>
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 -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 -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)
-.-
