Bug#1120291: XvGetPortAttribute.3: Some remarks and a patch with editorial changes for this man page
Package: libxv-dev
Version: 2:1.0.13-1
Severity: minor
Tags: patch
>From "/usr/share/doc/debian/bug-reporting.txt.gz":
Don't file bugs upstream
If you file a bug in Debian, don't send a copy to the upstream software
maintainers yourself, as it is possible that the bug exists only in
Debian. If necessary, the maintainer of the package will forward the
bug upstream.
-.-
I do not send reports upstream if I have to get an account there.
The Debian maintainers have one already.
If I get a negative (or no) response from upstream, I send henceforth
bugs to Debian.
-.-
* 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=0 -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-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:45: warning: cannot select font 'HB'
troff:<stdin>:45: warning: cannot select font 'HB'
troff:<stdin>:45: warning: cannot select font 'HB'
troff:<stdin>:45: warning: cannot select font 'HB'
troff:<stdin>:45: warning: cannot select font 'HB'
troff:<stdin>:45: warning: cannot select font 'HB'
* 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.16.12+deb14+1-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 libxv-dev depends on:
ii libx11-dev 2:1.8.12-1
ii libxext-dev 2:1.3.4-1+b3
ii libxv1 2:1.0.13-1
ii x11proto-dev 2024.1-1
libxv-dev recommends no packages.
libxv-dev suggests no packages.
-- no debconf information
Input file is XvGetPortAttribute.3
Output from "mandoc -T lint XvGetPortAttribute.3": (shortened list)
1 WARNING: skipping paragraph macro: PP after SH
1 WARNING: unknown font, skipping request: TS fHB
1 WARNING: unknown font, skipping request: TS fHB lfHB
1 WARNING: unknown font, skipping request: TS fHB lfHB lfHB
Find most trailing spaces with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
-.-.
Output from
test-nroff -mandoc -t -ww -z XvGetPortAttribute.3: (shortened list)
6 cannot select font 'HB'
Find most trailing spaces with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
-.-.
Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.
50:"XV_HUE"@[-1000...1000]@0
51:"XV_SATURATION"@[-1000...1000]@0
52:"XV_BRIGHTNESS"@[-1000...1000]@0
53:"XV_CONTRAST"@[-1000...1000]@0
-.-.
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:45: warning: cannot select font 'HB'
troff:<stdin>:45: warning: cannot select font 'HB'
troff:<stdin>:45: warning: cannot select font 'HB'
troff:<stdin>:45: warning: cannot select font 'HB'
troff:<stdin>:45: warning: cannot select font 'HB'
troff:<stdin>:45: warning: cannot select font 'HB'
-.-
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
-.-
Additionally:
Do not hyphenate the word "XInternAtom", groff hyphenates it as
"XIn\%ter\%nAtom".
-.-
SYNOPSIS:
Adjust indent for "troff" output in the continuation line.
-.-
Remove the '.PP' in the table as it messes up with the formatting
commands of the table.
--- XvGetPortAttribute.3 2025-11-07 01:27:26.083180090 +0000
+++ XvGetPortAttribute.3.new 2025-11-07 02:30:28.319353248 +0000
@@ -8,7 +8,9 @@ XvGetPortAttribute \- return current por
.sp
.nf
.BI "int XvGetPortAttribute(Display *" dpy ", XvPortID " port ","
-.BI " Atom " attribute ", int " p_value ");"
+.nr width \w'\fBint XvGetPortAttribute(\fR'u+\n(.iu
+.ti \n[width]u
+.BI "Atom " attribute ", int " p_value ");"
.fi
.SH ARGUMENTS
.\"
@@ -19,7 +21,7 @@ Specifies the port, associated with the
which the attribute values are to be returned.
.IP \fIattribute\fR 12
An atom that identifies the attribute to be queried by this
-request. Control atoms are obtained using the XInternAtom
+request. Control atoms are obtained using the \%XInternAtom
request with a string from the following table.
.IP \fIp_value\fR 12
Pointer to the location where the attribute value is written on
@@ -27,12 +29,11 @@ return.
.\"
.SH DESCRIPTION
.\"
-.PP
.BR XvGetPortAttribute (3)
returns the current value of the requested
port attribute in the integer pointed to by \fIp_value\fR.
The attribute is identified using an Atom that equates to the attribute name.
-The XInternAtom request can be used with one of the strings
+The \%XInternAtom request can be used with one of the strings
below to return a matching Atom.
.PP
.TS
@@ -40,17 +41,16 @@ tab(@);
lfHB lfHB lfHB
lfR lfR lfR .
_
-.PP
.sp 4p
Attribute String@Type@Default
.sp 6p
_
.sp 6p
"XV_ENCODING"@XvEncodingID@Server dependent
-"XV_HUE"@[-1000...1000]@0
-"XV_SATURATION"@[-1000...1000]@0
-"XV_BRIGHTNESS"@[-1000...1000]@0
-"XV_CONTRAST"@[-1000...1000]@0
+"XV_HUE"@[\-1000...1000]@0
+"XV_SATURATION"@[\-1000...1000]@0
+"XV_BRIGHTNESS"@[\-1000...1000]@0
+"XV_CONTRAST"@[\-1000...1000]@0
.sp 6p
.TE
.SH RETURN VALUES
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: