Package: dpkg
Version: 1.19.0.5+b1
Severity: minor
Tags: patch

Dear Maintainer,

   * What led up to the situation?

  Warning from "groff":

<dpkg-split.1>:148 (macro BR): only 1 argument, but more are expected
<dpkg-split.1>:181 (macro BR): only 1 argument, but more are expected

Output is from: test-groff -b -e -mandoc -T utf8 -rF0 -t -w w -z 

  ["test-groff" is a developmental version of "groff"]

####

  Summary:

  Change '.BR "one argument"' to '.B "one argument"'

  Fix one spelling mistake (queueing)

  Add a left italic correction (instead of using a macro)

  Protect ellipsis on both ends (\&...\&)

  Know the difference between "abc..." and "abc ..."
  See a style guide

  Let new sentences begin on a new line.

###

  Details:

Input file is dpkg-split.1

Test nr. 8:

Protect a full stop (.) with "\&", if it has a blank (white-space) in
front of or (ignoring characters transparent to it) after it, and it
does not mean an end of a sentence.

26:.RI [ option "...] " command

#####

NOT APPLIED

Test nr. 9:

Define a string "el" for an ellipsis, to avoid problems with the
full stops (can act as a control character or indicate the end of a
sentence).
Simplifies changes around this string (character) .ds el \&.\^.\^.\&\"

26:.RI [ option "...] " command
70:.BR \-j ", " \-\-join " \fIpart\fP..."
89:.BR \-I ", " \-\-info " \fIpart\fP..."
136:.BR \-d ", " \-\-discard " [\fIpackage\fP...]"

#####

Test nr. 10:

Separate an ellipsis from the preceding string with a space
character, if it does not mean a continuation of it.

See a manual of style about the difference between "abc..." and
"abc ...".

26:.RI [ option "...] " command
70:.BR \-j ", " \-\-join " \fIpart\fP..."
89:.BR \-I ", " \-\-info " \fIpart\fP..."
136:.BR \-d ", " \-\-discard " [\fIpackage\fP...]"

#####

Test nr. 16:

Use the correct macro for the font change of one argument.
Split a  punctuation mark from the only argument if one is there

148:.BR \-\-version
181:.BR \-\-msdos

#####

Test nr. 41:

Wrong distance between sentences or protect the indicator.

1) Separate the sentences and subordinate clauses; each begins on a new
line.  See man-pages(7) [package "manpages"] and "info groff".

Or

2) Adjust space between sentences (two spaces),

3) or protect the indicator by adding "\&" after it.

The "indicator" is an "end-of-sentence character" (.!?).

42:parts. The
75:same original binary file. Each part must occur exactly once in the
91:specified. Arguments which are not binary package parts produce a
155:automatic reassembly. The default is
160:bytes). The default is 450 KiB.
175:that is not a binary package part. This option suppresses this

#####

  Patch:

--- dpkg-split.1        2018-05-06 07:53:26.000000000 +0000
+++ dpkg-split.1.new    2018-05-24 22:55:07.000000000 +0000
@@ -23,7 +23,7 @@ dpkg\-split \- Debian package archive sp
 .
 .SH SYNOPSIS
 .B dpkg\-split
-.RI [ option "...] " command
+.RI [ option " \&...\&] " command
 .
 .SH DESCRIPTION
 .B dpkg\-split
@@ -39,11 +39,12 @@ It also has an automatic mode, invoked u
 .B \-\-auto
 option, where it maintains a queue of parts seen but not yet
 reassembled and reassembles a package file when it has seen all of its
-parts. The
+parts.
+The
 .BR \-\-listq " and " \-\-discard
 options allow the management of the queue.
 
-All splitting, joining and queueing operations produce informative
+All splitting, joining and queuing operations produce informative
 messages on standard output; these may safely be ignored.
 .
 .SH COMMANDS
@@ -67,12 +68,13 @@ filename is taken, including directory,
 .B .deb
 removed.
 .TP
-.BR \-j ", " \-\-join " \fIpart\fP..."
+.BR \-j ", " \-\-join " \fIpart\fP \&...\&"
 Joins the parts of a package file together, reassembling the original
 file as it was before it was split.
 
 The part files given as arguments must be all the parts of exactly the
-same original binary file. Each part must occur exactly once in the
+same original binary file.
+Each part must occur exactly once in the
 argument list, though the parts to not need to be listed in order.
 
 The parts must of course all have been generated with the same part
@@ -86,9 +88,10 @@ By default the output file is called
 .IB package _ version _ arch .deb\fR.
 
 .TP
-.BR \-I ", " \-\-info " \fIpart\fP..."
+.BR \-I ", " \-\-info " \fIpart\fP \&...\&"
 Prints information, in a human-readable format, about the part file(s)
-specified. Arguments which are not binary package parts produce a
+specified.
+Arguments which are not binary package parts produce a
 message saying so instead (but still on standard output).
 .TP
 .BR \-a ", " "\-\-auto \-o" " \fIcomplete-output part\fP"
@@ -133,7 +136,7 @@ For each package file of which parts are
 the name of the package, the parts in the queue, and the total number
 of bytes stored in the queue.
 .TP
-.BR \-d ", " \-\-discard " [\fIpackage\fP...]"
+.BR \-d ", " \-\-discard " [\,\fIpackage\fP \&...\&]"
 This discards parts from the queue of those waiting for the remaining
 parts of their packages.
 
@@ -145,14 +148,15 @@ specified then only parts of the relevan
 .BR \-? ", " \-\-help
 Show the usage message and exit.
 .TP
-.BR \-\-version
+.B \-\-version
 Show the version and exit.
 .
 .SH OPTIONS
 .TP
 .BI \-\-depotdir " directory"
 Specifies an alternative directory for the queue of parts awaiting
-automatic reassembly. The default is
+automatic reassembly.
+The default is
 .BR /var/lib/dpkg .
 .TP
 .BR \-S ", " \-\-partsize " \fIkibibytes\fP"
@@ -172,13 +176,14 @@ When doing automatic queue-or-reassembly
 .B dpkg\-split
 usually prints a message if it is given a
 .I part
-that is not a binary package part. This option suppresses this
+that is not a binary package part.
+This option suppresses this
 message, to allow programs such as
 .B dpkg
 to cope with both split and unsplit packages without producing
 spurious messages.
 .TP
-.BR \-\-msdos
+.B \-\-msdos
 Forces the output filenames generated by
 .B \-\-split
 to be msdos-compatible.


-- System Information:
Debian Release: buster/sid
  APT prefers stable-updates
  APT policy: (500, 'stable-updates'), (500, 'proposed-updates'), (500, 
'testing'), (500, 'stable')
Architecture: amd64 (x86_64)

Kernel: Linux 4.9.88-1-u1 (SMP w/2 CPU cores)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), 
LANGUAGE=is_IS.iso88591 (charmap=ISO-8859-1)
Shell: /bin/sh linked to /bin/dash
Init: sysvinit (via /sbin/init)

Versions of packages dpkg depends on:
ii  libbz2-1.0   1.0.6-8.1
ii  libc6        2.27-3
ii  liblzma5     5.2.2-1.3
ii  libselinux1  2.7-2+b2
ii  tar          1.30+dfsg-2
ii  zlib1g       1:1.2.11.dfsg-1

dpkg recommends no packages.

Versions of packages dpkg suggests:
ii  apt            1.6.1
pn  debsig-verify  <none>

-- no debconf information

-- 
Bjarni I. Gislason

Reply via email to