]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
misc: update --help content again
authorRuediger Meier <ruediger.meier@ga-group.nl>
Sun, 25 Jun 2017 20:01:12 +0000 (22:01 +0200)
committerRuediger Meier <ruediger.meier@ga-group.nl>
Tue, 27 Jun 2017 10:29:37 +0000 (12:29 +0200)
We change

 -h, --help     display this help and exit
 -V, --version  output version information and exit

to

 -h, --help     display this help
 -V, --version  print version

Some thoughts about this:

  * use "display" for --help because it matches better if we
    would add pager support (like git --help)
  * "print" for --version to be different
  * "this" for --help is important to make clear that running
    --help would not give you any better information than the
    one you see already
  * remove "information and exit" because it's bloat for the
    short-help, everybody knows what it does if it exists

In the manpages we should use the old, longer but more correct
descriptions, inclusive a reminder if --help/--version are only
working when used as the only option. Note the term "version
information" indicates that we don't only print a single version
number.

CC: J William Piggott <elseifthen@gmx.com>
Signed-off-by: Ruediger Meier <ruediger.meier@ga-group.nl>
include/c.h

index 94ebf7e7dbb76cd3d479c5f7e574a81f158dda13..fc766e069adc4dbd53e64cf276ebbc19c22fceb1 100644 (file)
@@ -316,8 +316,8 @@ static inline int xusleep(useconds_t usec)
 #define USAGE_COLUMNS    _("\nAvailable output columns:\n")
 #define USAGE_SEPARATOR    "\n"
 
-#define USAGE_OPTSTR_HELP     _("display this help and exit")
-#define USAGE_OPTSTR_VERSION  _("output version information and exit")
+#define USAGE_OPTSTR_HELP     _("display this help")
+#define USAGE_OPTSTR_VERSION  _("print version")
 
 #define print_usage_help_options(marg_dsc) \
        printf( \