On 5/30/18 1:30 PM, Darrick J. Wong wrote:
On Wed, May 30, 2018 at 01:10:48PM -0500, Eric Sandeen wrote:
Here's my stab at documenting the defaults/config file behavior.
I've condensed it down to just mkfs.xfs 8 changes, and tried to
make it more concise. I'll let people bikeshed this while I work
out a proper way to substitute %sysconfdir% in the text.
Note that what I describe in terms of bare filename behavior doesn't
match the code today - I think we still need to reach a consensus
on whether a bare filename looks in $PWD first, or only in the
/etc/ path. (I'd prefer the latter, I think, but still slightly
wobbly on this)
Signed-off-by: Eric Sandeen <sandeen@xxxxxxxxxx>
---
diff --git a/man/man8/mkfs.xfs.8 b/man/man8/mkfs.xfs.8
index 4b8c78c..64853cc 100644
--- a/man/man8/mkfs.xfs.8
+++ b/man/man8/mkfs.xfs.8
@@ -4,6 +4,10 @@ mkfs.xfs \- construct an XFS filesystem
.SH SYNOPSIS
.B mkfs.xfs
[
+.B \-c
+.I configuration
+] [
+[
.B \-b
.I block_size_options
] [
@@ -121,8 +125,38 @@ when parameters are quantified in those units.
.PP
Many feature options allow an optional argument of 0 or 1, to explicitly
disable or enable the functionality.
+.SH DEFAULT VALUES
+.BR mkfs.xfs (8)
+contains built-in default values for every option as described in the sections
+below.
+These built-in defaults may evolve over time as new capabilities are added.
Yay, each sentence starts on its own line, like regular manpages...
+If the file
+.B /etc/xfs/mkfs/defaults
@sysconfdir@/xfs/mkfs/defaults ?
"I'll let people bikeshed this while I work
out a proper way to substitute %sysconfdir% in the text." ;)
+exists, it will be parsed to override built-in defaults as specified in the
+.B defaults
+file, and the defaults described in sections below may no longer apply.
I think "as specified in the defaults file" is redundant? We already
said that we were parsing the defaults file...
sure
+.PP
+The
+.B \-c
+option may also be used to specify an alternate configuration file
+as descibed in the OPTIONS section.
...described... (typo)
thx
.SH OPTIONS
.TP
+.BI \-c " configuration"
+This option may be used to specify a configuration file other than
+.B /etc/xfs/mkfs/defaults
@sysconfdir@/xfs/mkfs/defaults
grr ;)
+to override selected built-in parameter defaults.
+If
+.B configuration
+is a bare filename, it will be searched in the
What is a bare filename?
how would you describe a collection of characters that contains
not absolute or relative path components?
+.B /etc/xfs/mkfs/
@sysco.... yeah.
+directory. If
Start new sentence on new line?
k
+.B configuration
+is a full pathname or a relative pathname starting with
Ugh, I still find this a little contorted...
"If $configuration is an absolute pathname, then that path will be used
to find the configuration file.
"Otherwise, if $configuration contains at least one slash, it will be
treated as a pathname relative to the current working directory.
mkfs.xfs -c foo/bar/baz ?
/me wonders what that does today
"If $configuration contains no slashes, first the current working
directory and then @sysconfdir@/xfs/mkfs/ will be searched for that
file."
if we want that.
+.BR \'./\' " or " \'../\'
+then that explicit path to the configuration file will be used.
+See also the CONFIGURATION FILE FORMAT section below.
+.TP
.BI \-b " block_size_options"
This option specifies the fundamental block size of the filesystem.
The valid
@@ -920,6 +954,55 @@ Do not attempt to discard blocks at mkfs time.
.TP
.B \-V
Prints the version number and exits.
+.SH CONFIGURATION FILE FORMAT
+The optional default configuration file in
+.B /etc/xfs/mkfs/default
+as well as any alternate configuration file specified via the
+.B \-c
+option follow a simple ini-style format as shown below.
"...must follow the simple ini-style format..."
i suppose. bad grammar from me in any case.
+Available options consist of a small subset of the parameters available
+via the
+.BR mkfs.xfs (8)
+command line.
+Currently all default parameters can only be either enabled or disabled,
+with a value of 1 to enable or 0 to disable.
+See below for a list of all supported configuration parameters and their
+current built-in default settings.
+.PP
+.BI [data]
+.br
+.BI noalign=0
+.PP
+.BI [inode]
+.br
+.BI align=1
+.br
+.BI projid32bit=1
+.br
+.BI sparse=0
+.PP
+.BI [log]
+.br
+.BI lazy-count=1
+.PP
+.BI [metadata]
+.br
+.BI crc=1
+.br
+.BI finobt=1
+.br
+.BI rmapbt=0
+.br
+.BI reflink=0
+.PP
+.BI [naming]
+.br
+.BI ftype=1
+.PP
+.BI [rtdev]
+.br
+.BI noalign=0
Probably we need to add a build-time helper that reads in the default
config and spits out an ini file which can then be rolled into this
manpage and/or used to generate a totally commented out defaults file.
Eventually.
-Eric
--
To unsubscribe from this list: send the line "unsubscribe linux-xfs" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
