From 74f7dd0b38a8505943b5dd2ad938932c4f8d35a5 Mon Sep 17 00:00:00 2001 From: Michael Eischer Date: Mon, 6 Feb 2023 22:11:21 +0100 Subject: [PATCH] Make help for --verbose less confusing The output is now ``` -v, --verbose be verbose (specify multiple times or a level using --verbose=n, max level/times is 2) ``` instead of ``` -v, --verbose n be verbose (specify multiple times or a level using --verbose=n, max level/times is 2) ``` --- cmd/restic/global.go | 3 ++- doc/manual_rest.rst | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/cmd/restic/global.go b/cmd/restic/global.go index 517388e8d..b32265275 100644 --- a/cmd/restic/global.go +++ b/cmd/restic/global.go @@ -112,7 +112,8 @@ func init() { f.StringVarP(&globalOptions.KeyHint, "key-hint", "", "", "`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)") f.StringVarP(&globalOptions.PasswordCommand, "password-command", "", "", "shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)") f.BoolVarP(&globalOptions.Quiet, "quiet", "q", false, "do not output comprehensive progress report") - f.CountVarP(&globalOptions.Verbose, "verbose", "v", "be verbose (specify multiple times or a level using --verbose=`n`, max level/times is 2)") + // use empty paremeter name as `-v, --verbose n` instead of the correct `--verbose=n` is confusing + f.CountVarP(&globalOptions.Verbose, "verbose", "v", "be verbose (specify multiple times or a level using --verbose=n``, max level/times is 2)") f.BoolVar(&globalOptions.NoLock, "no-lock", false, "do not lock the repository, this allows some operations on read-only repositories") f.BoolVarP(&globalOptions.JSON, "json", "", false, "set output mode to JSON for commands that support it") f.StringVar(&globalOptions.CacheDir, "cache-dir", "", "set the cache `directory`. (default: use system default cache directory)") diff --git a/doc/manual_rest.rst b/doc/manual_rest.rst index 899a45688..97480db80 100644 --- a/doc/manual_rest.rst +++ b/doc/manual_rest.rst @@ -67,7 +67,7 @@ Usage help is available: -r, --repo repository repository to backup to or restore from (default: $RESTIC_REPOSITORY) --repository-file file file to read the repository location from (default: $RESTIC_REPOSITORY_FILE) --tls-client-cert file path to a file containing PEM encoded TLS client certificate and private key - -v, --verbose n be verbose (specify multiple times or a level using --verbose=n, max level/times is 2) + -v, --verbose be verbose (specify multiple times or a level using --verbose=n, max level/times is 2) Use "restic [command] --help" for more information about a command. @@ -142,7 +142,7 @@ command: -r, --repo repository repository to backup to or restore from (default: $RESTIC_REPOSITORY) --repository-file file file to read the repository location from (default: $RESTIC_REPOSITORY_FILE) --tls-client-cert file path to a file containing PEM encoded TLS client certificate and private key - -v, --verbose n be verbose (specify multiple times or a level using --verbose=n, max level/times is 2) + -v, --verbose be verbose (specify multiple times or a level using --verbose=n, max level/times is 2) Subcommands that support showing progress information such as ``backup``, ``check`` and ``prune`` will do so unless the quiet flag ``-q`` or