Package: libblkid-dev
Version: 2.40.4-5
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
grep -n -e ' $' -e '\\~$' -e ' \\f.$' -e ' \\"' <file>
to find (most) 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:<stdin>:10: warning: name 'Aq' not defined
* 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.20-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 libblkid-dev depends on:
ii libblkid1 2.40.4-5
ii libc6-dev [libc-dev] 2.41-6
ii uuid-dev 2.40.4-5
libblkid-dev recommends no packages.
libblkid-dev suggests no packages.
-- no debconf information
Input file is libblkid.3
Output from "mandoc -T lint libblkid.3": (shortened list)
1 input text line longer than 80 bytes: All available tags a...
1 input text line longer than 80 bytes: If you are dealing w...
1 input text line longer than 80 bytes: In situations where ...
1 input text line longer than 80 bytes: In some cases (modul...
2 input text line longer than 80 bytes: The \fBlibblkid\fP l...
2 input text line longer than 80 bytes: The high\-level part...
1 input text line longer than 80 bytes: The low\-level part ...
1 input text line longer than 80 bytes: The standard locatio...
1 skipping insecure request: mso
9 skipping paragraph macro: sp after SH
1 skipping unknown macro: LINKSTYLE blue R < >
1 undefined string, using "": Aq
-.-.
Output from
test-nroff -mandoc -t -ww -z libblkid.3: (shortened list)
1 name 'Aq' not defined
-.-.
Show if asciidoctor generated this.
Who is actually generating this man page? Debian or upstream?
Is the generating software out of date?
4:.\" Generator: Asciidoctor 2.0.20
Latest version: Asciidoctor 2.0.23 [https://asciidoctor.org]
-.-.
Add a "\&" (or a comma (Oxford comma)) after an abbreviation
or use English words
(man-pages(7)).
Abbreviation points should be marked as such and protected against being
interpreted as an end of sentence, if they are not, and that independent
of the current place on the line.
141:UUID_SUB \- subvolume uuid (e.g. btrfs)
152:LOGUUID \- external log UUID (e.g. xfs)
-.-.
Wrong distance (not two spaces) 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"
39:The \fBlibblkid\fP library is used to identify block devices (disks) as to
their content (e.g., filesystem type) as well as extracting additional
information such as filesystem labels/volume names, unique identifiers/serial
numbers. A common use is to allow use of \fBLABEL=\fP and \fBUUID=\fP tags
instead of hard\-coding specific block device names into configuration files.
See list of all available tags in \fBTAGS\fP section.
43:The high\-level part of the library keeps information about block devices in
a cache file and is verified to still be valid before being returned to the
user (if the user has read permission on the raw block device, otherwise not).
The cache file also allows unprivileged users (normally anyone other than root,
or those not in the "disk" group) to locate devices by label/id. The standard
location of the cache file can be overridden by the environment variable
\fBBLKID_FILE\fP.
47:The high\-level part of the library supports two methods to determine
\fBLABEL/UUID\fP. It reads information directly from a block device or reads
information from /dev/disk/by\-* udev symlinks. The udev is preferred method by
default.
54:The standard location of the \fI/etc/blkid.conf\fP config file can be
overridden by the environment variable \fBBLKID_CONF\fP. For more details about
the config file see \fBblkid\fP(8) man page.
57:All available tags are listed below. Not all tags are supported for all file
systems. To enable a tag, set one of the following flags with
\fBblkid_probe_set_superblocks_flags\fP():
141:UUID_SUB \- subvolume uuid (e.g. btrfs)
152:LOGUUID \- external log UUID (e.g. xfs)
238:FSSIZE \- size of filesystem. Note that for XFS this will return the same
value
371:\fBlibblkid\fP was written by Andreas Dilger for the ext2 filesystem
utilities, with input from Ted Ts\(cqo. The library was subsequently heavily
modified by Ted Ts\(cqo.
387:The \fBlibblkid\fP library is part of the util\-linux package since version
2.15. It can be downloaded from \c
-.-.
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 39, length 430
The \fBlibblkid\fP library is used to identify block devices (disks) as to
their content (e.g., filesystem type) as well as extracting additional
information such as filesystem labels/volume names, unique identifiers/serial
numbers. A common use is to allow use of \fBLABEL=\fP and \fBUUID=\fP tags
instead of hard\-coding specific block device names into configuration files.
See list of all available tags in \fBTAGS\fP section.
Line 41, length 120
The low\-level part of the library also allows the extraction of information
about partitions and block device topology.
Line 43, length 480
The high\-level part of the library keeps information about block devices in a
cache file and is verified to still be valid before being returned to the user
(if the user has read permission on the raw block device, otherwise not). The
cache file also allows unprivileged users (normally anyone other than root, or
those not in the "disk" group) to locate devices by label/id. The standard
location of the cache file can be overridden by the environment variable
\fBBLKID_FILE\fP.
Line 45, length 200
In situations where one is getting information about a single known device, it
does not impact performance whether the cache is used or not (unless you are
not able to read the block device directly).
Line 47, length 235
The high\-level part of the library supports two methods to determine
\fBLABEL/UUID\fP. It reads information directly from a block device or reads
information from /dev/disk/by\-* udev symlinks. The udev is preferred method by
default.
Line 49, length 192
If you are dealing with multiple devices, use of the cache is highly
recommended (even if empty) as devices will be scanned at most one time and the
on\-disk cache will be updated if possible.
Line 51, length 286
In some cases (modular kernels), block devices are not even visible until after
they are accessed the first time, so it is critical that there is some way to
locate these devices without enumerating only visible devices, so the use of
the cache file is \fBrequired\fP in this situation.
Line 54, length 194
The standard location of the \fI/etc/blkid.conf\fP config file can be
overridden by the environment variable \fBBLKID_CONF\fP. For more details about
the config file see \fBblkid\fP(8) man page.
Line 57, length 181
All available tags are listed below. Not all tags are supported for all file
systems. To enable a tag, set one of the following flags with
\fBblkid_probe_set_superblocks_flags\fP():
Line 371, length 170
\fBlibblkid\fP was written by Andreas Dilger for the ext2 filesystem utilities,
with input from Ted Ts\(cqo. The library was subsequently heavily modified by
Ted Ts\(cqo.
Line 376, length 146
\fBlibblkid\fP is available under the terms of the GNU Library General Public
License (LGPL), version 2 (or at your discretion any later version).
Line 387, length 110
The \fBlibblkid\fP library is part of the util\-linux package since version
2.15. It can be downloaded from \c
Line 388, length 85
.URL "https://www.kernel.org/pub/linux/utils/util\-linux/"; "Linux Kernel
Archive" "."
Longest line is number 43 with 480 characters
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
libblkid.3:39:The \fBlibblkid\fP library is used to identify block devices
(disks) as to their content (e.g., filesystem type) as well as extracting
additional information such as filesystem labels/volume names, unique
identifiers/serial numbers. A common use is to allow use of \fBLABEL=\fP and
\fBUUID=\fP tags instead of hard\-coding specific block device names into
configuration files. See list of all available tags in \fBTAGS\fP section.
libblkid.3:43:The high\-level part of the library keeps information about block
devices in a cache file and is verified to still be valid before being returned
to the user (if the user has read permission on the raw block device, otherwise
not). The cache file also allows unprivileged users (normally anyone other than
root, or those not in the "disk" group) to locate devices by label/id. The
standard location of the cache file can be overridden by the environment
variable \fBBLKID_FILE\fP.
libblkid.3:45:In situations where one is getting information about a single
known device, it does not impact performance whether the cache is used or not
(unless you are not able to read the block device directly).
libblkid.3:49:If you are dealing with multiple devices, use of the cache is
highly recommended (even if empty) as devices will be scanned at most one time
and the on\-disk cache will be updated if possible.
libblkid.3:51:In some cases (modular kernels), block devices are not even
visible until after they are accessed the first time, so it is critical that
there is some way to locate these devices without enumerating only visible
devices, so the use of the cache file is \fBrequired\fP in this situation.
libblkid.3:130:UUID \- filesystem UUID (lower case)
libblkid.3:141:UUID_SUB \- subvolume uuid (e.g. btrfs)
libblkid.3:152:LOGUUID \- external log UUID (e.g. xfs)
libblkid.3:239:as lsblk (without XFS\(cqs metadata), but for ext4 it will
return the size with
libblkid.3:289:MOUNT \- cluster mount name (ocfs only)
libblkid.3:376:\fBlibblkid\fP is available under the terms of the GNU Library
General Public License (LGPL), version 2 (or at your discretion any later
version).
-.-.
Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).
libblkid.3:39:The \fBlibblkid\fP library is used to identify block devices
(disks) as to their content (e.g., filesystem type) as well as extracting
additional information such as filesystem labels/volume names, unique
identifiers/serial numbers. A common use is to allow use of \fBLABEL=\fP and
\fBUUID=\fP tags instead of hard\-coding specific block device names into
configuration files. See list of all available tags in \fBTAGS\fP section.
libblkid.3:43:The high\-level part of the library keeps information about block
devices in a cache file and is verified to still be valid before being returned
to the user (if the user has read permission on the raw block device, otherwise
not). The cache file also allows unprivileged users (normally anyone other than
root, or those not in the "disk" group) to locate devices by label/id. The
standard location of the cache file can be overridden by the environment
variable \fBBLKID_FILE\fP.
libblkid.3:47:The high\-level part of the library supports two methods to
determine \fBLABEL/UUID\fP. It reads information directly from a block device
or reads information from /dev/disk/by\-* udev symlinks. The udev is preferred
method by default.
libblkid.3:54:The standard location of the \fI/etc/blkid.conf\fP config file
can be overridden by the environment variable \fBBLKID_CONF\fP. For more
details about the config file see \fBblkid\fP(8) man page.
libblkid.3:57:All available tags are listed below. Not all tags are supported
for all file systems. To enable a tag, set one of the following flags with
\fBblkid_probe_set_superblocks_flags\fP():
libblkid.3:141:UUID_SUB \- subvolume uuid (e.g. btrfs)
libblkid.3:152:LOGUUID \- external log UUID (e.g. xfs)
libblkid.3:238:FSSIZE \- size of filesystem. Note that for XFS this will return
the same value
libblkid.3:371:\fBlibblkid\fP was written by Andreas Dilger for the ext2
filesystem utilities, with input from Ted Ts\(cqo. The library was subsequently
heavily modified by Ted Ts\(cqo.
libblkid.3:387:The \fBlibblkid\fP library is part of the util\-linux package
since version 2.15. It can be downloaded from \c
-.-.
Put a subordinate sentence (after a comma) on a new line.
libblkid.3:39:The \fBlibblkid\fP library is used to identify block devices
(disks) as to their content (e.g., filesystem type) as well as extracting
additional information such as filesystem labels/volume names, unique
identifiers/serial numbers. A common use is to allow use of \fBLABEL=\fP and
\fBUUID=\fP tags instead of hard\-coding specific block device names into
configuration files. See list of all available tags in \fBTAGS\fP section.
libblkid.3:43:The high\-level part of the library keeps information about block
devices in a cache file and is verified to still be valid before being returned
to the user (if the user has read permission on the raw block device, otherwise
not). The cache file also allows unprivileged users (normally anyone other than
root, or those not in the "disk" group) to locate devices by label/id. The
standard location of the cache file can be overridden by the environment
variable \fBBLKID_FILE\fP.
libblkid.3:45:In situations where one is getting information about a single
known device, it does not impact performance whether the cache is used or not
(unless you are not able to read the block device directly).
libblkid.3:49:If you are dealing with multiple devices, use of the cache is
highly recommended (even if empty) as devices will be scanned at most one time
and the on\-disk cache will be updated if possible.
libblkid.3:51:In some cases (modular kernels), block devices are not even
visible until after they are accessed the first time, so it is critical that
there is some way to locate these devices without enumerating only visible
devices, so the use of the cache file is \fBrequired\fP in this situation.
libblkid.3:57:All available tags are listed below. Not all tags are supported
for all file systems. To enable a tag, set one of the following flags with
\fBblkid_probe_set_superblocks_flags\fP():
libblkid.3:182:USAGE \- usage string: "raid", "filesystem", etc.
libblkid.3:239:as lsblk (without XFS\(cqs metadata), but for ext4 it will
return the size with
libblkid.3:371:\fBlibblkid\fP was written by Andreas Dilger for the ext2
filesystem utilities, with input from Ted Ts\(cqo. The library was subsequently
heavily modified by Ted Ts\(cqo.
libblkid.3:376:\fBlibblkid\fP is available under the terms of the GNU Library
General Public License (LGPL), version 2 (or at your discretion any later
version).
libblkid.3:383:For bug reports, use the issue tracker at \c
-.-.
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.
libblkid.3:10:.TH "LIBBLKID" "3" "2024-12-16" "util\-linux 2.40.4"
"Programmer\*(Aqs Manual"
libblkid.3:30:.SH "NAME"
libblkid.3:32:.SH "SYNOPSIS"
libblkid.3:37:.SH "DESCRIPTION"
libblkid.3:55:.SH "TAGS"
libblkid.3:369:.SH "AUTHORS"
libblkid.3:374:.SH "COPYING"
libblkid.3:384:.URL "https://github.com/util\-linux/util\-linux/issues"; "" "."
libblkid.3:385:.SH "AVAILABILITY"
libblkid.3:388:.URL "https://www.kernel.org/pub/linux/utils/util\-linux/";
"Linux Kernel Archive" "."
-.-.
Use ".na" (no adjustment) instead of ".ad l" (and ".ad" to begin the
same adjustment again as before).
15:.ad l
23:. ad l
26:. ad l
-.-.
Section headings (.SH and .SS) do not need quoting their arguments.
30:.SH "NAME"
32:.SH "SYNOPSIS"
37:.SH "DESCRIPTION"
52:.SH "CONFIGURATION FILE"
55:.SH "TAGS"
369:.SH "AUTHORS"
374:.SH "COPYING"
377:.SH "SEE ALSO"
381:.SH "REPORTING BUGS"
385:.SH "AVAILABILITY"
-.-.
Put a (long) web address on a new line to reduce the posibility of
splitting the address between two output lines.
Or inhibit hyphenation with "\%" in front of the name.
384:.URL "https://github.com/util\-linux/util\-linux/issues"; "" "."
388:.URL "https://www.kernel.org/pub/linux/utils/util\-linux/"; "Linux Kernel
Archive" "."
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:10: warning: name 'Aq' not defined
-.-.
Additionally:
New line character (\n) is missing at the end of file.
-.-
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- libblkid.3 2025-04-04 19:24:37.435705228 +0000
+++ libblkid.3.new 2025-04-04 19:30:40.768844917 +0000
@@ -7,9 +7,9 @@
.\" Source: util-linux 2.40.4
.\" Language: English
.\"
-.TH "LIBBLKID" "3" "2024-12-16" "util\-linux 2.40.4" "Programmer\*(Aqs Manual"
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
+.TH "LIBBLKID" "3" "2024-12-16" "util\-linux 2.40.4" "Programmer\*(Aqs Manual"
.ss \n[.ss] 0
.nh
.ad l
@@ -385,4 +385,4 @@ For bug reports, use the issue tracker a
.SH "AVAILABILITY"
.sp
The \fBlibblkid\fP library is part of the util\-linux package since version
2.15. It can be downloaded from \c
-.URL "https://www.kernel.org/pub/linux/utils/util\-linux/"; "Linux Kernel
Archive" "."
\ No newline at end of file
+.URL "https://www.kernel.org/pub/linux/utils/util\-linux/"; "Linux Kernel
Archive" "."
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>
To find trailing space use
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <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)
-.-
