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>:101: style: 1 leading space(s) on input line
troff:<stdin>:101: 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 drmModeGetResources.3
Output from "mandoc -T lint drmModeGetResources.3": (shortened list)
1 input text line longer than 80 bytes: The \fIcount_connect...
1 input text line longer than 80 bytes: The \fIcount_encoder...
1 input text line longer than 80 bytes: The \fIcount_fbs\fP ...
1 input text line longer than 80 bytes: The \fImin_*\fP and ...
5 skipping paragraph macro: sp after SH
1 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z drmModeGetResources.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.
drmModeGetResources.3:101: <https://gitlab.freedesktop.org/mesa/drm/\-/issues>
-.-.
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 "\&".
44:configuration. The structure contains the following fields:
74:configuration. A CRTC is simply an object that can scan out a
76:position information. CRTCs drive encoders, which are responsible for
81:connectors on the system. Note that some of these may not be exposed
82:from the chassis (e.g., LVDS or eDP). Connectors are attached to
88:the device. Each encoder may be associated with a CRTC, and may be used
96:success, NULL on failure. The returned structure must be freed with
-.-.
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Line 69, length 83
The \fIcount_fbs\fP and \fIfbs\fP fields indicate the number of currently
allocated
Line 80, length 82
The \fIcount_connectors\fP and \fIconnectors\fP fields list the available
physical
Line 87, length 81
The \fIcount_encoders\fP and \fIencoders\fP fields list the available encoders
on
Line 91, length 81
The \fImin_*\fP and \fImax_*\fP fields indicate the maximum size of a
framebuffer
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
drmModeGetResources.3:39:\fBdrmModeResPtr drmModeGetResources(int fd);\fP
drmModeGetResources.3:82:from the chassis (e.g., LVDS or eDP). Connectors are
attached to
drmModeGetResources.3:92:for this device (i.e., the scanout size limit).
-.-.
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 "DRMMODEGETRESOURCES" "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>:101: style: 1 leading space(s) on input line
troff:<stdin>:101: warning: trailing space in the line
--- drmModeGetResources.3 2025-01-31 01:02:20.199600749 +0000
+++ drmModeGetResources.3.new 2025-01-31 02:01:32.326450150 +0000
@@ -31,17 +31,17 @@ level margin: \\n[rst2man-indent\\n[rst2
.SH NAME
drmModeGetResources \- retrieve current display configuration information
.SH SYNOPSIS
-.sp
\fB#include <xf86drm.h>\fP
.sp
\fB#include <xf86drmMode.h>\fP
.sp
\fBdrmModeResPtr drmModeGetResources(int fd);\fP
.SH DESCRIPTION
-.sp
-\fBdrmModeGetResources\fP allocates, populates, and returns a drmModeRes
-structure containing information about the current display
-configuration. The structure contains the following fields:
+\fBdrmModeGetResources\fP allocates,
+populates,
+and returns a drmModeRes structure containing information about the current
+display configuration.
+The structure contains the following fields:
.INDENT 0.0
.INDENT 3.5
.sp
@@ -66,44 +66,53 @@ typedef struct _drmModeRes {
.UNINDENT
.UNINDENT
.sp
-The \fIcount_fbs\fP and \fIfbs\fP fields indicate the number of currently
allocated
-framebuffer objects (i.e., objects that can be attached to a given CRTC
-or sprite for display).
+The \fIcount_fbs\fP and \fIfbs\fP fields
+indicate the number of currently allocated framebuffer objects
+(i.e., objects that can be attached to a given CRTC or sprite for display).
.sp
The \fIcount_crtcs\fP and \fIcrtcs\fP fields list the available CRTCs in the
-configuration. A CRTC is simply an object that can scan out a
-framebuffer to a display sink, and contains mode timing and relative
-position information. CRTCs drive encoders, which are responsible for
-converting the pixel stream into a specific display protocol (e.g., MIPI
-or HDMI).
-.sp
-The \fIcount_connectors\fP and \fIconnectors\fP fields list the available
physical
-connectors on the system. Note that some of these may not be exposed
-from the chassis (e.g., LVDS or eDP). Connectors are attached to
-encoders and contain information about the attached display sink (e.g.,
-width and height in mm, subpixel ordering, and various other
-properties).
-.sp
-The \fIcount_encoders\fP and \fIencoders\fP fields list the available encoders
on
-the device. Each encoder may be associated with a CRTC, and may be used
-to drive a particular encoder.
-.sp
-The \fImin_*\fP and \fImax_*\fP fields indicate the maximum size of a
framebuffer
-for this device (i.e., the scanout size limit).
+configuration.
+A CRTC is simply an object that can scan out a
+framebuffer to a display sink,
+and contains mode timing
+and relative position information.
+CRTCs drive encoders,
+which are responsible for converting the pixel stream into a specific
+display protocol
+(e.g., MIPI or HDMI).
+.sp
+The \fIcount_connectors\fP and \fIconnectors\fP fields
+list the available physical connectors on the system.
+Note that some of these may not be exposed
+from the chassis
+(e.g., LVDS or eDP).
+Connectors are attached to encoders
+and contain information about the attached display sink
+(e.g.,
+width and height in mm,
+subpixel ordering,
+and various other properties).
+.sp
+The \fIcount_encoders\fP and \fIencoders\fP fields
+list the available encoders on the device.
+Each encoder may be associated with a CRTC,
+and may be used to drive a particular encoder.
+.sp
+The \fImin_*\fP and \fImax_*\fP fields
+indicate the maximum size of a framebuffer for this device
+(i.e., the scanout size limit).
.SH RETURN VALUE
-.sp
\fBdrmModeGetResources\fP returns a drmModeRes structure pointer on
-success, NULL on failure. The returned structure must be freed with
+success,
+NULL on failure.
+The returned structure must be freed with
\fBdrmModeFreeResources\fP(3).
.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), \fBdrm\-kms\fP(7), \fBdrmModeGetFB\fP(3), \fBdrmModeAddFB\fP(3),
\fBdrmModeAddFB2\fP(3), \fBdrmModeRmFB\fP(3), \fBdrmModeDirtyFB\fP(3),
\fBdrmModeGetCrtc\fP(3), \fBdrmModeSetCrtc\fP (3), \fBdrmModeGetEncoder\fP (3),
\fBdrmModeGetConnector\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)
-.-
