Package: parted
Version: upstream
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 -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>:66: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:173: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:175: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
* 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.12-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 parted depends on:
ii libc6 2.40-7
ii libparted2t64 3.6-4+b1
ii libreadline8t64 8.2-6
ii libtinfo6 6.5+20250216-1
ii libuuid1 2.40.4-4
parted recommends no packages.
Versions of packages parted suggests:
ii parted-doc 3.6-4
-- no debconf information
Input file is parted.8
Output from "mandoc -T lint parted.8": (shortened list)
1 input text line longer than 80 bytes: "legacy_boot", "irst...
1 input text line longer than 80 bytes: Change a \fIflag\fP ...
1 input text line longer than 80 bytes: are using. Supporte...
1 input text line longer than 80 bytes: before or after that...
-.-.
Output from "test-groff -mandoc -t -ww -z parted.8": (shortened list)
2 Use macro '.B' for one argument or split argument.
1 Use macro '.I' for one argument or split argument.
2 .BR is for at least 2 arguments, got 1
1 .IR is for at least 2 arguments, got 1
-.-.
Change two HYPHEN-MINUSES (code 0x2D) to an em-dash (\(em),
if one is intended.
" \(em " creates a too big gap in the text (in "troff").
An en-dash is usually surrounded by a space,
while an em-dash is used without spaces.
"man" (1 byte characters in input) transforms an en-dash (\(en) to one
HYPHEN-MINUS,
and an em-dash to two HYPHEN-MINUSES without considering the space
around it.
If "--" are two single "-"
(begin of an option or end of options)
then use "\-\-".
parted.8:18:.B -h, --help
parted.8:21:.B -l, --list
parted.8:24:.B -m, --machine
parted.8:27:.B -j, --json
parted.8:30:.B -s, --script
parted.8:33:.B -f, --fix
parted.8:36:.B -v, --version
parted.8:39:.B -a \fIalignment-type\fP, --align \fIalignment-type\fP
-.-.
Add a (no-break, "\ " or "\~") space between a number and a unit,
as these are not one entity.
163:start request of "4GB", which may actually resolve to some sector up to
500MB
-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.
175:.IR "GNU partitioning software"
-.-.
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 "\&".
Some sentences (etc.) do not begin on a new line.
Split (sometimes) lines after a punctuation mark; before a conjunction.
Lines with only one (or two) space(s) between sentences could be split,
so latter sentences begin on a new line.
Use
#!/usr/bin/sh
sed -e '/^\./n' \
-e 's/\([[:alpha:]]\)\. */\1.\n/g' $1
to split lines after a sentence period.
Check result with the difference between the formatted outputs.
See also the attachment "general.bugs"
9:is a program to manipulate disk partitions. It supports multiple partition
10:table formats, including MS-DOS and GPT. It is useful for creating space for
14:This manual page documents \fBparted\fP briefly. Complete documentation is
47:Use minimum alignment as given by the disk topology information. This and
53:Use optimum alignment as given by the disk topology information. This
61:The block device to be used. When none is given, \fBparted\fP will use the
65:Specifies the command to be executed. If no command is given,
67:will present a command prompt. Possible commands are:
78:Create a new disklabel (partition table) of \fIlabel-type\fP.
\fIlabel-type\fP
83:Create a new partition. \fIpart-type\fP may be specified only with msdos and
90:Set the name of \fIpartition\fP to \fIname\fP. This option works only on Mac,
91:PC98, and GPT disklabels. The name can be placed in double quotes, if
necessary.
104:\fIend\fP. If a partition is found, \fBparted\fP will ask if you want to
108:Change the \fIend\fP position of \fIpartition\fP. Note that this does not
115:Choose \fIdevice\fP as the current device to edit. \fIdevice\fP should
usually
138:On MS-DOS set the type aka. partition id of \fIpartition\fP to
139:\fIid\fP. The \fIid\fP is a value between "0x01" and "0xff". On GPT
143:Change a \fIflag\fP on the disk to \fIstate\fP. A flag can be either "on"
or "off".
145:are using. Supported flags are: "pmbr_boot" on GPT to enable the boot flag
on the
156:units like "GB", "MB", etc. Use the sector unit "s" or IEC binary units like
162:provides no helpful range of sloppiness. Contrast that with a partition
164:before or after that point. Thus, when creating a partition in an exact
location
-.-.
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.
Add "\:" to split the string for the output, "\<newline>" in the source.
Line 122, length 85
"legacy_boot", "irst", "msftres", "esp", "chromeos_kernel", "bls_boot",
"linux-home",
Line 129, length 84
\fIunit\fP can be one of "s" (sectors), "B" (bytes), "kB", "MB", "KiB", "MiB",
"GB",
Line 143, length 83
Change a \fIflag\fP on the disk to \fIstate\fP. A flag can be either "on" or
"off".
Line 145, length 82
are using. Supported flags are: "pmbr_boot" on GPT to enable the boot flag on
the
Line 155, length 82
\fBparted\fP will compute sensible ranges for the locations you specify when
using
Line 164, length 81
before or after that point. Thus, when creating a partition in an exact
location
-.-.
The name of a man page is typeset in bold and the section in roman
(see man-pages(7)).
173:.BR info(1)
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
parted.8:78:Create a new disklabel (partition table) of \fIlabel-type\fP.
\fIlabel-type\fP
parted.8:130:"GiB", "TB", "TiB", "%" (percentage of device size), "cyl"
(cylinders), "chs"
parted.8:161:the same number specified in bytes (i.e., with the "B" suffix), in
that it
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:66: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:173: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:175: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
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.
"git" has a "tool" to point out whitespace,
see for example "git-apply(1)" and git-config(1)")
Not beginning each input sentence on a new line.
Line length and patch size 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)
-.-
