Bug#1120397: XvSetPortAttribute.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>:38: warning: cannot select font 'HB'
troff:<stdin>:38: warning: cannot select font 'HB'
troff:<stdin>:38: warning: cannot select font 'HB'
troff:<stdin>:38: warning: cannot select font 'HB'
troff:<stdin>:38: warning: cannot select font 'HB'
troff:<stdin>:38: 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 XvSetPortAttribute.3
Output from "mandoc -T lint XvSetPortAttribute.3": (shortened list)
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
-.-.
Output from
test-nroff -mandoc -t -ww -z XvSetPortAttribute.3: (shortened list)
6 cannot select font 'HB'
-.-.
Reduce space between words.
XvSetPortAttribute.3:2:.TH XvSetPortAttribute 3 "libXv 1.0.13" "X Version 11" "libXv Functions"
-.-.
Remove space in the first column, if not indented.
Use ".in +<number>n" and ".in" to end it;
Or use ".nf" and ".fi" to end
it, for an extra indention.
XvSetPortAttribute.3:28: permits a client to set the port attribute
-.-.
Move a full stop (period) and a comma outside of a quoted text, if it is
at the end of the quote and does not end a quoted sentence.
21:Can be one of the table entries under the column "String," below.
24:Can be one of the table entries under the column "Type," below.
-.-.
Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
shall be printed as a minus.
43:"XV_HUE"@[-1000...1000]@0
44:"XV_SATURATION"@[-1000...1000]@0
45:"XV_BRIGHTNESS"@[-1000...1000]@0
46:"XV_CONTRAST"@[-1000...1000]@0
-.-.
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:38: warning: cannot select font 'HB'
troff:<stdin>:38: warning: cannot select font 'HB'
troff:<stdin>:38: warning: cannot select font 'HB'
troff:<stdin>:38: warning: cannot select font 'HB'
troff:<stdin>:38: warning: cannot select font 'HB'
troff:<stdin>:38: warning: cannot select font 'HB'
-.-
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
-.-
Additionally:
Remove paragraph macro (.PP) from the table as it disturbs the
formatting of it.
--- XvSetPortAttribute.3 2025-11-08 18:49:34.619348506 +0000
+++ XvSetPortAttribute.3.new 2025-11-08 19:02:50.140196328 +0000
@@ -1,5 +1,5 @@
'\" t
-.TH XvSetPortAttribute 3 "libXv 1.0.13" "X Version 11" "libXv Functions"
+.TH XvSetPortAttribute 3 "libXv 1.0.13" "X Version 11" "libXv Functions"
.SH NAME
XvSetPortAttribute \- sets an attribute of a video port
.\"
@@ -18,14 +18,14 @@ Specifies the connection to the X server
Specifies the port for which the attribute is to be used.
.IP \fIattribute\fR 15
Identifies the port attribute to be set by this request.
-Can be one of the table entries under the column "String," below.
+Can be one of the table entries under the column "String" below.
.IP \fIvalue\fR 15
Identifies the value to which \fIattribute\fP is to be set.
-Can be one of the table entries under the column "Type," below.
+Can be one of the table entries under the column "Type" below.
.\"
.SH DESCRIPTION
.BR XvSetPortAttribute (3)
- permits a client to set the port attribute
+permits a client to set the port attribute
to specified values. This request supports the following values:
.PP
.TS
@@ -33,17 +33,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
.PP
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: