Bug#919610: insserv.8: Corrections of formatting and macro use in the manual
[2019-01-20 17:31] Bjarni Ingi Gislason > > > Input file is insserv.8 > > >[...] > > > > Dear submitter, that you for your contribution. Unfortunately, your > > patch can not be used easily, since it alters not source (insserv.8.in), > > but preprocessed version. > > > > Would you be so kind to rebase your patch on insserv.8.in? > > Alternatively, we could wait for upstream maintainer to release new > > version with your changes incorporated, but this way your changes may > > miss Buster. > > Thanks for the tip. I did not check the homepage. That is better. Thank you. Uploaded. But it would be even better to make patch aganist source package, not upstream release, since your patch slightly conflicted with other patch. I dealt with it, but following would make things even more smooth: $ dgit clone $ $ git commit $ git send-patch ... pgpGSc3mW2IQF.pgp Description: PGP signature
Bug#919610: insserv.8: Corrections of formatting and macro use in the manual
On Sat, Jan 19, 2019 at 07:34:29PM +, Dmitry Bogatov wrote: > > control: tags -1 +fixed-upstream > > [2019-01-18 01:31] Bjarni Ingi Gislason > > Package: insserv > > Version: 1.18.0-1 > > Severity: minor > > Tags: patch > > > > Dear Maintainer, > > > > Input file is insserv.8 > >[...] > > Dear submitter, that you for your contribution. Unfortunately, your > patch can not be used easily, since it alters not source (insserv.8.in), > but preprocessed version. > > Would you be so kind to rebase your patch on insserv.8.in? > Alternatively, we could wait for upstream maintainer to release new > version with your changes incorporated, but this way your changes may > miss Buster. Thanks for the tip. I did not check the homepage. >From 53d01b3c74363e9b3b50c9624d3e341a6f647f57 Mon Sep 17 00:00:00 2001 From: Bjarni Ingi Gislason Date: Sun, 20 Jan 2019 17:14:40 + Subject: [PATCH] insserv.8.in: Formatting and spelling corrections to the manual There are eleven options, not nine. ### ".in 1l". There is no unit with the symbol 'l' (ell). Changed to 'm' as 'l' is interpreted as beeing the default unit 'm' (emm). ### Correct spelling: begining -> beginning ### mandoc: insserv.8.in:117:28: STYLE: whitespace at end of input line mandoc: insserv.8.in:141:46: STYLE: whitespace at end of input line mandoc: insserv.8.in:22:15: STYLE: normalizing date format to: July 29, 2008 mandoc: insserv.8.in:25:15: STYLE: normalizing date format to: July 29, 2008 mandoc: insserv.8.in:378:2: WARNING: empty block: RS ### Remove space characters at the end of lines. 117:the service declared in the 141:services now depend on the specifying script. # :59 (macro RB): only 1 argument, but more are expected :62 (macro RB): only 1 argument, but more are expected :338 (macro IR): only 1 argument, but more are expected :351 (macro IR): only 1 argument, but more are expected :353 (macro IR): only 1 argument, but more are expected :382 (macro BR): only 1 argument, but more are expected an-end-check:: Warning: Nonequal number of .RS and .RE calls, an-RS-open=1 at end of file Change '-' (\-) to '\(en' (en-dash) for a numeric range. insserv.8.in:470:2000\-2009 Werner Fink, insserv.8.in:474:2000\-2003 SuSE GmbH Nuernberg, Germany, insserv.8.in:476:2007\-2009 SuSE Linux Products GmbH Nuernberg, Germany. # Reduce space between words. 446:.I /etc/init.d/.depend.stop # Use the correct macro for the font change of a single argument. 59:.RB /usr/lib/lsb/install_initd 62:.RB /usr/lib/lsb/remove_initd # Use "\e" to print the escape character instead of "\\" (which gets interpreted in copy mode). 410:$.#%_+-\\*[]^:()~ # Test nr. 21: Use a macro to change to the italic font, instead of \fI [1], if possible. The macros have the italic corrections, but "\c" removes them. 147:directories (see \fI init.d\fR (7)). # Add a comma (or \&) after "e.g." and "i.e.", or use English words (man-pages(7) [package "manpages"]). 223:as an interactive one, e.g. a service which requires # Wrong distance between sentences or protect the indicator. a) Separate the sentences and subordinate clauses; each begins on a new line. See man-pages(7) [package "manpages"] and "info groff". Or b) Adjust space between sentences (two spaces), c) or protect the indicator by adding "\&" after it. The "indicator" is an "end-of-sentence character" (.!?). The amount of space in the output can then be controlled with the ".ss" request. 119:tag. In both cases the script system should avoid stopping services 140:the specified service names. Both implies that those 223:as an interactive one, e.g. a service which requires 274:Output runlevel and sequence information. Do not update symlinks. 284:Ignore if a required service is missed. Beside this if start and or 321:the runlevels. If a path is used it 343:the runlevels. If a path is used it 416:Boot scripts sometimes lack a LSB comment header. Contact a package # Split a punctuation mark from a single argument for a two-fonts marco 382:.BR insserv: Signed-off-by: Bjarni Ingi Gislason # --- insserv.8.in | 92 +++- 1 file changed, 47 insertions(+), 45 deletions(-) diff --git a/insserv.8.in b/insserv.8.in index 771d74b..f152574 100644 --- a/insserv.8.in +++ b/insserv.8.in @@ -19,10 +19,10 @@ .\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA .\" @@BEGIN_SUSE@@ -.TH INSSERV 8 "Jul 29, 2008" "Version 1.11" "The SuSE boot concept" +.TH INSSERV 8 "July 29, 2008" "Version 1.11" "The SuSE boot concept" .UC 8 @@ELSE_SUSE@@ -.TH INSSERV 8 "Jul 29, 2008" "Version 1.11" +.TH INSSERV 8 "July 29, 2008" "Version 1.11" .UC 8 @@END_SUSE@@ .SH NAME @@ -37,12 +37,14 @@ insserv \- Enable an installed system init script .RB [ \-f ] .RI [[ / ] path/to/init.d/ ] script \ ... .PP +.ad l .B insserv .RB [ \-v ] .RB [ \-c\ ] .RB [ \-p\ ] .RI [[ / ]
Bug#919610: insserv.8: Corrections of formatting and macro use in the manual
control: tags -1 +fixed-upstream [2019-01-18 01:31] Bjarni Ingi Gislason > Package: insserv > Version: 1.18.0-1 > Severity: minor > Tags: patch > > Dear Maintainer, > > Input file is insserv.8 >[...] Dear submitter, that you for your contribution. Unfortunately, your patch can not be used easily, since it alters not source (insserv.8.in), but preprocessed version. Would you be so kind to rebase your patch on insserv.8.in? Alternatively, we could wait for upstream maintainer to release new version with your changes incorporated, but this way your changes may miss Buster.
Bug#919610: insserv.8: Corrections of formatting and macro use in the manual
The included patch has been applied upstream (with minor changes to adjust for adjustments since 1.18.0). Can mark this one as fixed upstream. The updated manual page will appear in 1.19.0, probably around the end of February. - Jesse On 1/17/19 9:31 PM, Bjarni Ingi Gislason wrote: > Package: insserv > Version: 1.18.0-1 > Severity: minor > Tags: patch > > Dear Maintainer, > > Input file is insserv.8 > > mandoc: insserv.8:104:28: STYLE: whitespace at end of input line > mandoc: insserv.8:127:46: STYLE: whitespace at end of input line > mandoc: insserv.8:21:15: STYLE: normalizing date format to: July 29, 2008 > mandoc: insserv.8:52:2: WARNING: skipping paragraph macro: PP empty > mandoc: insserv.8:331:2: WARNING: empty block: RS > > ### > > :291 (macro IR): only 1 argument, but more are expected > :304 (macro IR): only 1 argument, but more are expected > :306 (macro IR): only 1 argument, but more are expected > :335 (macro BR): only 1 argument, but more are expected > > > > Change '-' (\-) to '\(en' (en-dash) for a numeric range. > > insserv.8:410:2000\-2009 Werner Fink, > insserv.8:414:2000\-2003 SuSE GmbH Nuernberg, Germany, > insserv.8:416:2007\-2009 SuSE Linux Products GmbH Nuernberg, Germany. > insserv.8:418:2018\- Jesse Smith > > # > > > Use "\e" to print the escape character instead of "\\" (which gets > interpreted in copy mode). > > 360:$.#%_+-\\*[]^:()~ > > # > > Split a punctuation mark from a single argument for a two-fonts marco > > 335:.BR insserv: > > # > > Do'nt use ".in +7", as the default indent is different in nroff and groff. > The default unit is 'm', while 'n' is used in the man-macros. > > # > > Adjust space between sentences to two space characters (default in > roff). This space can be changed in the output with the '.ss' request > in "groff". > > Patch: > > --- insserv.8 2018-12-12 22:32:47.0 + > +++ insserv.8.new 2019-01-17 22:50:06.0 + > @@ -18,7 +18,7 @@ > .\" along with this program; if not, write to the Free Software > .\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 > USA > .\" > -.TH INSSERV 8 "Jul 29, 2008" "Version 1.11" > +.TH INSSERV 8 "July 29, 2008" "Version 1.11" > .UC 8 > .SH NAME > insserv \- boot sequence organizer using LSB init.d script dependency > information > @@ -32,11 +32,15 @@ insserv \- boot sequence organizer using > .RB [ \-f ] > .RI [[ / ] path/to/init.d/ ] script \ ... > .PP > +.\" avoid excessive space between words in troff caused by a long text string > +.nr AD \n(.j > +.ad l > .B insserv > .RB [ \-v ] > .RB [ \-c\ ] > .RB [ \-p\ ] > .RI [[ / ] path/to/init.d/ ] script [ > ,start=,stop= ] > +.ad \n(AD > .PP > .B insserv > .RB [ \-v ] > @@ -49,7 +53,6 @@ insserv \- boot sequence organizer using > .PP > .B insserv > .B \-h > -.PP > .SH DESCRIPTION > .B insserv > is a low level tool used by > @@ -76,7 +79,7 @@ init script (`boot script') by reading t > .fi > .in -1l > .sp 1 > -and calculating the dependencies between all scripts. It is not recommended > to > +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 > may render your boot system inoperable. > .B update\-rc.d > @@ -101,9 +104,9 @@ tag. Same holds true for > .in -1l > .sp 1 > which declares facilities which should be available during shutdown of > -the service declared in the > +the service declared in the > .B Provides > -tag. In both cases the script system should avoid stopping services > +tag. In both cases the script system should avoid stopping services > which are declared by these two Stop tags until the script including > these tags is stopped. > .PP > @@ -123,8 +126,8 @@ Whereas the optional > keyword implies that the script using this keyword > should be stopped > .B after > -the specified service names. Both implies that those > -services now depend on the specifying script. > +the specified service names. Both implies that those > +services now depend on the specifying script. > With known dependencies and runlevel(s) > .B insserv > sets and reorders the corresponding symbolic links > @@ -184,7 +187,7 @@ and ending with > are keywords. Currently > .B > is the only know keyword for marking a service > -as an interactive one, e.g. a service which requires > +as an interactive one, e.g., a service which requires > a passphrase or password input during boot > or runlevel change. The special facility > .B $null > @@ -228,7 +231,7 @@ Specify path to init.d directory. Usefu > Do not update symlinks. > .TP > .BR \-s ,\ \-\-showall, \ \-\-show\-all > -Output runlevel and sequence information. Do not update symlinks. > +Output runlevel and sequence information. Do not update symlinks. > .TP > .BR \-r ,\ \-\-remove > Remove the listed scripts from all runlevels. > @@ -238,7 +241,7 @@ Use default
Bug#919610: insserv.8: Corrections of formatting and macro use in the manual
Package: insserv Version: 1.18.0-1 Severity: minor Tags: patch Dear Maintainer, Input file is insserv.8 mandoc: insserv.8:104:28: STYLE: whitespace at end of input line mandoc: insserv.8:127:46: STYLE: whitespace at end of input line mandoc: insserv.8:21:15: STYLE: normalizing date format to: July 29, 2008 mandoc: insserv.8:52:2: WARNING: skipping paragraph macro: PP empty mandoc: insserv.8:331:2: WARNING: empty block: RS ### :291 (macro IR): only 1 argument, but more are expected :304 (macro IR): only 1 argument, but more are expected :306 (macro IR): only 1 argument, but more are expected :335 (macro BR): only 1 argument, but more are expected Change '-' (\-) to '\(en' (en-dash) for a numeric range. insserv.8:410:2000\-2009 Werner Fink, insserv.8:414:2000\-2003 SuSE GmbH Nuernberg, Germany, insserv.8:416:2007\-2009 SuSE Linux Products GmbH Nuernberg, Germany. insserv.8:418:2018\- Jesse Smith # Use "\e" to print the escape character instead of "\\" (which gets interpreted in copy mode). 360:$.#%_+-\\*[]^:()~ # Split a punctuation mark from a single argument for a two-fonts marco 335:.BR insserv: # Do'nt use ".in +7", as the default indent is different in nroff and groff. The default unit is 'm', while 'n' is used in the man-macros. # Adjust space between sentences to two space characters (default in roff). This space can be changed in the output with the '.ss' request in "groff". Patch: --- insserv.8 2018-12-12 22:32:47.0 + +++ insserv.8.new 2019-01-17 22:50:06.0 + @@ -18,7 +18,7 @@ .\" along with this program; if not, write to the Free Software .\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA .\" -.TH INSSERV 8 "Jul 29, 2008" "Version 1.11" +.TH INSSERV 8 "July 29, 2008" "Version 1.11" .UC 8 .SH NAME insserv \- boot sequence organizer using LSB init.d script dependency information @@ -32,11 +32,15 @@ insserv \- boot sequence organizer using .RB [ \-f ] .RI [[ / ] path/to/init.d/ ] script \ ... .PP +.\" avoid excessive space between words in troff caused by a long text string +.nr AD \n(.j +.ad l .B insserv .RB [ \-v ] .RB [ \-c\ ] .RB [ \-p\ ] .RI [[ / ] path/to/init.d/ ] script [ ,start=,stop= ] +.ad \n(AD .PP .B insserv .RB [ \-v ] @@ -49,7 +53,6 @@ insserv \- boot sequence organizer using .PP .B insserv .B \-h -.PP .SH DESCRIPTION .B insserv is a low level tool used by @@ -76,7 +79,7 @@ init script (`boot script') by reading t .fi .in -1l .sp 1 -and calculating the dependencies between all scripts. It is not recommended to +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 may render your boot system inoperable. .B update\-rc.d @@ -101,9 +104,9 @@ tag. Same holds true for .in -1l .sp 1 which declares facilities which should be available during shutdown of -the service declared in the +the service declared in the .B Provides -tag. In both cases the script system should avoid stopping services +tag. In both cases the script system should avoid stopping services which are declared by these two Stop tags until the script including these tags is stopped. .PP @@ -123,8 +126,8 @@ Whereas the optional keyword implies that the script using this keyword should be stopped .B after -the specified service names. Both implies that those -services now depend on the specifying script. +the specified service names. Both implies that those +services now depend on the specifying script. With known dependencies and runlevel(s) .B insserv sets and reorders the corresponding symbolic links @@ -184,7 +187,7 @@ and ending with are keywords. Currently .B is the only know keyword for marking a service -as an interactive one, e.g. a service which requires +as an interactive one, e.g., a service which requires a passphrase or password input during boot or runlevel change. The special facility .B $null @@ -228,7 +231,7 @@ Specify path to init.d directory. Usefu Do not update symlinks. .TP .BR \-s ,\ \-\-showall, \ \-\-show\-all -Output runlevel and sequence information. Do not update symlinks. +Output runlevel and sequence information. Do not update symlinks. .TP .BR \-r ,\ \-\-remove Remove the listed scripts from all runlevels. @@ -238,7 +241,7 @@ Use default runlevels as defined in the This may restore an edited runlevel link scheme. .TP .BR \-f ,\ \-\-force -Ignore if a required service is missed. Beside this if start and or +Ignore if a required service is missed. Beside this if start and or stop levels are specified on the command line the default levels of the script will be ignored. .TP @@ -271,7 +274,7 @@ has to be called from the root directory .TP .RI [[ / ] path/to/init.d/ ] script\ ... List of scripts which have to be added to -the runlevels. If a path is used it +the runlevels. If a path is used it should
