doc txt & -h consistency: fix mismatching labels

Fix various inconsistencies between command SYNOPSIS and the
corresponding -h output where our translatable labels didn't match
up.

In some cases we need to adjust the prose that follows the SYNOPSIS
accordingly, as it refers back to the changed label.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Ævar Arnfjörð Bjarmason 2022-10-13 17:39:10 +02:00 committed by Junio C Hamano
parent a0c3244796
commit f6a8ef0700
18 changed files with 35 additions and 35 deletions

View File

@ -8,7 +8,7 @@ git-clean - Remove untracked files from the working tree
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'git clean' [-d] [-f] [-i] [-n] [-q] [-e <pattern>] [-x | -X] [--] <path>... 'git clean' [-d] [-f] [-i] [-n] [-q] [-e <pattern>] [-x | -X] [--] <pathspec>...
DESCRIPTION DESCRIPTION
----------- -----------
@ -20,16 +20,16 @@ Normally, only files unknown to Git are removed, but if the `-x`
option is specified, ignored files are also removed. This can, for option is specified, ignored files are also removed. This can, for
example, be useful to remove all build products. example, be useful to remove all build products.
If any optional `<path>...` arguments are given, only those paths If any optional `<pathspec>...` arguments are given, only those paths
are affected. that match the pathspec are affected.
OPTIONS OPTIONS
------- -------
-d:: -d::
Normally, when no <path> is specified, git clean will not Normally, when no <pathspec> is specified, git clean will not
recurse into untracked directories to avoid removing too much. recurse into untracked directories to avoid removing too much.
Specify -d to have it recurse into such directories as well. Specify -d to have it recurse into such directories as well.
If any paths are specified, -d is irrelevant; all untracked If a <pathspec> is specified, -d is irrelevant; all untracked
files matching the specified paths (with exceptions for nested files matching the specified paths (with exceptions for nested
git directories mentioned under `--force`) will be removed. git directories mentioned under `--force`) will be removed.

View File

@ -8,7 +8,7 @@ git-credential-cache--daemon - Temporarily store user credentials in memory
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'git credential-cache{litdd}daemon' [--debug] <socket> 'git credential-cache{litdd}daemon' [--debug] <socket-path>
DESCRIPTION DESCRIPTION
----------- -----------
@ -16,7 +16,7 @@ DESCRIPTION
NOTE: You probably don't want to invoke this command yourself; it is NOTE: You probably don't want to invoke this command yourself; it is
started automatically when you use linkgit:git-credential-cache[1]. started automatically when you use linkgit:git-credential-cache[1].
This command listens on the Unix domain socket specified by `<socket>` This command listens on the Unix domain socket specified by `<socket-path>`
for `git-credential-cache` clients. Clients may store and retrieve for `git-credential-cache` clients. Clients may store and retrieve
credentials. Each credential is held for a timeout specified by the credentials. Each credential is held for a timeout specified by the
client; once no credentials are held, the daemon exits. client; once no credentials are held, the daemon exits.

View File

@ -9,7 +9,7 @@ git-mv - Move or rename a file, a directory, or a symlink
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'git mv' [<options>] <args>... 'git mv' [<options>] <source>... <destination>
DESCRIPTION DESCRIPTION
----------- -----------
@ -30,7 +30,7 @@ OPTIONS
------- -------
-f:: -f::
--force:: --force::
Force renaming or moving of a file even if the target exists Force renaming or moving of a file even if the <destination> exists.
-k:: -k::
Skip move or rename actions which would lead to an error Skip move or rename actions which would lead to an error
condition. An error happens when a source is neither existing nor condition. An error happens when a source is neither existing nor

View File

@ -9,7 +9,7 @@ git-receive-pack - Receive what is pushed into the repository
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'git-receive-pack' <directory> 'git-receive-pack' <git-dir>
DESCRIPTION DESCRIPTION
----------- -----------
@ -38,7 +38,7 @@ its behavior, see linkgit:git-config[1].
OPTIONS OPTIONS
------- -------
<directory>:: <git-dir>::
The repository to sync into. The repository to sync into.
--http-backend-info-refs:: --http-backend-info-refs::

View File

