Util-Linux package development
 help / color / mirror / Atom feed
From: Ruediger Meier <sweet_f_a@gmx.de>
To: Karel Zak <kzak@redhat.com>
Cc: util-linux@vger.kernel.org
Subject: Re: [PATCH] misc: standardize USAGE_COLUMNS
Date: Thu, 29 Jun 2017 02:27:35 +0200	[thread overview]
Message-ID: <201706290227.35921.sweet_f_a@gmx.de> (raw)
In-Reply-To: <1621510c-227f-325b-7867-c305f738174a@gmx.com>

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
 -r, --raw              use the raw output format
 -h, --help             display this help
 -V, --version          print version

Available output COLUMNS:
     UUID  unique identifier
  VARIANT  variant name
     TYPE  type name
     TIME  timestamp


This is short and easy and quickly to see or search. Anyways
even if you want to keep "see blabla below", BLABLA should be in
capital letters in any case. Compare

$ ls --help | grep SIZE
$ man bash | grep INVOCATION
$ dd --help | grep "\bN\b\|\bBYTES\b"

You see the difference? Imagine if dd would always write
"see BYTES below". That would be pain for the eyes, like
I mentioned in my other email. 

cu,
Rudi

  reply	other threads:[~2017-06-29  0:27 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-06-28 22:44 [PATCH] misc: standardize USAGE_COLUMNS J William Piggott
2017-06-29  0:27 ` Ruediger Meier [this message]
2017-06-29  0:45   ` Ruediger Meier
2017-06-29  8:18   ` Karel Zak

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=201706290227.35921.sweet_f_a@gmx.de \
    --to=sweet_f_a@gmx.de \
    --cc=kzak@redhat.com \
    --cc=util-linux@vger.kernel.org \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox