Package: libglib2.0-bin
Version: 2.83.4-1
Severity: normal
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?
troff:<stdin>:30: warning: start (0) and end (0) index of substring out of range
an.tmac:<stdin>:30: warning: TH: second argument is not a numeric expression:
an.tmac:<stdin>:30: style: .TH missing third argument; consider document
modification date in ISO 8601 format (YYYY-MM-DD)
an.tmac:<stdin>:30: style: .TH missing fourth argument; consider
package/project name and version (e.g., "groff 1.23.0")
troff:<stdin>:30: warning: name 'an-extra3' not defined
an.tmac:<stdin>:30: style: .TH missing fifth argument and second argument ''
not a recognized manual section; specify its title
an.tmac:<stdin>:381: style: 1 leading space(s) on input line
troff:<stdin>:381: 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.12-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 libglib2.0-bin depends on:
ii libc6 2.40-7
ii libelf1t64 0.192-4
ii libglib2.0-0t64 2.83.4-1
ii libglib2.0-data 2.83.4-1
libglib2.0-bin recommends no packages.
libglib2.0-bin suggests no packages.
-- no debconf information
Input file is gdbus.1
Output from "mandoc -T lint gdbus.1": (shortened list)
1 input text line longer than 80 bytes: The \fB\-\-recurse\f...
1 input text line longer than 80 bytes: This shows how to in...
1 input text line longer than 80 bytes: Waiting for a well\-...
1 input text line longer than 80 bytes: With this informatio...
1 input text line longer than 80 bytes: children (and their ...
1 input text line longer than 80 bytes: representation is pr...
1 missing date, using "": TH
6 skipping paragraph macro: sp after SH
1 whitespace at end of input line
Remove trailing space with: sed -e 's/ *$//'
-.-.
Output from "test-nroff -mandoc -t -ww -z gdbus.1": (shortened list)
1 name 'an-extra3' not defined
1 start (0) and end (0) index of substring out of range
1 trailing space in the line
Remove trailing space with: sed -e 's/ *$//'
-.-.
Show if generated from reStructuredText or rd2
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
-.-.
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"
57:Prints out interfaces and property values for a remote object. For this to
59:\fBorg.freedesktop.DBus.Introspectable\fP interface. If the \fB\-\-xml\fP
option is
61:representation is printed. The \fB\-\-recurse\fP option can be used to
introspect
79:explicit quotes. The return values are printed out as serialized
\fBGVariant\fP
87:Emits a signal. Each argument to include in the signal must be specified as a
95:Waits until \fBbus_name\fP is owned by some process on the bus. If the
96:\fB\-\-activate\fP is specified, that bus name will be auto\-started first.
It may
353:owned on the bus. This is useful in situations where \fBSomeName\fP is not
364:Waiting for a well\-known name and giving up after 30 seconds. By default,
the
-.-.
The name of a man page is typeset in bold and the section in roman
(see man-pages(7)).
381: <dbus\-send(1)>
-.-.
Test nr. 82:
No need for '\&' to be in front of a period (.),
if there is a character in front of it.
Remove with "sed -e 's/\\&\././g'".
70:Monitors one or all objects owned by the owner of \fBbus_name\fP\&.
-.-.
One space only after a possible end of sentence
(after a punctuation, that
can end a sentence).
gdbus.1:57:Prints out interfaces and property values for a remote object. For
this to
gdbus.1:59:\fBorg.freedesktop.DBus.Introspectable\fP interface. If the
\fB\-\-xml\fP option is
gdbus.1:61:representation is printed. The \fB\-\-recurse\fP option can be used
to introspect
gdbus.1:79:explicit quotes. The return values are printed out as serialized
\fBGVariant\fP
gdbus.1:87:Emits a signal. Each argument to include in the signal must be
specified as a
gdbus.1:95:Waits until \fBbus_name\fP is owned by some process on the bus. If
the
gdbus.1:96:\fB\-\-activate\fP is specified, that bus name will be auto\-started
first. It may
gdbus.1:353:owned on the bus. This is useful in situations where \fBSomeName\fP
is not
gdbus.1:364:Waiting for a well\-known name and giving up after 30 seconds. By
default, the
-.-.
Put a subordinate sentence (after a comma) on a new line.
gdbus.1:58:work, the owner of the object needs to implement the
gdbus.1:60:used, the returned introspection XML is printed, otherwise a parsed
pretty
gdbus.1:96:\fB\-\-activate\fP is specified, that bus name will be auto\-started
first. It may
gdbus.1:97:be the same as the bus name being waited for, or different.
gdbus.1:110:destinations, bus names, object paths and interface/method names.
gdbus.1:210:In a similar fashion, the \fBintrospect\fP command can be used to
learn details
gdbus.1:240:With this information, itâs easy to use the \fBcall\fP command to
display a
gdbus.1:316:$ gdbus emit \-\-session \-\-object\-path /foo \-\-signal
org.bar.Foo \(dq[\(aqfoo\(aq, \(aqbar\(aq, \(aqbaz\(aq]\(dq
gdbus.1:352:Auto\-starting a different service, then waiting for a well\-known
name to be
gdbus.1:364:Waiting for a well\-known name and giving up after 30 seconds. By
default, 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.
gdbus.1:30:.TH "GDBUS" "" "" ""
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:30: warning: start (0) and end (0) index of substring out of range
an.tmac:<stdin>:30: warning: TH: second argument is not a numeric expression:
an.tmac:<stdin>:30: style: .TH missing third argument; consider document
modification date in ISO 8601 format (YYYY-MM-DD)
an.tmac:<stdin>:30: style: .TH missing fourth argument; consider
package/project name and version (e.g., "groff 1.23.0")
troff:<stdin>:30: warning: name 'an-extra3' not defined
an.tmac:<stdin>:30: style: .TH missing fifth argument and second argument ''
not a recognized manual section; specify its title
an.tmac:<stdin>:381: style: 1 leading space(s) on input line
troff:<stdin>:381: warning: trailing space in the line
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- gdbus.1 2025-03-10 00:51:26.977800280 +0000
+++ gdbus.1.new 2025-03-10 01:00:49.818274325 +0000
@@ -27,7 +27,7 @@ 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 "GDBUS" "" "" ""
+.TH GDBUS 1 "" ""
.SH NAME
gdbus \- Tool for working with D-Bus objects
.\" This has to be duplicated from above to make it machine-readable by
`reuse`:
@@ -378,6 +378,6 @@ upstream bug tracker <https://gitlab.gno
\&.
.SH SEE ALSO
.sp
- <dbus\-send(1)>
+.BR dbus\-send (1)
.\" 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.
"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)
-.-
