[Pkg-utopia-maintainers] Bug#1089746: dbus-update-activation-environment.1: Some remarks about this man page

Thu Dec 12 03:02:18 GMT 2024

Package: dbus-bin
Version: 1.15.90-1
Severity: minor
Tags: upstream

   * What led up to the situation?

     Checking for defects with a new version

test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -z < "man page"

  [Use "groff -e ' $' <file>" to find 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>:9: style: .TH missing third argument; consider document modification date in ISO 8601 format (YYYY-MM-DD)
troff:<stdin>:33: 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.11.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 dbus-bin depends on:
ii  libc6        2.40-4
ii  libdbus-1-3  1.15.90-1

dbus-bin recommends no packages.

dbus-bin suggests no packages.

-- no debconf information
-------------- next part --------------
Input file is dbus-update-activation-environment.1

  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

-.-

  So any 'generator' should check its products with the above mentioned
'groff', 'mandoc',  and additionally with 'nroff ...'.

  This is just a simple quality control measure.

  The 'generator' may have to be corrected to get a better man page,
the source file may, and any additional file may.

  Common defects:

  Input text line longer than 80 bytes.

  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.
Lines should thus be shorter.

  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 of '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)

-.-.

Output from "mandoc -T lint  dbus-update-activation-environment.1": (shortened list)

     11 input text line longer than 80 bytes
      1 missing date, using ""
     10 skipping paragraph macro
      1 whitespace at end of input line

-.-.

Output from "test-groff -mandoc -t -ww -z dbus-update-activation-environment.1": (shortened list)

      1 trailing space in the line

-.-.

Output from "mandoc -T lint  dbus-update-activation-environment.1":

mandoc: dbus-update-activation-environment.1:9:32: WARNING: missing date, using "": TH
mandoc: dbus-update-activation-environment.1:30:89: STYLE: input text line longer than 80 bytes: dbus-update-activati...
mandoc: dbus-update-activation-environment.1:33:120: STYLE: whitespace at end of input line
mandoc: dbus-update-activation-environment.1:35:2: WARNING: skipping paragraph macro: PP after SH
mandoc: dbus-update-activation-environment.1:46:81: STYLE: input text line longer than 80 bytes: is available on D\-B...
mandoc: dbus-update-activation-environment.1:60:114: STYLE: input text line longer than 80 bytes: may be set, but thei...
mandoc: dbus-update-activation-environment.1:66:2: WARNING: skipping paragraph macro: PP after SH
mandoc: dbus-update-activation-environment.1:75:105: STYLE: input text line longer than 80 bytes: Set environment vari...
mandoc: dbus-update-activation-environment.1:80:99: STYLE: input text line longer than 80 bytes: Output messages to s...
mandoc: dbus-update-activation-environment.1:101:2: WARNING: skipping paragraph macro: PP after SH
mandoc: dbus-update-activation-environment.1:103:134: STYLE: input text line longer than 80 bytes: is primarily designe...
mandoc: dbus-update-activation-environment.1:159:2: WARNING: skipping paragraph macro: PP after SH
mandoc: dbus-update-activation-environment.1:161:265: STYLE: input text line longer than 80 bytes: exits with status 0 ...
mandoc: dbus-update-activation-environment.1:163:2: WARNING: skipping paragraph macro: PP after SH
mandoc: dbus-update-activation-environment.1:170:2: WARNING: skipping paragraph macro: PP after SH
mandoc: dbus-update-activation-environment.1:172:88: STYLE: input text line longer than 80 bytes: does not provide a w...
mandoc: dbus-update-activation-environment.1:178:145: STYLE: input text line longer than 80 bytes: POSIX does not speci...
mandoc: dbus-update-activation-environment.1:184:140: STYLE: input text line longer than 80 bytes: assumes that any nam...
mandoc: dbus-update-activation-environment.1:186:2: WARNING: skipping paragraph macro: PP after SH
mandoc: dbus-update-activation-environment.1:190:2: WARNING: skipping paragraph macro: PP after SH
mandoc: dbus-update-activation-environment.1:194:2: WARNING: skipping paragraph macro: PP after SH
mandoc: dbus-update-activation-environment.1:201:2: WARNING: skipping paragraph macro: br after SH
mandoc: dbus-update-activation-environment.1:205:159: STYLE: input text line longer than 80 bytes: This man page is dis...

-.-.

Remove space characters at the end of lines.

Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".

33:\fBdbus\-update\-activation\-environment\fR [\-\-systemd] [\-\-verbose] \-\-all | \fIVAR\fR... | \fIVAR\fR=\fIVAL\fR... 
123:      
152:      

-.-.

Strings longer than 3/4 of a standard line length (80)
Use "\:" to split the string at the end of an output line, for example a
long URLs (web address)

188 \m[blue]\fBhttps://www\&.freedesktop\&.org/wiki/Software/dbus/\fR\m[]\&.
192 \m[blue]\fBhttps://dbus\&.freedesktop\&.org/doc/AUTHORS\fR\m[]

-.-.

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 abbreviation point as such by suffixing them with &.

33:\fBdbus\-update\-activation\-environment\fR [\-\-systemd] [\-\-verbose] \-\-all | \fIVAR\fR... | \fIVAR\fR=\fIVAL\fR... 
51:\fBsystemd\fR\&. This is very similar to the
60:may be set, but their values will be overridden when a service is started\&. For instance, it is not useful to add
88:\fBdbus\-update\-activation\-environment\fR, set it to the same value for D\-Bus services\&. Its value must be UTF\-8 (if not, it is skipped with a warning)\&. If
161:exits with status 0 on success, EX_USAGE (64) on invalid command\-line options, EX_OSERR (71) if unable to connect to the session bus, or EX_UNAVAILABLE (69) if unable to set the environment variables\&. Other nonzero exit codes might be added in future versions\&.
182:supports environment variables with non\-UTF\-8 names or values\&. Accordingly,
187:Please send bug reports to the D\-Bus bug tracker or mailing list\&. See
205:This man page is distributed under the same terms as dbus\-update\-activation\-environment (MIT/X11)\&. There is NO WARRANTY, to the extent permitted by law\&.

-.-.

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 30, length 89

dbus-update-activation-environment \- update environment used for D\-Bus session services

Line 33, length 120

\fBdbus\-update\-activation\-environment\fR [\-\-systemd] [\-\-verbose] \-\-all | \fIVAR\fR... | \fIVAR\fR=\fIVAL\fR... 

Line 46, length 81

is available on D\-Bus, it also updates the list of environment variables used by

Line 60, length 114

may be set, but their values will be overridden when a service is started\&. For instance, it is not useful to add

Line 63, length 95

\fBdbus\-daemon\fR\*(Aqs activation environment, although it might still be useful to add it to

Line 75, length 105

Set environment variables for systemd user services as well as for traditional D\-Bus session services\&.

Line 80, length 99

Output messages to standard error explaining what dbus\-update\-activation\-environment is doing\&.

Line 88, length 162

\fBdbus\-update\-activation\-environment\fR, set it to the same value for D\-Bus services\&. Its value must be UTF\-8 (if not, it is skipped with a warning)\&. If

Line 103, length 134

is primarily designed to be used in Linux distributions\*(Aq X11 session startup scripts, in conjunction with the "user bus" design\&.

Line 161, length 265

exits with status 0 on success, EX_USAGE (64) on invalid command\-line options, EX_OSERR (71) if unable to connect to the session bus, or EX_UNAVAILABLE (69) if unable to set the environment variables\&. Other nonzero exit codes might be added in future versions\&.

Line 172, length 88

does not provide a way to unset environment variables after they have been set (although

Line 178, length 145

POSIX does not specify the encoding of non\-ASCII environment variable names or values and allows them to contain any non\-zero byte, but neither

Line 184, length 140

assumes that any name or value that appears to be valid UTF\-8 is intended to be UTF\-8, and ignores other names or values with a warning\&.

Line 205, length 159

This man page is distributed under the same terms as dbus\-update\-activation\-environment (MIT/X11)\&. There is NO WARRANTY, to the extent permitted by law\&.

-.-.

Show if docman-to-man created this

4:.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>

-.-.

Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".

dbus-update-activation-environment.1:88:\fBdbus\-update\-activation\-environment\fR, set it to the same value for D\-Bus services\&. Its value must be UTF\-8 (if not, it is skipped with a warning)\&. If

-.-.

No need for "\&" to be in front of a period (.) if not at the beginning of
a line.

9:.TH "DBUS\-UPDATE\-ACTIVA" "1" "" "D\-Bus 1\&.15\&.90" "User Commands"
60:may be set, but their values will be overridden when a service is started\&. For instance, it is not useful to add
161:exits with status 0 on success, EX_USAGE (64) on invalid command\-line options, EX_OSERR (71) if unable to connect to the session bus, or EX_UNAVAILABLE (69) if unable to set the environment variables\&. Other nonzero exit codes might be added in future versions\&.
182:supports environment variables with non\-UTF\-8 names or values\&. Accordingly,
187:Please send bug reports to the D\-Bus bug tracker or mailing list\&. See
205:This man page is distributed under the same terms as dbus\-update\-activation\-environment (MIT/X11)\&. There is NO WARRANTY, to the extent permitted by law\&.

-.-.

Output from "test-groff  -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":

an.tmac:<stdin>:9: style: .TH missing third argument; consider document modification date in ISO 8601 format (YYYY-MM-DD)
troff:<stdin>:33: warning: trailing space in the line

-.-

  Additionally (general):

  Abbreviations get a '\&' added after their final full stop (.) to mark them
as such and not as an end of a sentence.

  There is no need to add a '\&' before a full stop (.) if it has a character
before it!