Bug#1087352: insserv.8: Some remarks and editorial changes for this man page
Bjarni Ingi Gislason
bjarniig at simnet.is
Mon Nov 11 23:36:22 GMT 2024
Package: insserv
Version: 1.25.0-1
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with
test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -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?
troff: backtrace: file '<stdin>':230
troff:<stdin>:230: 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.5-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 insserv depends on:
ii libc6 2.40-3
insserv recommends no packages.
Versions of packages insserv suggests:
pn bootchart2 <none>
-- no debconf information
-------------- 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
-.-
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 insserv.8": (possibly shortened list)
mandoc: insserv.8:24:81: STYLE: input text line longer than 80 bytes: insserv \- boot sequ...
mandoc: insserv.8:56:2: WARNING: skipping paragraph macro: PP empty
mandoc: insserv.8:230:13: STYLE: whitespace at end of input line
mandoc: insserv.8:233:103: STYLE: input text line longer than 80 bytes: Specify path to the ...
mandoc: insserv.8:235:106: STYLE: input text line longer than 80 bytes: check for the exista...
mandoc: insserv.8:236:104: STYLE: input text line longer than 80 bytes: /usr/local/etc/insse...
mandoc: insserv.8:253:82: STYLE: input text line longer than 80 bytes: Do not update symlin...
mandoc: insserv.8:391:82: STYLE: input text line longer than 80 bytes: Administrators can f...
mandoc: insserv.8:392:90: STYLE: input text line longer than 80 bytes: by creating a text f...
mandoc: insserv.8:393:88: STYLE: input text line longer than 80 bytes: file lists (one per ...
mandoc: insserv.8:394:86: STYLE: input text line longer than 80 bytes: /etc/init.d/ directo...
-.-.
Remove space characters at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
230:are printed.
-.-.
Change - to \- if it shall be printed as a minus sign.
insserv.8:81:.in -1l
insserv.8:103:.in -1l
insserv.8:114:.in -1l
insserv.8:188:.in -1l
insserv.8:377:.in -1l
insserv.8:388:.in -1l
-.-.
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.
N.B.
The number of lines affected can be too large to be in a patch.
91:keyword declares on which runlevels the script must be started. An empty
228:Perform operations silently. This blocks warning messages
229:from being printed to stderr. Only fatal error messages
233:Specify path to the insserv.conf file (by default located at /etc/insserv.conf). This is typically used
234:for testing purposes. insserv will automatically
235:check for the existance of an insserv configuration directory under this location. For example, specifying
240:in the /etc/init.d directory. When using the \-i flag, the
253:Do not update symlinks. Does not create depend.boot, depend.start, and depend.stop
392:by creating a text file called /etc/insserv/file\-filters. The file\-filters configuration
394:/etc/init.d/ directory. An example of /etc/insserv/file\-filters might look like this:
-.-.
Test nr. 30:
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 24, length 81
insserv \- boot sequence organizer using LSB init.d script dependency information
Line 233, length 103
Specify path to the insserv.conf file (by default located at /etc/insserv.conf). This is typically used
Line 235, length 106
check for the existance of an insserv configuration directory under this location. For example, specifying
Line 236, length 104
/usr/local/etc/insserv.conf will cause insserv to also scan the directory /usr/local/etc/insserv.conf.d/
Line 253, length 82
Do not update symlinks. Does not create depend.boot, depend.start, and depend.stop
Line 391, length 82
Administrators can further filter files by extension in the /etc/init.d/ directory
Line 392, length 90
by creating a text file called /etc/insserv/file\-filters. The file\-filters configuration
Line 393, length 88
file lists (one per line) extensions which should be ignored by insserv as it parses the
Line 394, length 86
/etc/init.d/ directory. An example of /etc/insserv/file\-filters might look like this:
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
insserv.8:62:init script (`boot script') by reading the comment header of the script, e.g.:
insserv.8:166: # (done during boot phase)
insserv.8:176: # (in some cases /usr may be remote).
insserv.8:182: # All network daemons are running (This was removed in LSB 1.2)
insserv.8:233:Specify path to the insserv.conf file (by default located at /etc/insserv.conf). This is typically used
insserv.8:393:file lists (one per line) extensions which should be ignored by insserv as it parses the
insserv.8:420:configuration file which lists file extensions (one per line) we should ignore
-.-.
FSF office address update. See
https://lists.gnu.org/archive/html/bug-gnulib/2024-09/msg00004.html
19:.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":
troff: backtrace: file '<stdin>':230
troff:<stdin>:230: warning: trailing space in the line
-.-.
Spelling: existance -> existence (with "codespell")
-.-
Change unneeded '.PP' to '.' to conserve line numbers in the input file.
-.-
Additionally (general):
FSF office address update. See
https://lists.gnu.org/archive/html/bug-gnulib/2024-09/msg00004.html
The unit 'l' does not exist. For the request '.in' the default unit of 'm'
is then used.
-.-
-------------- next part --------------
--- insserv.8 2024-11-11 22:16:47.041797963 +0000
+++ insserv.8.new 2024-11-11 23:25:07.964921497 +0000
@@ -21,7 +21,8 @@
.TH INSSERV 8 "July 29, 2008" "Version 1.11"
.UC 8
.SH NAME
-insserv \- boot sequence organizer using LSB init.d script dependency information
+insserv \- boot sequence organizer using LSB init.d script dependency \
+information
.SH SYNOPSIS
.\"
.B insserv
@@ -53,7 +54,7 @@ insserv \- boot sequence organizer using
.PP
.B insserv
.B \-h
-.PP
+.
.SH DESCRIPTION
.B insserv
is a low level tool used by
@@ -61,7 +62,7 @@ is a low level tool used by
which enables an installed system
init script (`boot script') by reading the comment header of the script, e.g.:
.sp 1
-.in +1l
+.in +1m
.nf
### BEGIN INIT INFO
# Provides: boot_facility_1 [ boot_facility_2 ...]
@@ -78,7 +79,7 @@ init script (`boot script') by reading t
# Description: multiline_description
### END INIT INFO
.fi
-.in -1l
+.in -1m
.sp 1
and calculating the dependencies between all scripts. It is not recommended to
execute insserv directly unless you know exactly what you're doing, doing so
@@ -88,30 +89,30 @@ is the recommended interface for managin
.PP
The
.B Default\-Start
-keyword declares on which runlevels the script must be started. An empty
-value means the script will never be started.
+keyword declares on which runlevels the script must be started.
+An empty value means the script will never be started.
The same applies for its counterpart
.B Default\-Stop
with the only difference that the script will be stopped.
.PP
Please be aware that the line
.sp 1
-.in +1l
+.in +1m
.nf
# Required-Stop: boot_facility_1 [ boot_facility_2 ...]
.fi
-.in -1l
+.in -1m
.sp 1
declares facilities which must be available during shutdown of the service
declared in the
.B Provides
tag. Same holds true for
.sp 1
-.in +1l
+.in +1m
.nf
# Should-Stop: boot_facility_1 [ boot_facility_2 ...]
.fi
-.in -1l
+.in -1m
.sp 1
which declares facilities which should be available during shutdown of
the service declared in the
@@ -154,13 +155,13 @@ and each file in the directory
Each line which begins with
.B $
and a following name defines a system facility
-accordingly to the Linux Standard Base Specification (LSB),
+accordingly to the Linux Standard Base Specification (LSB).
All names followed by such a system facility
will declare the required dependencies of the facility.
Here is an example for
.IR /etc/insserv.conf :
.sp 1
-.in +1l
+.in +1m
.nf
# All local filesystems are mounted
# (done during boot phase)
@@ -185,7 +186,7 @@ Here is an example for
# Services which need to be interactive
<interactive> boot.crypto
.fi
-.in -1l
+.in -1m
.sp 1
Names starting with a `+' sign are marked as optional.
If the service with the name after the plus sign is
@@ -225,20 +226,26 @@ Currently the following options are reco
Perform operation with more diagnostic messages printed on stderr.
.TP
.BR \-q ,\ \-\-silent
-Perform operations silently. This blocks warning messages
-from being printed to stderr. Only fatal error messages
-are printed.
+Perform operations silently.
+This blocks warning messages from being printed to stderr.
+Only fatal error messages are printed.
.TP
.BR \-c\ <config> ,\ \-\-config\ <config>
-Specify path to the insserv.conf file (by default located at /etc/insserv.conf). This is typically used
-for testing purposes. insserv will automatically
-check for the existance of an insserv configuration directory under this location. For example, specifying
-/usr/local/etc/insserv.conf will cause insserv to also scan the directory /usr/local/etc/insserv.conf.d/
+Specify path to the insserv.conf file
+(by default located at /etc/insserv.conf).
+This is typically used for testing purposes.
+.BR insserv (8)
+will automatically check for the existence of an insserv
+configuration directory under this location.
+For example,
+specifying /usr/local/etc/insserv.conf will cause insserv to also scan the
+directory /usr/local/etc/insserv.conf.d/
.TP
.BR \-i , \ \-\-insserv\-dir
The insserv program will try to place dependency information
-in the /etc/init.d directory. When using the \-i flag, the
-user can specify an alternative directory for dependency information.
+in the /etc/init.d directory.
+When using the \-i flag,
+the user can specify an alternative directory for dependency information.
This is typically used when debugging insserv.
.TP
.BR \-o\ <path> ,\ \-\-override\ <path>
@@ -249,11 +256,12 @@ LSB comment headers of scripts in the in
.BR \-p\ <path> ,\ \-\-path\ <path>
Specify path to init.d directory. Useful for testing.
.TP
-.BR \-n ,\ \-\-dryrun, \ \-\-dry\-run
-Do not update symlinks. Does not create depend.boot, depend.start, and depend.stop
+.BR \-n ,\ \-\-dryrun ,\ \-\-dry\-run
+Do not update symlinks.
+Does not create depend.boot, depend.start, and depend.stop
files.
.TP
-.BR \-s ,\ \-\-showall, \ \-\-show\-all
+.BR \-s ,\ \-\-showall ,\ \-\-show\-all
Output runlevel and sequence information. Do not update symlinks.
.TP
.BR \-r ,\ \-\-remove
@@ -359,7 +367,7 @@ Please be aware that the following patte
boot script file names will be not accepted by
.BR insserv :
.sp 1
-.in +1l
+.in +1m
.nf
*.dpkg*
*.ucf*
@@ -374,24 +382,27 @@ boot script file names will be not accep
*.core
*~
.fi
-.in -1l
+.in -1m
.sp 1
with the wildcard character
.BR * .
Beside this all boot script file names beginning with one
of the following characters
.sp 1
-.in +1l
+.in +1m
.nf
$.#%_+-\e*[]^:()~
.fi
-.in -1l
+.in -1m
.sp 1
will be ignored.
-Administrators can further filter files by extension in the /etc/init.d/ directory
-by creating a text file called /etc/insserv/file\-filters. The file\-filters configuration
-file lists (one per line) extensions which should be ignored by insserv as it parses the
-/etc/init.d/ directory. An example of /etc/insserv/file\-filters might look like this:
+Administrators can further filter files by extension in the /etc/init.d/
+directory by creating a text file called /etc/insserv/file\-filters.
+The file\-filters configuration file lists
+(one per line)
+extensions which should be ignored by insserv as it parses the /etc/init.d/
+directory.
+An example of /etc/insserv/file\-filters might look like this:
.nf
git
svn
More information about the Debian-init-diversity
mailing list