From: "Darrick J. Wong" <darrick.wong@oracle.com>
To: sandeen@redhat.com, darrick.wong@oracle.com
Cc: linux-xfs@vger.kernel.org
Subject: [PATCH 5/5] mkfs: generate mkfs config file in man page
Date: Wed, 13 Jun 2018 12:32:22 -0700 [thread overview]
Message-ID: <152891834283.3968.15510112783863370484.stgit@magnolia> (raw)
In-Reply-To: <152891829964.3968.4760134019673731615.stgit@magnolia>
From: Darrick J. Wong <darrick.wong@oracle.com>
Generate the default mkfs config file in the man page.
Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
---
Makefile | 1 +
man/man8/Makefile | 13 ++++++++++---
man/man8/mkfs.xfs.8.in | 35 +----------------------------------
mkfs/mkconfig.c | 22 ++++++++++++++++------
4 files changed, 28 insertions(+), 43 deletions(-)
diff --git a/Makefile b/Makefile
index 7ddfa316..947eaaf5 100644
--- a/Makefile
+++ b/Makefile
@@ -92,6 +92,7 @@ copy: libxlog
mkfs: libxcmd
spaceman: libxcmd
scrub: libhandle libxcmd
+man: mkfs
ifeq ($(HAVE_BUILDDEFS), yes)
include $(BUILDRULES)
diff --git a/man/man8/Makefile b/man/man8/Makefile
index 08e5e0d7..67a67cd2 100644
--- a/man/man8/Makefile
+++ b/man/man8/Makefile
@@ -13,13 +13,20 @@ LSRCFILES = $(MAN_PAGES)
default : $(MAN_PAGES)
-LDIRT = mkfs.xfs.8
+LDIRT = mkfs.xfs.8 cfg.8
include $(BUILDRULES)
-mkfs.xfs.8: mkfs.xfs.8.in
+cfg.8: ../../mkfs/mkconfig
+ @echo " [GENERATE] $@"
+ $(Q) ../../mkfs/mkconfig -m > $@
+
+mkfs.xfs.8: mkfs.xfs.8.in cfg.8
@echo " [SED] $@"
- $(Q)$(SED) -e "s|@sysconfdir@|$(PKG_ETC_DIR)|g" < $< > $@
+ $(Q) $(SED) -e "s|@sysconfdir@|$(PKG_ETC_DIR)|g" \
+ -e "/@default_mkfs_cfg@/r cfg.8" \
+ -e "s/@default_mkfs_cfg@//g" \
+ < $< > $@
install : default
$(INSTALL) -m 755 -d $(MAN_DEST)
diff --git a/man/man8/mkfs.xfs.8.in b/man/man8/mkfs.xfs.8.in
index cf4bdf82..4a557910 100644
--- a/man/man8/mkfs.xfs.8.in
+++ b/man/man8/mkfs.xfs.8.in
@@ -970,40 +970,7 @@ 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
+@default_mkfs_cfg@
.PP
.SH SEE ALSO
.BR xfs (5),
diff --git a/mkfs/mkconfig.c b/mkfs/mkconfig.c
index 3826b0bf..ef00f6d9 100644
--- a/mkfs/mkconfig.c
+++ b/mkfs/mkconfig.c
@@ -124,9 +124,13 @@ main(
struct subopt_map *submap;
int c;
unsigned int i, j;
+ bool manpage = false;
- while ((c = getopt(argc, argv, "")) != EOF) {
+ while ((c = getopt(argc, argv, "m")) != EOF) {
switch (c) {
+ case 'm':
+ manpage = true;
+ break;
case '?':
fprintf(stderr, "Unknown option %c.\n", optopt);
return 1;
@@ -137,19 +141,25 @@ main(
return 1;
}
- printf("# mkfs.xfs configuration file to collect settings.\n");
- printf("# See the mkfs.xfs(8) manpage for details.\n");
- printf("# Copy this file to %s/%s to override the built-in defaults.\n",
- MKFS_XFS_CONF_DIR, MKFS_XFS_DEFAULT_CONFIG);
+ if (!manpage) {
+ printf("# mkfs.xfs configuration file to collect settings.\n");
+ printf("# See the mkfs.xfs(8) manpage for details.\n");
+ printf("# Copy this file to %s/%s to override the built-in defaults.\n",
+ MKFS_XFS_CONF_DIR, MKFS_XFS_DEFAULT_CONFIG);
+ }
for (i = 0; i < ARRAY_SIZE(confopts_tab); i++, opts++) {
- if (i > 0)
+ if (manpage)
+ printf(".PP\n.B ");
+ else if (i > 0)
printf("\n");
printf("[%s]\n", opts->name);
submap = opts->subopts;
for (j = 0;
j < ARRAY_SIZE(opts->subopts) && submap->suboptname;
j++, submap++) {
+ if (manpage)
+ printf(".br\n.B ");
printf("%s = ", submap->suboptname);
switch (submap->type) {
case FV_BOOL:
next prev parent reply other threads:[~2018-06-13 19:32 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-06-13 19:31 [PATCH 0/5] xfsprogs-4.17: mkfs config file enhancements Darrick J. Wong
2018-06-13 19:31 ` [PATCH 1/5] mkfs: move build-time defaults to a separate file Darrick J. Wong
2018-06-14 2:34 ` Eric Sandeen
2018-06-13 19:31 ` [PATCH 2/5] mkfs: move config file enums to config.h Darrick J. Wong
2018-06-14 2:51 ` Eric Sandeen
2018-06-14 16:24 ` Luis R. Rodriguez
2018-06-13 19:32 ` [PATCH 3/5] mkfs: hoist mkfs configfile dir string generation to build system Darrick J. Wong
2018-06-14 2:54 ` Eric Sandeen
2018-06-13 19:32 ` [PATCH 4/5] mkfs: emit config file from builtin defaults Darrick J. Wong
2018-06-14 3:05 ` Eric Sandeen
2018-06-13 19:32 ` Darrick J. Wong [this message]
2018-06-14 3:17 ` [PATCH 5/5] mkfs: generate mkfs config file in man page Eric Sandeen
2018-06-14 4:06 ` [PATCH 0/5] xfsprogs-4.17: mkfs config file enhancements Dave Chinner
2018-06-14 4:23 ` Eric Sandeen
2018-06-14 5:08 ` Dave Chinner
2018-06-14 6:29 ` Darrick J. Wong
2018-06-14 17:46 ` Luis R. Rodriguez
2018-06-14 17:59 ` Darrick J. Wong
2018-06-14 18:16 ` Luis R. Rodriguez
2018-06-14 18:35 ` Darrick J. Wong
2018-06-16 0:04 ` Luis R. Rodriguez
2018-06-14 19:05 ` Eric Sandeen
2018-06-14 22:22 ` Dave Chinner
2018-06-14 23:33 ` Dave Chinner
2018-06-14 23:38 ` Eric Sandeen
2018-06-14 14:31 ` Eric Sandeen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=152891834283.3968.15510112783863370484.stgit@magnolia \
--to=darrick.wong@oracle.com \
--cc=linux-xfs@vger.kernel.org \
--cc=sandeen@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.