* [PATCH] xfs_quota: fix up dump and report documentation
@ 2021-12-17 20:20 Eric Sandeen
2021-12-17 20:29 ` Darrick J. Wong
2021-12-24 7:06 ` Christoph Hellwig
0 siblings, 2 replies; 3+ messages in thread
From: Eric Sandeen @ 2021-12-17 20:20 UTC (permalink / raw)
To: linux-xfs
From: Eric Sandeen <sandeen@redhat.com>
Documentation for these commands was a bit of a mess.
1) The help args were respecified in the _help() functions, overwriting
the strings which had been set up in the _init functions as all
other commands do. Worse, in the report case, they differed.
2) The -L/-U dump options were not present in either short help string.
3) The -L/-U dump options were not documented in the xfs_quota manpage.
Signed-off-by: Eric Sandeen <sandeen@redhat.com>
Signed-off-by: Eric Sandeen <sandeen@sandeen.net>
---
man/man8/xfs_quota.8 | 9 ++++++++-
quota/report.c | 10 ++++------
2 files changed, 12 insertions(+), 7 deletions(-)
diff --git a/man/man8/xfs_quota.8 b/man/man8/xfs_quota.8
index 59e603f0..fd4562a1 100644
--- a/man/man8/xfs_quota.8
+++ b/man/man8/xfs_quota.8
@@ -393,7 +393,7 @@ option outputs the numeric ID instead of the name. The
.B \-L
and
.B \-U
-options specify lower and upper ID bounds to report on. If upper/lower
+options specify lower and/or upper ID bounds to report on. If upper/lower
bounds are specified, then by default only the IDs will be displayed
in output; with the
.B \-l
@@ -558,6 +558,8 @@ report an error.
[
.BR \-g " | " \-p " | " \-u
] [
+.BR \-L " | " \-U
+] [
.B \-f
.I file
]
@@ -565,6 +567,11 @@ report an error.
Dump out quota limit information for backup utilities, either to
standard output (default) or to a
.IR file .
+The
+.B \-L
+and
+.B \-U
+options specify lower and/or upper ID bounds to dump.
This is only the limits, not the usage information, of course.
.HP
.B restore
diff --git a/quota/report.c b/quota/report.c
index 6ac55490..2eb5b5a9 100644
--- a/quota/report.c
+++ b/quota/report.c
@@ -18,14 +18,14 @@ static cmdinfo_t report_cmd;
static void
dump_help(void)
{
- dump_cmd.args = _("[-g|-p|-u] [-f file]");
- dump_cmd.oneline = _("dump quota information for backup utilities");
printf(_(
"\n"
" create a backup file which contains quota limits information\n"
" -g -- dump out group quota limits\n"
" -p -- dump out project quota limits\n"
" -u -- dump out user quota limits (default)\n"
+" -L -- lower ID bound to dump\n"
+" -U -- upper ID bound to dump\n"
" -f -- write the dump out to the specified file\n"
"\n"));
}
@@ -33,8 +33,6 @@ dump_help(void)
static void
report_help(void)
{
- report_cmd.args = _("[-bir] [-gpu] [-ahntlLNU] [-f file]");
- report_cmd.oneline = _("report filesystem quota information");
printf(_(
"\n"
" report used space and inodes, and quota limits, for a filesystem\n"
@@ -757,7 +755,7 @@ report_init(void)
dump_cmd.cfunc = dump_f;
dump_cmd.argmin = 0;
dump_cmd.argmax = -1;
- dump_cmd.args = _("[-g|-p|-u] [-f file]");
+ dump_cmd.args = _("[-g|-p|-u] [-LU] [-f file]");
dump_cmd.oneline = _("dump quota information for backup utilities");
dump_cmd.help = dump_help;
dump_cmd.flags = CMD_FLAG_FOREIGN_OK;
@@ -767,7 +765,7 @@ report_init(void)
report_cmd.cfunc = report_f;
report_cmd.argmin = 0;
report_cmd.argmax = -1;
- report_cmd.args = _("[-bir] [-gpu] [-ahnt] [-f file]");
+ report_cmd.args = _("[-bir] [-gpu] [-ahntlLNU] [-f file]");
report_cmd.oneline = _("report filesystem quota information");
report_cmd.help = report_help;
report_cmd.flags = CMD_FLAG_ONESHOT | CMD_FLAG_FOREIGN_OK;
--
2.33.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] xfs_quota: fix up dump and report documentation
2021-12-17 20:20 [PATCH] xfs_quota: fix up dump and report documentation Eric Sandeen
@ 2021-12-17 20:29 ` Darrick J. Wong
2021-12-24 7:06 ` Christoph Hellwig
1 sibling, 0 replies; 3+ messages in thread
From: Darrick J. Wong @ 2021-12-17 20:29 UTC (permalink / raw)
To: Eric Sandeen; +Cc: linux-xfs
On Fri, Dec 17, 2021 at 02:20:50PM -0600, Eric Sandeen wrote:
> From: Eric Sandeen <sandeen@redhat.com>
>
> Documentation for these commands was a bit of a mess.
>
> 1) The help args were respecified in the _help() functions, overwriting
> the strings which had been set up in the _init functions as all
> other commands do. Worse, in the report case, they differed.
>
> 2) The -L/-U dump options were not present in either short help string.
>
> 3) The -L/-U dump options were not documented in the xfs_quota manpage.
>
> Signed-off-by: Eric Sandeen <sandeen@redhat.com>
> Signed-off-by: Eric Sandeen <sandeen@sandeen.net>
Looks good to me,
Reviewed-by: Darrick J. Wong <djwong@kernel.org>
--D
> ---
> man/man8/xfs_quota.8 | 9 ++++++++-
> quota/report.c | 10 ++++------
> 2 files changed, 12 insertions(+), 7 deletions(-)
>
> diff --git a/man/man8/xfs_quota.8 b/man/man8/xfs_quota.8
> index 59e603f0..fd4562a1 100644
> --- a/man/man8/xfs_quota.8
> +++ b/man/man8/xfs_quota.8
> @@ -393,7 +393,7 @@ option outputs the numeric ID instead of the name. The
> .B \-L
> and
> .B \-U
> -options specify lower and upper ID bounds to report on. If upper/lower
> +options specify lower and/or upper ID bounds to report on. If upper/lower
> bounds are specified, then by default only the IDs will be displayed
> in output; with the
> .B \-l
> @@ -558,6 +558,8 @@ report an error.
> [
> .BR \-g " | " \-p " | " \-u
> ] [
> +.BR \-L " | " \-U
> +] [
> .B \-f
> .I file
> ]
> @@ -565,6 +567,11 @@ report an error.
> Dump out quota limit information for backup utilities, either to
> standard output (default) or to a
> .IR file .
> +The
> +.B \-L
> +and
> +.B \-U
> +options specify lower and/or upper ID bounds to dump.
> This is only the limits, not the usage information, of course.
> .HP
> .B restore
> diff --git a/quota/report.c b/quota/report.c
> index 6ac55490..2eb5b5a9 100644
> --- a/quota/report.c
> +++ b/quota/report.c
> @@ -18,14 +18,14 @@ static cmdinfo_t report_cmd;
> static void
> dump_help(void)
> {
> - dump_cmd.args = _("[-g|-p|-u] [-f file]");
> - dump_cmd.oneline = _("dump quota information for backup utilities");
> printf(_(
> "\n"
> " create a backup file which contains quota limits information\n"
> " -g -- dump out group quota limits\n"
> " -p -- dump out project quota limits\n"
> " -u -- dump out user quota limits (default)\n"
> +" -L -- lower ID bound to dump\n"
> +" -U -- upper ID bound to dump\n"
> " -f -- write the dump out to the specified file\n"
> "\n"));
> }
> @@ -33,8 +33,6 @@ dump_help(void)
> static void
> report_help(void)
> {
> - report_cmd.args = _("[-bir] [-gpu] [-ahntlLNU] [-f file]");
> - report_cmd.oneline = _("report filesystem quota information");
> printf(_(
> "\n"
> " report used space and inodes, and quota limits, for a filesystem\n"
> @@ -757,7 +755,7 @@ report_init(void)
> dump_cmd.cfunc = dump_f;
> dump_cmd.argmin = 0;
> dump_cmd.argmax = -1;
> - dump_cmd.args = _("[-g|-p|-u] [-f file]");
> + dump_cmd.args = _("[-g|-p|-u] [-LU] [-f file]");
> dump_cmd.oneline = _("dump quota information for backup utilities");
> dump_cmd.help = dump_help;
> dump_cmd.flags = CMD_FLAG_FOREIGN_OK;
> @@ -767,7 +765,7 @@ report_init(void)
> report_cmd.cfunc = report_f;
> report_cmd.argmin = 0;
> report_cmd.argmax = -1;
> - report_cmd.args = _("[-bir] [-gpu] [-ahnt] [-f file]");
> + report_cmd.args = _("[-bir] [-gpu] [-ahntlLNU] [-f file]");
> report_cmd.oneline = _("report filesystem quota information");
> report_cmd.help = report_help;
> report_cmd.flags = CMD_FLAG_ONESHOT | CMD_FLAG_FOREIGN_OK;
> --
> 2.33.1
>
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] xfs_quota: fix up dump and report documentation
2021-12-17 20:20 [PATCH] xfs_quota: fix up dump and report documentation Eric Sandeen
2021-12-17 20:29 ` Darrick J. Wong
@ 2021-12-24 7:06 ` Christoph Hellwig
1 sibling, 0 replies; 3+ messages in thread
From: Christoph Hellwig @ 2021-12-24 7:06 UTC (permalink / raw)
To: Eric Sandeen; +Cc: linux-xfs
On Fri, Dec 17, 2021 at 02:20:50PM -0600, Eric Sandeen wrote:
> From: Eric Sandeen <sandeen@redhat.com>
>
> Documentation for these commands was a bit of a mess.
>
> 1) The help args were respecified in the _help() functions, overwriting
> the strings which had been set up in the _init functions as all
> other commands do. Worse, in the report case, they differed.
>
> 2) The -L/-U dump options were not present in either short help string.
>
> 3) The -L/-U dump options were not documented in the xfs_quota manpage.
>
> Signed-off-by: Eric Sandeen <sandeen@redhat.com>
> Signed-off-by: Eric Sandeen <sandeen@sandeen.net>
Why the double₋signoff?
Otherwise looks good:
Reviewed-by: Christoph Hellwig <hch@lst.de>
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2021-12-24 7:06 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-12-17 20:20 [PATCH] xfs_quota: fix up dump and report documentation Eric Sandeen
2021-12-17 20:29 ` Darrick J. Wong
2021-12-24 7:06 ` Christoph Hellwig
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.