mke2fs.conf.5: clarify the man page regarding boolean relations
Explain more clearly how boolean relations in the mke2fs.conf file are
parsed, and which config parameters are in fact boolean relations.
Addresses-Debian-Bug: #634883
Signed-off-by: "Theodore Ts'o" <tytso@mit.edu>
diff --git a/misc/mke2fs.conf.5.in b/misc/mke2fs.conf.5.in
index b2c7a57..636a0f1 100644
--- a/misc/mke2fs.conf.5.in
+++ b/misc/mke2fs.conf.5.in
@@ -59,6 +59,11 @@
"\et" (for the tab character), "\eb" (for the backspace character),
and "\e\e" (for the backslash character).
.P
+Some relations expect a boolean value. The parser is quite liberal on
+recognizing ``yes'', '`y'', ``true'', ``t'', ``1'', ``on'', etc. as a
+boolean true value, and ``no'', ``n'', ``false'', ``nil'', ``0'',
+``off'' as a boolean false value.
+.P
The following stanzas are used in the
.I mke2fs.conf
file. They will be described in more detail in future sections of this
@@ -108,8 +113,8 @@
.BR mke2fs (8).
.TP
.I enable_periodic_fsck
-This relation specifies whether periodic filesystem checks should be
-enforced at boot time. If enabled, checks will be forced every
+This boolean relation specifies whether periodic filesystem checks should be
+enforced at boot time. If set to true, checks will be forced every
180 days, or after a random number of mounts. These values may
be changed later via the
.B -i
@@ -119,7 +124,7 @@
.BR tune2fs (8).
.TP
.I force_undo
-This relation, if set to a boolean value of true, forces
+This boolean relation, if set to a value of true, forces
.B mke2fs
to always try to create an undo file, even if the undo file might be
huge and it might extend the time to create the filesystem image
@@ -341,7 +346,7 @@
specify a blocksize on the command line.
.TP
.I lazy_itable_init
-This relation is a boolean which specifies whether the inode table should
+This boolean relation specifies whether the inode table should
be lazily initialized. It only has meaning if the uninit_bg feature is
enabled. If lazy_itable_init is true and the uninit_bg feature is
enabled, the inode table will
@@ -392,7 +397,7 @@
on a per-filesystem type basis.
.TP
.I discard
-This relation is a boolean which specifies whether the
+This boolean relation specifies whether the
.BR mke2fs (8)
should attempt to discard device prior to filesystem creation.
.TP