@ -9,7 +9,7 @@ git-tag - Create, list, delete or verify a tag object signed with GPG
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'git tag' [-a | -s | -u <keyid>] [-f] [-m <msg> | -F <file>] [-e] 'git tag' [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>] [-e]
<tagname> [<commit> | <object>] <tagname> [<commit> | <object>]
'git tag' -d <tagname>... 'git tag' -d <tagname>...
'git tag' [-n[<num>]] -l [--contains <commit>] [--no-contains <commit>] 'git tag' [-n[<num>]] -l [--contains <commit>] [--no-contains <commit>]
@ -26,19 +26,19 @@ to delete, list or verify tags.
Unless `-f` is given, the named tag must not yet exist. Unless `-f` is given, the named tag must not yet exist.
If one of `-a`, `-s`, or `-u <keyid>` is passed, the command If one of `-a`, `-s`, or `-u <key-id>` is passed, the command
creates a 'tag' object, and requires a tag message. Unless creates a 'tag' object, and requires a tag message. Unless
`-m <msg>` or `-F <file>` is given, an editor is started for the user to type `-m <msg>` or `-F <file>` is given, an editor is started for the user to type
in the tag message. in the tag message.
If `-m <msg>` or `-F <file>` is given and `-a`, `-s`, and `-u <keyid>` If `-m <msg>` or `-F <file>` is given and `-a`, `-s`, and `-u <key-id>`
are absent, `-a` is implied. are absent, `-a` is implied.
Otherwise, a tag reference that points directly at the given object Otherwise, a tag reference that points directly at the given object
(i.e., a lightweight tag) is created. (i.e., a lightweight tag) is created.
A GnuPG signed tag object will be created when `-s` or `-u A GnuPG signed tag object will be created when `-s` or `-u
<keyid>` is used. When `-u <keyid>` is not used, the <key-id>` is used. When `-u <key-id>` is not used, the
committer identity for the current user is used to find the committer identity for the current user is used to find the
GnuPG key for signing. The configuration variable `gpg.program` GnuPG key for signing. The configuration variable `gpg.program`
is used to specify custom GnuPG binary. is used to specify custom GnuPG binary.
@ -72,8 +72,8 @@ OPTIONS
Override `tag.gpgSign` configuration variable that is Override `tag.gpgSign` configuration variable that is
set to force each and every tag to be signed. set to force each and every tag to be signed.
-u <keyid>:: -u <key-id>::
--local-user=<keyid>:: --local-user=<key-id>::
Make a GPG-signed tag, using the given key. Make a GPG-signed tag, using the given key.
-f:: -f::
@ -164,14 +164,14 @@ This option is only applicable when listing tags without annotation lines.
Use the given tag message (instead of prompting). Use the given tag message (instead of prompting).
If multiple `-m` options are given, their values are If multiple `-m` options are given, their values are
concatenated as separate paragraphs. concatenated as separate paragraphs.
Implies `-a` if none of `-a`, `-s`, or `-u <keyid>` Implies `-a` if none of `-a`, `-s`, or `-u <key-id>`
is given. is given.
-F <file>:: -F <file>::
--file=<file>:: --file=<file>::
Take the tag message from the given file. Use '-' to Take the tag message from the given file. Use '-' to
read the message from the standard input. read the message from the standard input.
Implies `-a` if none of `-a`, `-s`, or `-u <keyid>` Implies `-a` if none of `-a`, `-s`, or `-u <key-id>`
is given. is given.
-e:: -e::
@ -220,7 +220,7 @@ it in the repository configuration as follows:
------------------------------------- -------------------------------------
[user] [user]
signingKey = <gpg-keyid> signingKey = <gpg-key_id>
------------------------------------- -------------------------------------
`pager.tag` is only respected when listing tags, i.e., when `-l` is `pager.tag` is only respected when listing tags, i.e., when `-l` is

View File

@ -9,7 +9,7 @@ git-upload-archive - Send archive back to git-archive
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'git upload-archive' <directory> 'git upload-archive' <repository>
DESCRIPTION DESCRIPTION
----------- -----------
@ -54,7 +54,7 @@ access via non-smart-http.
OPTIONS OPTIONS
------- -------
<directory>:: <repository>::
The repository to get a tar archive from. The repository to get a tar archive from.
GIT GIT

View File

@ -60,7 +60,7 @@ static void get_populated_hooks(struct strbuf *hook_info, int nongit)
} }
static const char * const bugreport_usage[] = { static const char * const bugreport_usage[] = {
N_("git bugreport [(-o | --output-directory) <file>] [(-s | --suffix) <format>]\n" N_("git bugreport [(-o | --output-directory) <path>] [(-s | --suffix) <format>]\n"
" [--diagnose[=<mode>]]"), " [--diagnose[=<mode>]]"),
NULL NULL
}; };

View File

@ -26,7 +26,7 @@ static struct string_list del_list = STRING_LIST_INIT_DUP;
static unsigned int colopts; static unsigned int colopts;
static const char *const builtin_clean_usage[] = { static const char *const builtin_clean_usage[] = {
N_("git clean [-d] [-f] [-i] [-n] [-q] [-e <pattern>] [-x | -X] [--] <paths>..."), N_("git clean [-d] [-f] [-i] [-n] [-q] [-e <pattern>] [-x | -X] [--] <pathspec>..."),
NULL NULL
}; };

View File

