Bug#1095178: sd_bus_message_append.3: Some remarks and a patch with editorial changes for this man page
Bjarni Ingi Gislason
bjarniig at simnet.is
Tue Feb 4 20:51:10 GMT 2025
Package: libsystemd-dev
Version: 257.2-3
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>:2: style: .TH missing third argument; consider document modification date in ISO 8601 format (YYYY-MM-DD)
troff:<stdin>:125: warning: [page 1, 7.4i (diversion '3tbd1,1', 0.0i)]: cannot break line
troff:<stdin>:136: warning: [page 1, 7.4i (diversion '3tbd2,1', 0.0i)]: cannot break line
troff:<stdin>:235: warning: [page 1, 7.4i (diversion '3tbd11,1', 0.0i)]: cannot break line
troff:<stdin>:290: warning: [page 1, 7.4i (diversion '3tbd16,1', 0.0i)]: cannot break line
troff:<stdin>:308: warning: [page 1, 7.4i (diversion '3tbd18,1', 0.0i)]: cannot break line
<stdin>:92: warning: table wider than line length minus indentation
an.tmac:<stdin>:323: warning: .l = 451275u = 90n = 45m, .i = 25000u, TW (table width) = 494330u = 98n = 49m
* 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.11-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 libsystemd-dev depends on:
ii libcap-dev 1:2.66-5+b1
ii libsystemd0 257.2-3
libsystemd-dev recommends no packages.
libsystemd-dev suggests no packages.
-- no debconf information
-------------- next part --------------
Input file is sd_bus_message_append.3
Output from "mandoc -T lint sd_bus_message_append.3": (shortened list)
1 input text line longer than 80 bytes: ")"\&. This sequence...
1 input text line longer than 80 bytes: "v"\&. Corresponding...
1 input text line longer than 80 bytes: "}"\&. The first of ...
1 input text line longer than 80 bytes: (UNIX file descripto...
1 input text line longer than 80 bytes: Functions described ...
1 input text line longer than 80 bytes: On success, these fu...
1 input text line longer than 80 bytes: The type string is c...
1 input text line longer than 80 bytes: describes the types ...
1 input text line longer than 80 bytes: followed by a comple...
1 input text line longer than 80 bytes: sd_bus_message_appen...
1 missing date, using "": TH
5 skipping paragraph macro: PP after SH
1 skipping paragraph macro: PP after SS
1 skipping paragraph macro: br after sp
2 skipping paragraph macro: sp after SH
-.-.
Output from "test-groff -mandoc -t -ww -z sd_bus_message_append.3": (shortened list)
1 .l = 451275u = 90n = 45m, .i = 25000u, TW (table width) = 494330u = 98n = 49m
5 cannot break line
1 table wider than line length minus indentation
-.-.
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)
489 \%https://dbus.freedesktop.org/doc/dbus-specification.html#type-system
-.-.
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 "\&".
40:\fIm\fR\&. The type string
42:describes the types of the field arguments that follow\&. For each type specified in the type string, one or more arguments need to be specified, in the same order as declared in the type string\&.
44:The type string is composed of the elements shown in the table below\&. It contains zero or more single "complete types"\&. Each complete type may be one of the basic types or a fully described container type\&. A container type may be a structure with the contained types, a variant, an array with its element type, or a dictionary entry with the contained types\&. The type string is
52:")"\&. This sequence cannot be empty \(em it must contain at least one type\&. Arguments corresponding to this nested sequence follow the same rules as if they were not nested\&.
55:"v"\&. Corresponding arguments must begin with a type string denoting a complete type, and following that, arguments corresponding to the specified type\&.
59:followed by a complete type\&. Corresponding arguments must begin with the number of entries in the array, followed by the entries themselves, matching the element type of the array\&.
66:"}"\&. The first of those types must be a basic type\&. Corresponding arguments must begin with the number of dictionary entries, followed by a pair of values for each entry matching the element type of the dictionary entries\&.
72:instead of a variable number of arguments\&. This function does not call the
74:macro\&. Because it invokes the
331:\fBNULL\fR, which is equivalent to an empty string\&. For
333:(UNIX file descriptor), the descriptor is duplicated by this call and the passed descriptor stays in possession of the caller\&. See
441:On success, these functions return a non\-negative integer\&. On failure, they return a negative errno\-style error code\&.
477:\fBgetenv\fR(3), which is declared to be not multi\-thread\-safe\&. This means that the code calling the functions described here must not call
479:from a parallel thread\&. It is recommended to only do calls to
-.-.
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 23, length 105
sd_bus_message_append, sd_bus_message_appendv \- Attach fields to a D\-Bus message based on a type string
Line 32, length 92
.BI "int sd_bus_message_append(sd_bus_message\ *" "m" ", const\ char\ *" "types" ", \&...);"
Line 34, length 105
.BI "int sd_bus_message_appendv(sd_bus_message\ *" "m" ", const\ char\ *" "types" ", va_list\ " "ap" ");"
Line 42, length 197
describes the types of the field arguments that follow\&. For each type specified in the type string, one or more arguments need to be specified, in the same order as declared in the type string\&.
Line 44, length 385
The type string is composed of the elements shown in the table below\&. It contains zero or more single "complete types"\&. Each complete type may be one of the basic types or a fully described container type\&. A container type may be a structure with the contained types, a variant, an array with its element type, or a dictionary entry with the contained types\&. The type string is
Line 52, length 178
")"\&. This sequence cannot be empty \(em it must contain at least one type\&. Arguments corresponding to this nested sequence follow the same rules as if they were not nested\&.
Line 55, length 155
"v"\&. Corresponding arguments must begin with a type string denoting a complete type, and following that, arguments corresponding to the specified type\&.
Line 59, length 184
followed by a complete type\&. Corresponding arguments must begin with the number of entries in the array, followed by the entries themselves, matching the element type of the array\&.
Line 66, length 228
"}"\&. The first of those types must be a basic type\&. Corresponding arguments must begin with the number of dictionary entries, followed by a pair of values for each entry matching the element type of the dictionary entries\&.
Line 333, length 132
(UNIX file descriptor), the descriptor is duplicated by this call and the passed descriptor stays in possession of the caller\&. See
Line 441, length 123
On success, these functions return a non\-negative integer\&. On failure, they return a negative errno\-style error code\&.
Line 472, length 112
Functions described here are available as a shared library, which can be compiled against and linked to with the
Line 477, length 143
\fBgetenv\fR(3), which is declared to be not multi\-thread\-safe\&. This means that the code calling the functions described here must not call
Line 484, length 149
\fBsystemd\fR(1), \fBsd-bus\fR(3), \fBsd_bus_message_append_basic\fR(3), \fBsd_bus_message_append_array\fR(3), \fBsd_bus_message_open_container\fR(3)
-.-.
No need for "\&" to be in front of a period (.),
if there is a character in front of it
28:#include <systemd/sd\-bus\&.h>
40:\fIm\fR\&. The type string
42:describes the types of the field arguments that follow\&. For each type specified in the type string, one or more arguments need to be specified, in the same order as declared in the type string\&.
44:The type string is composed of the elements shown in the table below\&. It contains zero or more single "complete types"\&. Each complete type may be one of the basic types or a fully described container type\&. A container type may be a structure with the contained types, a variant, an array with its element type, or a dictionary entry with the contained types\&. The type string is
45:\fBNUL\fR\-terminated\&.
47:In case of a basic type, one argument of the corresponding type is expected\&.
52:")"\&. This sequence cannot be empty \(em it must contain at least one type\&. Arguments corresponding to this nested sequence follow the same rules as if they were not nested\&.
55:"v"\&. Corresponding arguments must begin with a type string denoting a complete type, and following that, arguments corresponding to the specified type\&.
59:followed by a complete type\&. Corresponding arguments must begin with the number of entries in the array, followed by the entries themselves, matching the element type of the array\&.
66:"}"\&. The first of those types must be a basic type\&. Corresponding arguments must begin with the number of dictionary entries, followed by a pair of values for each entry matching the element type of the dictionary entries\&.
72:instead of a variable number of arguments\&. This function does not call the
74:macro\&. Because it invokes the
78:is undefined after the call\&.
81:\m[blue]\fBD\-Bus Specification\fR\m[]\&\s-2\u[1]\d\s+2\&.
331:\fBNULL\fR, which is equivalent to an empty string\&. For
333:(UNIX file descriptor), the descriptor is duplicated by this call and the passed descriptor stays in possession of the caller\&. See
335:for the precise interpretation of those and other types\&.
385:double d = 8\&.0;
441:On success, these functions return a non\-negative integer\&. On failure, they return a negative errno\-style error code\&.
448:Specified parameter is invalid\&.
453:Message has been sealed\&.
458:Message is in invalid state\&.
463:Message cannot be appended to\&.
468:Memory allocation failed\&.
474:file\&.
477:\fBgetenv\fR(3), which is declared to be not multi\-thread\-safe\&. This means that the code calling the functions described here must not call
479:from a parallel thread\&. It is recommended to only do calls to
481:from an early phase of the program when no other threads have been started\&.
-.-.
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.
2:.TH "SD_BUS_MESSAGE_APPEND" "3" "" "systemd 257.2" "sd_bus_message_append"
22:.SH "NAME"
24:.SH "SYNOPSIS"
32:.BI "int sd_bus_message_append(sd_bus_message\ *" "m" ", const\ char\ *" "types" ", \&...);"
34:.BI "int sd_bus_message_appendv(sd_bus_message\ *" "m" ", const\ char\ *" "types" ", va_list\ " "ap" ");"
35:.SH "DESCRIPTION"
355:.SH "EXAMPLES"
442:.SS "Errors"
470:.SH "NOTES"
485:.SH "NOTES"
-.-.
Use ".na" (no adjustment) instead of ".ad l" and then ".ad" to begin the
same adjustment again as before
18:.ad l
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":
an.tmac:<stdin>:2: style: .TH missing third argument; consider document modification date in ISO 8601 format (YYYY-MM-DD)
troff:<stdin>:125: warning: [page 1, 7.4i (diversion '3tbd1,1', 0.0i)]: cannot break line
troff:<stdin>:136: warning: [page 1, 7.4i (diversion '3tbd2,1', 0.0i)]: cannot break line
troff:<stdin>:235: warning: [page 1, 7.4i (diversion '3tbd11,1', 0.0i)]: cannot break line
troff:<stdin>:290: warning: [page 1, 7.4i (diversion '3tbd16,1', 0.0i)]: cannot break line
troff:<stdin>:308: warning: [page 1, 7.4i (diversion '3tbd18,1', 0.0i)]: cannot break line
<stdin>:92: warning: table wider than line length minus indentation
an.tmac:<stdin>:323: warning: .l = 451275u = 90n = 45m, .i = 25000u, TW (table width) = 494330u = 98n = 49m
-.-.
Additionally:
Increase the line length for the table so warnings are no more issued.
Define and use a column width for the second and fourth column.
Shorten the page offset in troff-mode to accomodate the table on A4 and
letter paper.
-------------- next part --------------
--- sd_bus_message_append.3 2025-02-04 02:37:05.003367039 +0000
+++ sd_bus_message_append.3.new 2025-02-04 06:22:09.801326857 +0000
@@ -1,5 +1,5 @@
'\" t
-.TH "SD_BUS_MESSAGE_APPEND" "3" "" "systemd 257.2" "sd_bus_message_append"
+.TH SD_BUS_MESSAGE_APPEND 3 "" "systemd 257.2" sd_bus_message_append
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -15,79 +15,125 @@
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
-.ad l
+.na
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
-.SH "NAME"
-sd_bus_message_append, sd_bus_message_appendv \- Attach fields to a D\-Bus message based on a type string
-.SH "SYNOPSIS"
-.sp
+.SH NAME
+sd_bus_message_append, sd_bus_message_appendv \- Attach fields to a D\-Bus
+message based on a type string
+.SH SYNOPSIS
.ft B
.nf
-#include <systemd/sd\-bus\&.h>
+#include <systemd/sd\-bus.h>
.fi
.ft
.HP \w'int\ sd_bus_message_append('u
-.BI "int sd_bus_message_append(sd_bus_message\ *" "m" ", const\ char\ *" "types" ", \&...);"
+.BI "int sd_bus_message_append(sd_bus_message\ *" m ", const\ char\ *" types \
+", ...);"
.HP \w'int\ sd_bus_message_appendv('u
-.BI "int sd_bus_message_appendv(sd_bus_message\ *" "m" ", const\ char\ *" "types" ", va_list\ " "ap" ");"
-.SH "DESCRIPTION"
-.PP
+.BI "int sd_bus_message_appendv(sd_bus_message\ *" m ", const\ char\ *" \
+types ", va_list\ " ap );
+.SH DESCRIPTION
The
\fBsd_bus_message_append()\fR
function appends a sequence of fields to the D\-Bus message object
-\fIm\fR\&. The type string
-\fItypes\fR
-describes the types of the field arguments that follow\&. For each type specified in the type string, one or more arguments need to be specified, in the same order as declared in the type string\&.
-.PP
-The type string is composed of the elements shown in the table below\&. It contains zero or more single "complete types"\&. Each complete type may be one of the basic types or a fully described container type\&. A container type may be a structure with the contained types, a variant, an array with its element type, or a dictionary entry with the contained types\&. The type string is
-\fBNUL\fR\-terminated\&.
+\fIm\fR.
+The type string \fItypes\fR
+describes the types of the field arguments that follow.
+For each type specified in the type string,
+one or more arguments need to be specified,
+in the same order as declared in the type string.
+.PP
+The type string is composed of the elements shown in the table below.
+It contains zero
+or more single "complete types".
+Each complete type may be one of the basic types
+or a fully described container type.
+A container type may be a structure with the contained types,
+a variant,
+an array with its element type,
+or a dictionary entry with the contained
+types.
+The type string is
+\fBNUL\fR\-terminated.
.PP
-In case of a basic type, one argument of the corresponding type is expected\&.
+In case of a basic type,
+one argument of the corresponding type is expected.
.PP
A structure is denoted by a sequence of complete types between
"("
and
-")"\&. This sequence cannot be empty \(em it must contain at least one type\&. Arguments corresponding to this nested sequence follow the same rules as if they were not nested\&.
+")".
+This sequence cannot be empty \(em it must contain at least one type.
+Arguments corresponding to this nested sequence follow the same rules
+as if they were not nested.
.PP
A variant is denoted by
-"v"\&. Corresponding arguments must begin with a type string denoting a complete type, and following that, arguments corresponding to the specified type\&.
+"v".
+Corresponding arguments must begin with a type string denoting a complete
+type,
+and following that,
+arguments corresponding to the specified type.
.PP
An array is denoted by
"a"
-followed by a complete type\&. Corresponding arguments must begin with the number of entries in the array, followed by the entries themselves, matching the element type of the array\&.
+followed by a complete type.
+Corresponding arguments must begin with the number of entries in the array,
+followed by the entries themselves,
+matching the element type of the array.
.PP
-A dictionary is an array of dictionary entries, denoted by
-"a"
+A dictionary is an array of dictionary entries,
+denoted by "a"
followed by a pair of complete types between
"{"
and
-"}"\&. The first of those types must be a basic type\&. Corresponding arguments must begin with the number of dictionary entries, followed by a pair of values for each entry matching the element type of the dictionary entries\&.
+"}".
+The first of those types must be a basic type.
+Corresponding arguments must begin with the number of dictionary entries,
+followed by a pair of values for each entry
+matching the element type of the dictionary entries.
.PP
\fBsd_bus_message_appendv()\fR
is equivalent to
-\fBsd_bus_message_append()\fR, except that it is called with a
-"va_list"
-instead of a variable number of arguments\&. This function does not call the
+\fBsd_bus_message_append()\fR,
+except that it is called with a "va_list"
+instead of a variable number of arguments.
+This function does not call the
\fBva_end()\fR
-macro\&. Because it invokes the
+macro.
+Because it invokes the
\fBva_arg()\fR
-macro, the value of
+macro,
+the value of
\fIap\fR
-is undefined after the call\&.
+is undefined after the call.
.PP
-For further details on the D\-Bus type system, please consult the
-\m[blue]\fBD\-Bus Specification\fR\m[]\&\s-2\u[1]\d\s+2\&.
+For further details on the D\-Bus type system,
+please consult the
+\m[blue]\fBD\-Bus Specification\fR\m[]\&\s-2\u[1]\d\s+2.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
-.br
+.\".br
.B Table\ \&1.\ \&Item type specifiers
+.nr ol \n(.lu
+.ie n \{\
+. ll 98m
+.\}
+.el \{\
+. nr te \n(.l/1m
+. tm current line length \n(.lu, \n(tem
+. ll \n(.lu+\n(.ou+2m
+. po \n(.ou-2m
+.\}
+.nr w1 \w'\fBSD_BUS_TYPE_DICT_ENTRY_BEGIN\fR'u
+.nr w4 \w'determined by'u
+.in 0m
.TS
allbox tab(:);
-lB lB lB lB lB.
+lB lBw(\n(w1u) lB lBw(\n(w4u) lB.
T{
Specifier
T}:T{
@@ -100,25 +146,7 @@ T}:T{
Expected C Type
T}
.T&
-l l l l l
-l l l l l
-l l l l l
-l l l l l
-l l l l l
-l l l l l
-l l l l l
-l l l l l
-l l l l l
-l l l l l
-l l l l l
-l l l l l
-l l l l l
-l l l l l
-l l l l l
-l l l l l
-l l l ^ ^
-l l l l l
-l l l ^ ^.
+l l l l l .
T{
"y"
T}:T{
@@ -291,17 +319,22 @@ T}:T{
T}:T{
array start
T}:T{
-determined by the nested types
+determined by the nested
+types
T}:T{
structure contents
T}
+.T&
+l l l ^ ^
+l l l l l
+l l l ^ ^.
T{
")"
T}:T{
\fBSD_BUS_TYPE_STRUCT_END\fR
T}:T{
array end
-T}::
+T}
T{
"{"
T}:T{
@@ -309,7 +342,8 @@ T}:T{
T}:T{
dictionary entry start
T}:T{
-determined by the nested types
+determined by the nested
+types
T}:T{
dictionary contents
T}
@@ -319,22 +353,28 @@ T}:T{
\fBSD_BUS_TYPE_DICT_ENTRY_END\fR
T}:T{
dictionary entry end
-T}::
+T}
.TE
-.sp 1
+.ie t \{\
+. po \n(.ou+2m
+.\}
+.ll \n(olu
.PP
For types
"s"
and
"g"
-(unicode string or signature), the pointer may be
-\fBNULL\fR, which is equivalent to an empty string\&. For
-"h"
-(UNIX file descriptor), the descriptor is duplicated by this call and the passed descriptor stays in possession of the caller\&. See
-\fBsd_bus_message_append_basic\fR(3)
-for the precise interpretation of those and other types\&.
+(unicode string or signature),
+the pointer may be
+\fBNULL\fR,
+which is equivalent to an empty string.
+For "h"
+(UNIX file descriptor),
+the descriptor is duplicated by this call
+and the passed descriptor stays in possession of the caller.
+See \fBsd_bus_message_append_basic\fR(3)
+for the precise interpretation of those and other types.
.SH "TYPES STRING GRAMMAR"
-.sp
.if n \{\
.RS 4
.\}
@@ -352,8 +392,7 @@ dictionary ::= "a" "{" basic_type comple
.if n \{\
.RE
.\}
-.SH "EXAMPLES"
-.PP
+.SH EXAMPLES
Append a single basic type (the string
"a string"):
.sp
@@ -382,7 +421,7 @@ int32_t i = 4;
uint32_t u = 5;
int32_t x = 6;
uint32_t t = 7;
-double d = 8\&.0;
+double d = 8.0;
sd_bus_message_append(m, "ynqiuxtd", y, n, q, i, u, x, t, d);
.fi
.if n \{\
@@ -413,7 +452,9 @@ sd_bus_message_append(m, "ah", 3, STDIN_
.RE
.\}
.PP
-Append a variant, with the real type "g" (signature), and value "sdbusisgood":
+Append a variant,
+with the real type "g" (signature),
+and value "sdbusisgood":
.sp
.if n \{\
.RS 4
@@ -437,54 +478,60 @@ sd_bus_message_append(m, "a{is}", 3, 1,
.RE
.\}
.SH "RETURN VALUE"
-.PP
-On success, these functions return a non\-negative integer\&. On failure, they return a negative errno\-style error code\&.
-.SS "Errors"
-.PP
+On success,
+these functions return a non\-negative integer.
+On failure,
+they return a negative errno\-style error code.
+.SS Errors
Returned errors may indicate the following problems:
.PP
\fB\-EINVAL\fR
.RS 4
-Specified parameter is invalid\&.
+Specified parameter is invalid.
.RE
.PP
\fB\-EPERM\fR
.RS 4
-Message has been sealed\&.
+Message has been sealed.
.RE
.PP
\fB\-ESTALE\fR
.RS 4
-Message is in invalid state\&.
+Message is in invalid state.
.RE
.PP
\fB\-ENXIO\fR
.RS 4
-Message cannot be appended to\&.
+Message cannot be appended to.
.RE
.PP
\fB\-ENOMEM\fR
.RS 4
-Memory allocation failed\&.
+Memory allocation failed.
.RE
-.SH "NOTES"
-.PP
-Functions described here are available as a shared library, which can be compiled against and linked to with the
+.SH NOTES
+Functions described here are available as a shared library,
+which can be compiled against
+and linked to with the
\fBlibsystemd\fR\ \&\fBpkg-config\fR(1)
-file\&.
+file.
.PP
The code described here uses
-\fBgetenv\fR(3), which is declared to be not multi\-thread\-safe\&. This means that the code calling the functions described here must not call
+\fBgetenv\fR(3),
+which is declared to be not multi\-thread\-safe.
+This means that the code calling the functions described here must not call
\fBsetenv\fR(3)
-from a parallel thread\&. It is recommended to only do calls to
+from a parallel thread.
+It is recommended to only do calls to
\fBsetenv()\fR
-from an early phase of the program when no other threads have been started\&.
+from an early phase of the program
+when no other threads have been started.
.SH "SEE ALSO"
-.PP
-\fBsystemd\fR(1), \fBsd-bus\fR(3), \fBsd_bus_message_append_basic\fR(3), \fBsd_bus_message_append_array\fR(3), \fBsd_bus_message_open_container\fR(3)
-.SH "NOTES"
+\fBsystemd\fR(1), \fBsd-bus\fR(3), \fBsd_bus_message_append_basic\fR(3),
+\fBsd_bus_message_append_array\fR(3), \fBsd_bus_message_open_container\fR(3)
+.SH NOTES
.IP " 1." 4
D-Bus Specification
.RS 4
-\%https://dbus.freedesktop.org/doc/dbus-specification.html#type-system
+\%https://dbus.freedesktop.org/\:doc/\:dbus-specification.html#type-system
.RE
-------------- next part --------------
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 -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)
-.-
More information about the Pkg-systemd-maintainers
mailing list