--- Begin Message ---
Package: e2fsprogs
Version: 1.47.1-1+b1
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?
an.tmac:<stdin>:645: warning: cannot nest .TP or .TQ inside .TP; supply a tag
* 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.7-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 e2fsprogs depends on:
ii libblkid1 2.40.2-11
ii libc6 2.40-3
ii libcom-err2 1.47.1-1+b1
ii libext2fs2t64 1.47.1-1+b1
ii libss2 1.47.1-1+b1
ii libuuid1 2.40.2-11
ii logsave 1.47.1-1+b1
Versions of packages e2fsprogs recommends:
pn e2fsprogs-l10n <none>
Versions of packages e2fsprogs suggests:
pn e2fsck-static <none>
pn fuse2fs <none>
pn gpart <none>
ii parted 3.6-4+b1
-- no debconf information
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 tune2fs.8": (shortened list)
1 input text line longer than 80 bytes
1 line scope broken
-.-.
Output from "test-groff -mandoc -t -ww -b -z tune2fs.8": (shortened list)
1 cannot nest .TP or .TQ inside .TP; supply a tag
-.-.
Change (or include a "FIXME" paragraph about) misused SI (metric)
numeric prefixes (or names) to the binary ones, like Ki (kibi), Mi
(mebi), Gi (gibi), or Ti (tebi), if indicated.
If the metric prefixes are correct, add the definitions or an
explanation to avoid misunderstanding.
379:(i.e., 1MB if using 1k blocks, 4MB if using 4k blocks, etc.)
387:kilobytes.
658:File System can contain files that are greater than 2GB.
-.-.
Add a (no-break, "\ " or "\~") space between a number and a unit,
as these are not one entity.
379:(i.e., 1MB if using 1k blocks, 4MB if using 4k blocks, etc.)
658:File System can contain files that are greater than 2GB.
-.-.
Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.
101:.B -l
178:fscked, or major file system corruption can result. Needs '-f'.
244:.B -o
418:.B mke2fs -O journal_dev
441:.B -L
730:.B e2fsck -D
-.-.
Add a comma (or \&) after "e.g." and "i.e.", or use English words
(man-pages(7)).
Abbreviation points should be protected against being interpreted as
an end of sentence, if they are not, and that independent of the
current place on the line.
204:N is the number of data disks in the RAID (e.g. RAID 5 N+1, RAID 6 N+2).
768:is the international date format, with an optional time specifier, i.e.
-.-.
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.
193:file system blocks. This is the number of blocks read or written to disk
194:before moving to next disk. This mostly affects placement of file system
203:file system blocks per stripe. This is typically be stride-size * N, where
204:N is the number of data disks in the RAID (e.g. RAID 5 N+1, RAID 6 N+2).
223:is not specified, utf8 is used. The encoding cannot be altered if casefold
262:with truncate in progress. Larger file allows for better scalability,
reserving
285:external journal is not available. If the file system appears to require
320:Change the inode size used by the file system. This requires rewriting
370:Override the default ext3 journal parameters. Journal options are comma
378:megabytes. The size of the journal must be at least 1024 file system
blocks
391:on the file system. If this option is not specified and if
395:/ 64 megabytes. The total size of the journal with
401:* 1024) megabytes. The total journal size may be no more than
409:suffix (e.g., 'M', 'G', etc.) interpret it as the offset from the
477:by privileged processes. Reserving some number of file system blocks
744:given quota type. Quota options could be one or more of the following:
769:YYYYMMDD[HH[MM[SS]]]. The keyword
-.-.
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 694, length 81
Prevent the file system from being shrunk or having its UUID changed, in order
to
-.-.
Do not use more than two space characters between sentences or (better)
only a new line character.
285:external journal is not available. If the file system appears to require
320:Change the inode size used by the file system. This requires rewriting
378:megabytes. The size of the journal must be at least 1024 file system
blocks
477:by privileged processes. Reserving some number of file system blocks
769:YYYYMMDD[HH[MM[SS]]]. The keyword
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
tune2fs.8:110:specifier can either be a filename (i.e., /dev/sda1), or a LABEL
or UUID
tune2fs.8:204:N is the number of data disks in the RAID (e.g. RAID 5 N+1, RAID
6 N+2).
tune2fs.8:338:an appropriately sized journal (given the size of the file system)
tune2fs.8:409:suffix (e.g., 'M', 'G', etc.) interpret it as the offset from the
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":
an.tmac:<stdin>:645: warning: cannot nest .TP or .TQ inside .TP; supply a tag
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":
an.tmac:<stdin>:645: warning: cannot nest .TP or .TQ inside .TP; supply a tag
-.-.
--- tune2fs.8 2024-11-20 00:13:23.638228295 +0000
+++ tune2fs.8.new 2024-11-20 00:58:16.569110104 +0000
@@ -98,7 +98,7 @@ device
allows the system administrator to adjust various tunable file system
parameters on Linux ext2, ext3, or ext4 file systems. The current values
of these options can be displayed by using the
-.B -l
+.B \-l
option to
.BR tune2fs (8)
program, or by using the
@@ -107,8 +107,11 @@ program.
.PP
The
.I device
-specifier can either be a filename (i.e., /dev/sda1), or a LABEL or UUID
-specifier: "\fBLABEL=\fIvolume-label\fR" or "\fBUUID=\fIuuid\fR". (i.e.,
+specifier can either be a filename
+(i.e., /dev/sda1),
+or a LABEL or UUID specifier:
+"\fBLABEL=\fIvolume-label\fR" or "\fBUUID=\fIuuid\fR".
+(i.e.,
LABEL=home or UUID=e40486c6-84d5-4f2f-b99c-032281799c9d).
.SH OPTIONS
.TP
@@ -175,7 +178,7 @@ The following extended options are suppo
.B clear_mmp
Reset the MMP block (if any) back to the clean state. Use only if
absolutely certain the device is not currently mounted or being
-fscked, or major file system corruption can result. Needs '-f'.
+fscked, or major file system corruption can result. Needs '\-f'.
.TP
.BI mmp_update_interval= interval
Adjust the initial MMP update interval to
@@ -190,9 +193,10 @@ feature be enabled.
.BI stride= stride-size
Configure the file system for a RAID array with
.I stride-size
-file system blocks. This is the number of blocks read or written to disk
-before moving to next disk. This mostly affects placement of file system
-metadata like bitmaps at
+file system blocks.
+This is the number of blocks read
+or written to disk before moving to next disk.
+This mostly affects placement of file system metadata like bitmaps at
.BR mke2fs (2)
time to avoid placing them on a single disk, which can hurt the performance.
It may also be used by block allocator.
@@ -200,8 +204,10 @@ It may also be used by block allocator.
.BI stripe_width= stripe-width
Configure the file system for a RAID array with
.I stripe-width
-file system blocks per stripe. This is typically be stride-size * N, where
-N is the number of data disks in the RAID (e.g. RAID 5 N+1, RAID 6 N+2).
+file system blocks per stripe.
+This is typically be stride-size * N,
+where N is the number of data disks in the RAID
+(e.g., RAID 5 N+1, RAID 6 N+2).
This allows the block allocator to prevent read-modify-write of the
parity in a RAID stripe if possible when the data is written.
.TP
@@ -218,10 +224,13 @@ Enable the
.I casefold
feature in the super block and set
.I encoding-name
-as the encoding to be used. If
+as the encoding to be used.
+If
.I encoding-name
-is not specified, utf8 is used. The encoding cannot be altered if casefold
-was previously enabled.
+is not specified,
+utf8 is used.
+The encoding cannot be altered
+if casefold was previously enabled.
.TP
.BI encoding_flags= encoding-flags
Define parameters for file name character encoding operations. If a
@@ -241,7 +250,7 @@ flag is disabled.
Set a set of default mount options which will be used when the file
system is mounted. Unlike the bitmask-based default mount options which
can be specified with the
-.B -o
+.B \-o
option,
.I mount_option_string
is an arbitrary string with a maximum length of 63 bytes, which is
@@ -259,8 +268,9 @@ and not at all by the ext2 and ext3 file
.TP
.BI orphan_file_size= size
Set size of the file for tracking unlinked but still open inodes and inodes
-with truncate in progress. Larger file allows for better scalability, reserving
-a few blocks per cpu is ideal.
+with truncate in progress.
+Larger file allows for better scalability,
+reserving a few blocks per cpu is ideal.
.TP
.B force_fsck
Set a flag in the file system superblock indicating that errors have been
found.
@@ -282,8 +292,9 @@ option is useful when removing the
file system feature from a file system which has
an external journal (or is corrupted
such that it appears to have an external journal), but that
-external journal is not available. If the file system appears to require
-journal replay, the
+external journal is not available.
+If the file system appears to require journal replay,
+the
.B \-f
flag must be specified twice to proceed.
.sp
@@ -317,9 +328,10 @@ discussion under the
(mount-count-dependent check) option for details.
.TP
.B \-I
-Change the inode size used by the file system. This requires rewriting
-the inode table, so it requires that the file system is checked for
-consistency first using
+Change the inode size used by the file system.
+This requires rewriting the inode table,
+so it requires that the file system is checked for consistency,
+first using
.BR e2fsck (8).
This operation can also take a while and the file system can be
corrupted and data lost if it is interrupted while in the middle of
@@ -367,16 +379,18 @@ avoid requiring the use of a rescue flop
the root file system.
.TP
.BR \-J " journal-options"
-Override the default ext3 journal parameters. Journal options are comma
-separated, and may take an argument using the equals ('=') sign.
+Override the default ext3 journal parameters.
+Journal options are comma separated,
+and may take an argument using the equals ('=') sign.
The following journal options are supported:
.RS 1.2i
.TP
.BI size= journal-size
Create a journal stored in the file system of size
.I journal-size
-megabytes. The size of the journal must be at least 1024 file system blocks
-(i.e., 1MB if using 1k blocks, 4MB if using 4k blocks, etc.)
+mebibytes.
+The size of the journal must be at least 1024 file system blocks
+(i.e., 1\~MiB if using 1\~KiB blocks, 4\~MiB if using 4\~KiB blocks, etc.)
and may be no more than 10,240,000 file system blocks.
There must be enough free space in the file system to create a journal of
that size.
@@ -384,30 +398,35 @@ that size.
.BI fast_commit_size= fast-commit-size
Create an additional fast commit journal area of size
.I fast-commit-size
-kilobytes.
+kibibytes.
This option is only valid if
.B fast_commit
-feature is enabled
-on the file system. If this option is not specified and if
+feature is enabled on the file system.
+If this option is not specified and if
.B fast_commit
-feature is turned on, fast commit area size defaults to
+feature is turned on,
+fast commit area size defaults to
.I journal-size
-/ 64 megabytes. The total size of the journal with
+/ 64 megabytes.
+The total size of the journal with
.B fast_commit
feature set is
.I journal-size
+ (
.I fast-commit-size
-* 1024) megabytes. The total journal size may be no more than
+* 1024) megabytes.
+The total journal size may be no more than
10,240,000 file system blocks or half the total file system size
(whichever is smaller).
.TP
.BI location =journal-location
-Specify the location of the journal. The argument
+Specify the location of the journal.
+The argument
.I journal-location
-can either be specified as a block number, or if the number has a units
-suffix (e.g., 'M', 'G', etc.) interpret it as the offset from the
-beginning of the file system.
+can either be specified as a block number,
+or if the number has a units suffix
+(e.g., 'M', 'G', etc.)
+interpret it as the offset from the beginning of the file system.
.TP
.BI device= external-journal
Attach the file system to the journal block device located on
@@ -415,7 +434,7 @@ Attach the file system to the journal bl
The external
journal must have been already created using the command
.IP
-.B mke2fs -O journal_dev
+.B mke2fs \-O journal_dev
.I external-journal
.IP
Note that
@@ -438,7 +457,7 @@ to locate the external journal by either
stored in the ext2 superblock at the start of the journal. Use
.BR dumpe2fs (8)
to display a journal device's volume label and UUID. See also the
-.B -L
+.B \-L
option of
.BR tune2fs (8).
.RE
@@ -474,10 +493,12 @@ instead of a block special device name l
.TP
.BI \-m " reserved-blocks-percentage"
Set the percentage of the file system which may only be allocated
-by privileged processes. Reserving some number of file system blocks
-for use by privileged processes is done
-to avoid file system fragmentation, and to allow system
-daemons, such as
+by privileged processes.
+Reserving some number of file system blocks for use by privileged processes
+is done
+to avoid file system fragmentation,
+and to allow system daemons,
+such as
.BR syslogd (8),
to continue to function correctly after non-privileged processes are
prevented from writing to the file system. Normally, the default percentage
@@ -642,7 +663,6 @@ Setting the file system feature is equiv
.B \-j
option.
.TP
-.TP
.B fast_commit
Enable fast commit journaling feature to improve fsync latency.
.TP
@@ -655,7 +675,7 @@ currently only supports setting this fil
Support files larger than 2 terabytes in size.
.TP
.B large_file
-File System can contain files that are greater than 2GB.
+File System can contain files that are greater than 2\~GiB.
.TP
.B metadata_csum
Store a checksum to protect the contents in each metadata block.
@@ -691,9 +711,9 @@ Limit the number of backup superblocks t
currently only supports setting this file system feature.
.TP
.B stable_inodes
-Prevent the file system from being shrunk or having its UUID changed, in order
to
-allow the use of specialized encryption settings that make use of the inode
-numbers and UUID.
+Prevent the file system from being shrunk or having its UUID changed,
+in order to allow the use of specialized encryption settings
+that make use of the inode numbers and UUID.
.B Tune2fs
currently only supports setting this file system feature.
.TP
@@ -727,7 +747,7 @@ will print a message requesting that the
if necessary. After setting the
.B dir_index
feature,
-.B e2fsck -D
+.B e2fsck \-D
can be run to convert existing directories to the hashed B-tree format.
Enabling certain file system features may prevent the file system from being
mounted by kernels which do not support those features. In particular, the
@@ -741,7 +761,8 @@ Set the number of reserved file system b
.TP
.BI \-Q " quota-options"
Sets 'quota' feature on the superblock and works on the quota files for the
-given quota type. Quota options could be one or more of the following:
+given quota type.
+Quota options could be one or more of the following:
.RS 1.2i
.TP
.B [^]usrquota
@@ -756,7 +777,7 @@ Sets/clears project quota inode in the s
.TP
.BI \-T " time-last-checked"
Set the time the file system was last checked using
-.BR e2fsck .
+.BR e2fsck .
The time is interpreted using the current (local) timezone.
This can be useful in scripts which use a Logical Volume Manager to make
a consistent snapshot of a file system, and then check the file system
@@ -765,8 +786,9 @@ hardware problems, etc. If the file sys
be used to set the last checked time on the original file system. The format
of
.I time-last-checked
-is the international date format, with an optional time specifier, i.e.
-YYYYMMDD[HH[MM[SS]]]. The keyword
+is the international date format, with an optional time specifier, i.e.,
+YYYYMMDD[HH[MM[SS]]].
+The keyword
.B now
is also accepted, in which case the last checked time will be set to the
current time.
--- End Message ---
pgpBs9smHA2_c.pgp