@ -10,10 +10,10 @@
#include "tag.h" #include "tag.h"
#define BUILTIN_COMMIT_GRAPH_VERIFY_USAGE \ #define BUILTIN_COMMIT_GRAPH_VERIFY_USAGE \
N_("git commit-graph verify [--object-dir <objdir>] [--shallow] [--[no-]progress]") N_("git commit-graph verify [--object-dir <dir>] [--shallow] [--[no-]progress]")
#define BUILTIN_COMMIT_GRAPH_WRITE_USAGE \ #define BUILTIN_COMMIT_GRAPH_WRITE_USAGE \
N_("git commit-graph write [--object-dir <objdir>] [--append]\n" \ N_("git commit-graph write [--object-dir <dir>] [--append]\n" \
" [--split[=<strategy>]] [--reachable | --stdin-packs | --stdin-commits]\n" \ " [--split[=<strategy>]] [--reachable | --stdin-packs | --stdin-commits]\n" \
" [--changed-paths] [--[no-]max-new-filters <n>] [--[no-]progress]\n" \ " [--changed-paths] [--[no-]max-new-filters <n>] [--[no-]progress]\n" \
" <split options>") " <split options>")

View File

@ -6,7 +6,7 @@
#include "string-list.h" #include "string-list.h"
static const char * const for_each_repo_usage[] = { static const char * const for_each_repo_usage[] = {
N_("git for-each-repo --config=<config> <command-args>"), N_("git for-each-repo --config=<config> <arguments>"),
NULL NULL
}; };

View File

@ -14,7 +14,7 @@
#define BLKSIZE 512 #define BLKSIZE 512
static const char pack_redundant_usage[] = static const char pack_redundant_usage[] =
"git pack-redundant [--verbose] [--alt-odb] (--all | <filename.pack>...)"; "git pack-redundant [--verbose] [--alt-odb] (--all | <pack-filename>...)";
static int load_all_packs, verbose, alt_odb; static int load_all_packs, verbose, alt_odb;

View File

@ -10,7 +10,7 @@
#include "pathspec.h" #include "pathspec.h"
static const char * const rerere_usage[] = { static const char * const rerere_usage[] = {
N_("git rerere [clear | forget <path>... | status | remaining | diff | gc]"), N_("git rerere [clear | forget <pathspec>... | status | remaining | diff | gc]"),
NULL, NULL,
}; };

View File

@ -20,7 +20,7 @@
#include "packfile.h" #include "packfile.h"
static const char rev_list_usage[] = static const char rev_list_usage[] =
"git rev-list [<options>] <commit-id>... [-- <path>...]\n" "git rev-list [<options>] <commit>... [-- <path>...]\n"
"\n" "\n"
" limiting output:\n" " limiting output:\n"
" --max-count=<n>\n" " --max-count=<n>\n"

View File

@ -22,7 +22,7 @@
#define INCLUDE_ALL_FILES 2 #define INCLUDE_ALL_FILES 2
static const char * const git_stash_usage[] = { static const char * const git_stash_usage[] = {
N_("git stash list [<options>]"), N_("git stash list [<log-options>]"),
N_("git stash show [<options>] [<stash>]"), N_("git stash show [<options>] [<stash>]"),
N_("git stash drop [-q | --quiet] [<stash>]"), N_("git stash drop [-q | --quiet] [<stash>]"),
N_("git stash (pop | apply) [--index] [-q | --quiet] [<stash>]"), N_("git stash (pop | apply) [--index] [-q | --quiet] [<stash>]"),

View File

@ -27,7 +27,7 @@ int cmd_unpack_file(int argc, const char **argv, const char *prefix)
struct object_id oid; struct object_id oid;
if (argc != 2 || !strcmp(argv[1], "-h")) if (argc != 2 || !strcmp(argv[1], "-h"))
usage("git unpack-file <sha1>"); usage("git unpack-file <blob>");
if (get_oid(argv[1], &oid)) if (get_oid(argv[1], &oid))
die("Not a valid object name %s", argv[1]); die("Not a valid object name %s", argv[1]);

View File

@ -10,7 +10,7 @@
#include "strvec.h" #include "strvec.h"
static const char upload_archive_usage[] = static const char upload_archive_usage[] =
"git upload-archive <repo>"; "git upload-archive <repository>";
static const char deadchild[] = static const char deadchild[] =
"git upload-archive: archiver died with error"; "git upload-archive: archiver died with error";

View File

@ -56,7 +56,7 @@ static int verify_one_pack(const char *path, unsigned int flags, const char *has
} }
static const char * const verify_pack_usage[] = { static const char * const verify_pack_usage[] = {
N_("git verify-pack [-v | --verbose] [-s | --stat-only] <pack>..."), N_("git verify-pack [-v | --verbose] [-s | --stat-only] <pack>.idx..."),
NULL NULL
}; };

View File

@ -23,7 +23,7 @@ static const char * const worktree_usage[] = {
N_("git worktree prune [<options>]"), N_("git worktree prune [<options>]"),
N_("git worktree remove [<options>] <worktree>"), N_("git worktree remove [<options>] <worktree>"),
N_("git worktree repair [<path>...]"), N_("git worktree repair [<path>...]"),
N_("git worktree unlock <path>"), N_("git worktree unlock <worktree>"),
NULL NULL
}; };