On Thu, Jun 29, 2017 at 02:27:35AM +0200, Ruediger Meier wrote:
> On Thursday 29 June 2017 at 00:44, you wrote:
>
>
> > @@ -101,7 +101,7 @@ static void __attribute__((__noreturn__))
> usage(void)
> > fputs(USAGE_OPTIONS, stdout);
> > fputs(_(" -J, --json use JSON output format\n"),
> stdout);
> > fputs(_(" -n, --noheadings don't print headings\n"),
> stdout);
> > - fputs(_(" -o, --output <list> define which output columns
> to use\n"), stdout);
> > + fputs(_(" -o, --output <list> columns to display (see
> Columns:)\n"), stdout);
> > fputs(_(" -r, --raw use the raw output
> format\n"), stdout);
>
>
> That's not bad but the standard is IMO to use capital letters
> for everthing which is explained below.
>
> This avoids sometimes even the need to explicitly write extra
> terms like "see Columns", see:
>
> Options:
> -n, --noheadings don't print headings
> -o, --output COLUMNS columns to display
I don't like it, we use <list> as information about format. I don't
want to replace <foo> with FOO everywhere. IMHO <foo> is more readable
and it's something we decided years ago.
What about:
-o, --output <list> COLUMNS to display (see below)
I like "COLUMNS" and "(see below)" as a way how to redirect reader to
the right place.
> Available output COLUMNS:
I think "COLUMNS:" as suggested by William is good enough.
Karel
--
Karel Zak <kzak@xxxxxxxxxx>
http://karelzak.blogspot.com
--
To unsubscribe from this list: send the line "unsubscribe util-linux" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
