On Wed, Jun 21, 2017 at 03:05:04PM +0200, Ruediger Meier wrote:
> On Tuesday 20 June 2017, Karel Zak wrote:
> > On Sun, Jun 18, 2017 at 08:45:09PM -0400, J William Piggott wrote:
> > > Signed-off-by: J William Piggott <elseifthen@xxxxxxx>
> > > ---
> > > include/c.h | 4 ++--
> > > sys-utils/hwclock.c | 48
> > > +++++++++++++++++++++--------------------------- 2 files changed,
> > > 23 insertions(+), 29 deletions(-)
> > >
> > > diff --git a/include/c.h b/include/c.h
> > > index 9c19965..bd073fc 100644
> > > --- a/include/c.h
> > > +++ b/include/c.h
> > > @@ -319,8 +319,8 @@ static inline int xusleep(useconds_t usec)
> > > #define USAGE_OPTIONS _("\nOptions:\n")
> > > #define USAGE_FUNCTIONS _("\nFunctions:\n")
> > > #define USAGE_SEPARATOR "\n"
> > > -#define USAGE_HELP _(" -h, --help display this help and
> > > exit\n") -#define USAGE_VERSION _(" -V, --version output
> > > version information and exit\n") +#define USAGE_HELP _(" -h,
> > > --help display this information and exit\n")
> >
> > "display this help and exit\n"
> > or
> > "display help information and exit\n"
> >
> > sounds better than "this information".
>
> IMO "this" is important because it makes clear that running --help would
> not give you any better information than the one you see already.
>
> Compare this:
> $ xz --help | grep help
> -h, --help display this short help and exit
> -H, --long-help display the long help (lists also the ...
>
> $ xz --long-help | grep help
> -h, --help display the short help (lists only the basic ...
> -H, --long-help display this long help and exit
>
>
> Our old errtryhelp, USAGE_HELP and USAGE_VERSION were 100% the same like
> coreutils. This was a nice consensus and even a bit shorter.
>
> Anyways, instead of improving the grammer and correctness I would rather
> make these trivial option descriptions as short as possible, like
>
> -h, --help display this help
> -V, --version show version
>
> Everybody knows what these options do when they exist.
Good points, please, send a patch. It would be also nice to add any
comment to the c.h to avoid future updates on this area.
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
