]> git.ipfire.org Git - thirdparty/xfsprogs-dev.git/commitdiff
mkfs: document sample configuration file location
authorDarrick J. Wong <djwong@kernel.org>
Fri, 25 Feb 2022 22:42:16 +0000 (17:42 -0500)
committerEric Sandeen <sandeen@sandeen.net>
Fri, 25 Feb 2022 22:42:16 +0000 (17:42 -0500)
Update the documentation to note where one can find sample configuration
files.  While we're at it, add -c to the topmost list of mkfs.xfs
options.

Signed-off-by: Darrick J. Wong <djwong@kernel.org>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Eric Sandeen <sandeen@sandeen.net>
man/man8/Makefile
man/man8/mkfs.xfs.8.in [moved from man/man8/mkfs.xfs.8 with 99% similarity]

index e6a557290b4ad9b041c6f3204d72093c5bc64871..272e45aebc20b1c4815c7a0f81b19512123b988d 100644 (file)
@@ -12,8 +12,10 @@ ifneq ("$(ENABLE_SCRUB)","yes")
 else
   MAN_PAGES = $(shell echo *.$(MAN_SECTION))
 endif
+MAN_PAGES      += mkfs.xfs.8
 MAN_DEST       = $(PKG_MAN_DIR)/man$(MAN_SECTION)
 LSRCFILES      = $(MAN_PAGES)
+DIRT           = mkfs.xfs.8
 
 default : $(MAN_PAGES)
 
@@ -22,4 +24,9 @@ include $(BUILDRULES)
 install : default
        $(INSTALL) -m 755 -d $(MAN_DEST)
        $(INSTALL_MAN)
+
+mkfs.xfs.8: mkfs.xfs.8.in
+       @echo "    [SED]    $@"
+       $(Q)$(SED) -e 's|@mkfs_cfg_dir@|$(MKFS_CFG_DIR)|g' < $^ > $@
+
 install-dev :
similarity index 99%
rename from man/man8/mkfs.xfs.8
rename to man/man8/mkfs.xfs.8.in
index 880e949bbd92822ef5b19138e3b62c5a3127fe1c..a35267536b8488132d4a0161826a148e0bc0c7c1 100644 (file)
@@ -7,6 +7,9 @@ mkfs.xfs \- construct an XFS filesystem
 .B \-b
 .I block_size_options
 ] [
+.B \-c
+.I config_file_options
+] [
 .B \-m
 .I global_metadata_options
 ] [
@@ -159,6 +162,7 @@ The configuration options will be sourced from the file specified by the
 option string.
 This option can be use either an absolute or relative path to the configuration
 file to be read.
+Sample configuration files can be found in @mkfs_cfg_dir@.
 .RE
 .PP
 .PD 0