On Monday 19 June 2017, Ruediger Meier wrote:
> From: Ruediger Meier <ruediger.meier@xxxxxxxxxxx>
>
> Write --help always to stdout.
> Always use errtryhelp(EX_USAGE) instead of errx(EX_USAGE, ...)
>
> Noticed by
>
> $ ./tools/checkusage.sh flock
> flock: help no stdout
> flock: help non-empty stderr
>
> Signed-off-by: Ruediger Meier <ruediger.meier@xxxxxxxxxxx>
> ---
> sys-utils/flock.c | 67
> +++++++++++++++++++++++++++---------------------------- 1 file
> changed, 33 insertions(+), 34 deletions(-)
>
> diff --git a/sys-utils/flock.c b/sys-utils/flock.c
> index 50194bd..5eab1db 100644
> --- a/sys-utils/flock.c
> +++ b/sys-utils/flock.c
> @@ -46,34 +46,34 @@
> #include "monotonic.h"
> #include "timer.h"
>
> -static void __attribute__((__noreturn__)) usage(int ex)
> +static void __attribute__((__noreturn__)) usage(void)
> {
> - fprintf(stderr, USAGE_HEADER);
> - fprintf(stderr,
> + printf(USAGE_HEADER);
> + printf(
> _(" %1$s [options] <file>|<directory> <command> [<argument>...]\n"
> " %1$s [options] <file>|<directory> -c <command>\n"
> " %1$s [options] <file descriptor number>\n"),
> program_invocation_short_name);
>
> - fputs(USAGE_SEPARATOR, stderr);
> - fputs(_("Manage file locks from shell scripts.\n"), stderr);
> -
> - fputs(USAGE_OPTIONS, stderr);
> - fputs(_( " -s, --shared get a shared lock\n"),
> stderr); - fputs(_( " -x, --exclusive get an exclusive lock
> (default)\n"), stderr); - fputs(_( " -u, --unlock remove
> a lock\n"), stderr); - fputs(_( " -n, --nonblock fail
> rather than wait\n"), stderr); - fputs(_( " -w, --timeout <secs>
> wait for a limited amount of time\n"), stderr); - fputs(_( " -E,
> --conflict-exit-code <number> exit code after conflict or
> timeout\n"), stderr); - fputs(_( " -o, --close close
> file descriptor before running command\n"), stderr); - fputs(_( "
> -c, --command <command> run a single command string through the
> shell\n"), stderr); - fputs(_( " -F, --no-fork execute
> command without forking\n"), stderr); - fputs(_( " --verbose
> increase verbosity\n"), stderr); - fprintf(stderr,
> USAGE_SEPARATOR);
> - fprintf(stderr, USAGE_HELP);
> - fprintf(stderr, USAGE_VERSION);
> - fprintf(stderr, USAGE_MAN_TAIL("flock(1)"));
> - exit(ex);
> + puts(USAGE_SEPARATOR);
> + puts(_("Manage file locks from shell scripts.\n"));
> +
> + puts(USAGE_OPTIONS);
> + puts(_( " -s, --shared get a shared lock\n"));
> + puts(_( " -x, --exclusive get an exclusive lock
> (default)\n")); + puts(_( " -u, --unlock remove a
> lock\n"));
> + puts(_( " -n, --nonblock fail rather than wait\n"));
> + puts(_( " -w, --timeout <secs> wait for a limited amount of
> time\n")); + puts(_( " -E, --conflict-exit-code <number> exit code
> after conflict or timeout\n")); + puts(_( " -o, --close
> close file descriptor before running command\n")); + puts(_( " -c,
> --command <command> run a single command string through the
> shell\n")); + puts(_( " -F, --no-fork execute command
> without forking\n")); + puts(_( " --verbose increase
> verbosity\n")); + printf(USAGE_SEPARATOR);
> + printf(USAGE_HELP);
> + printf(USAGE_VERSION);
> + printf(USAGE_MAN_TAIL("flock(1)"));
> + exit(EXIT_SUCCESS);
> }
Sorry I forgot that the fputs/puts repacement adds another newline.
I could either
1. remove the newlines from the strings (but would this cause extra
work for translators?)
2. use printf instead of puts
3. don't change anything, just use constant FILE argument stdout.
> static sig_atomic_t timeout_expired = 0;
> @@ -170,9 +170,6 @@ int main(int argc, char *argv[])
> textdomain(PACKAGE);
> atexit(close_stdout);
>
> - if (argc < 2)
> - usage(EX_USAGE);
> -
> memset(&timeout, 0, sizeof timeout);
>
> optopt = 0;
> @@ -215,24 +212,25 @@ int main(int argc, char *argv[])
> printf(UTIL_LINUX_VERSION);
> exit(EX_OK);
> case 'h':
> - usage(0);
> + usage();
> default:
> errtryhelp(EX_USAGE);
> }
> }
>
> - if (no_fork && do_close)
> - errx(EX_USAGE,
> - _("the --no-fork and --close options are incompatible"));
> -
> + if (no_fork && do_close) {
> + warnx(_("the --no-fork and --close options are incompatible"));
> + errtryhelp(EX_USAGE);
> + }
> if (argc > optind + 1) {
> /* Run command */
> if (!strcmp(argv[optind + 1], "-c") ||
> !strcmp(argv[optind + 1], "--command")) {
> - if (argc != optind + 3)
> - errx(EX_USAGE,
> - _("%s requires exactly one command argument"),
> + if (argc != optind + 3) {
> + warnx(_("%s requires exactly one command argument"),
> argv[optind + 1]);
> + errtryhelp(EX_USAGE);
> + }
> cmd_argv = sh_c_argv;
> cmd_argv[0] = getenv("SHELL");
> if (!cmd_argv[0] || !*cmd_argv[0])
> @@ -252,7 +250,8 @@ int main(int argc, char *argv[])
> fd = strtos32_or_err(argv[optind], _("bad file descriptor"));
> } else {
> /* Bad options */
> - errx(EX_USAGE, _("requires file descriptor, file or directory"));
> + warnx(_("requires file descriptor, file or directory"));
> + errtryhelp(EX_USAGE);
> }
>
> if (have_timeout) {
--
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
