On Mon, Jan 27, 2020 at 11:29:03PM +0100, Andreas P wrote:
>The --help parameter output in daemon/automount.c has been updated by
>removing typos, fixing formatting, As well trying to make minor
>changes to to make it easier to read.
>
>Cheers
>
>Signed-off-by: Andreas Polnas <nurgrak@xxxxxxxxx>
>---
>
>diff --git a/daemon/automount.c b/daemon/automount.c
>index 8ec4ac5..a7420fd 100644
>--- a/daemon/automount.c
>+++ b/daemon/automount.c
>@@ -1923,33 +1923,33 @@ static void usage(void)
> {
> fprintf(stderr,
> "Usage: %s [options] [master_map_name]\n"
>- " -h --help this text\n"
>- " -p --pid-file f write process id to file f\n"
>- " -t --timeout n auto-unmount in n seconds (0-disable)\n"
>+ " -h --help Show this help\n"
>+ " -p --pid-file f Write process id to file \n"
>+ " -t --timeout n Auto-unmount in n seconds (0-disable)\n"
Would (0=>disable) or (0=disable) be better? Not sure.
> " -M --master-wait n\n"
>- " maximum wait time (seconds)
>for master\n"
>+ " Maximum wait time for master\n"
> " map to become available\n"
My initial reaction was I'd be happier with the unit left in, eg
+ " Maximum wait time (sec) for master\n"
but see below.
>- " -v --verbose be verbose\n"
>- " -d --debug log debuging info\n"
>- " -Dvariable=value, --define variable=value\n"
>- " define global macro variable\n"
>+ " -v --verbose Verbose logging\n"
>+ " -d --debug Log debugging info\n"
>+ " -D variable=value, --define variable=value\n"
>+ " Define global macro variable\n"
> " -S --systemd-service\n"
>- " run automounter as a systemd service\n"
>- " -f --foreground do not fork into background\n"
>+ " Run automounter as a systemd service\n"
>+ " -f --foreground Run automount daemon in the
>foreground\n"
> " -r --random-multimount-selection\n"
>- " use ramdom replicated server
>selection\n"
>+ " Use random replicated server
>selection\n"
> " -m --dumpmaps [<map type> <map name>]\n"
>- " dump automounter maps and exit\n"
>+ " Dump automounter maps and exit\n"
> " -n --negative-timeout n\n"
>- " set the timeout for failed key
>lookups.\n"
>+ " Set the timeout for failed key
>lookups\n"
Possibly the unit of time should be given here too,
but if it's mentioned for one time-like argument above (-t)
the reader will likely assume correctly all such use the same unit.
The man page documents the unit, anyway.
I wondered briefly what the default was, but that's too much detail
here; it's in the man page.
> " -O --global-options\n"
>- " specify global mount options\n"
>+ " Specify global mount options\n"
> " -l --set-log-priority priority path [path,...]\n"
>- " set daemon log verbosity\n"
>+ " Set daemon log verbosity\n"
> " -C --dont-check-daemon\n"
>- " don't check if daemon is
>already running\n"
>- " -F --force forceably clean up known
>automounts at start\n"
>- " -V --version print version, build config and exit\n"
>+ " Don't check if daemon is
>already running\n"
>+ " -F --force Forceably clean up known
>automounts at start\n"
This should be 'Forcibly'
>+ " -V --version Print package version, build
>config and exit\n"
> , program);
> }
HTH
Reviewed-by: vincent.mcintyre@xxxxxxxx (fwiw)
