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>

diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt
index a7f309dff5a327ba14b38b63b931060582c53c28..d5587cdd8486bca30c0df9db82eaf76f660642ea 100644 (file)
--- a/Documentation/git-clean.txt
+++ b/Documentation/git-clean.txt
@@ -8,7 +8,7 @@ git-clean - Remove untracked files from the working tree
 SYNOPSIS
 --------
 [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
 -----------
@@ -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
 example, be useful to remove all build products.
 
-If any optional `<path>...` arguments are given, only those paths
-are affected.
+If any optional `<pathspec>...` arguments are given, only those paths
+that match the pathspec are affected.
 
 OPTIONS
 -------
 -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.
        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
        git directories mentioned under `--force`) will be removed.
 

diff --git a/Documentation/git-credential-cache--daemon.txt b/Documentation/git-credential-cache--daemon.txt
index 01e1c214dd82e1564b0459c4d6fe5b9f98ba1082..650a15a7edfa3f066c8adf2204fa3700959030d0 100644 (file)
--- a/Documentation/git-credential-cache--daemon.txt
+++ b/Documentation/git-credential-cache--daemon.txt
@@ -8,7 +8,7 @@ git-credential-cache--daemon - Temporarily store user credentials in memory
 SYNOPSIS
 --------
 [verse]
-'git credential-cache{litdd}daemon' [--debug] <socket>
+'git credential-cache{litdd}daemon' [--debug] <socket-path>
 
 DESCRIPTION
 -----------
@@ -16,7 +16,7 @@ DESCRIPTION
 NOTE: You probably don't want to invoke this command yourself; it is
 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
 credentials. Each credential is held for a timeout specified by the
 client; once no credentials are held, the daemon exits.

diff --git a/Documentation/git-mv.txt b/Documentation/git-mv.txt
index 972a055fbd83d2c114aec46d3d982512b2f387a1..fb0220fd18dc2b99cab472f5b52dfe9930d4bdf9 100644 (file)
--- a/Documentation/git-mv.txt
+++ b/Documentation/git-mv.txt
@@ -9,7 +9,7 @@ git-mv - Move or rename a file, a directory, or a symlink
 SYNOPSIS
 --------
 [verse]
-'git mv' [<options>] <args>...
+'git mv' [<options>] <source>... <destination>
 
 DESCRIPTION
 -----------
@@ -30,7 +30,7 @@ OPTIONS
 -------
 -f::
 --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::
        Skip move or rename actions which would lead to an error
        condition. An error happens when a source is neither existing nor

diff --git a/Documentation/git-receive-pack.txt b/Documentation/git-receive-pack.txt
index 014a78409b9473c10f62f85b21f9d9c6642ff844..5c297db1a4b5f4f1da993e797ff221876fef38e6 100644 (file)
--- a/Documentation/git-receive-pack.txt
+++ b/Documentation/git-receive-pack.txt
@@ -9,7 +9,7 @@ git-receive-pack - Receive what is pushed into the repository
 SYNOPSIS
 --------
 [verse]
-'git-receive-pack' <directory>
+'git-receive-pack' <git-dir>
 
 DESCRIPTION
 -----------
@@ -38,7 +38,7 @@ its behavior, see linkgit:git-config[1].
 
 OPTIONS
 -------
-<directory>::
+<git-dir>::
        The repository to sync into.
 
 --http-backend-info-refs::

diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
index 31a97a1b6c5b22ab5c8b959a8a550126f26146d2..fdc72b5875a343aa9a0360e57bbdac684deee894 100644 (file)
--- a/Documentation/git-tag.txt
+++ b/Documentation/git-tag.txt
@@ -9,7 +9,7 @@ git-tag - Create, list, delete or verify a tag object signed with GPG
 SYNOPSIS
 --------
 [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>]
 'git tag' -d <tagname>...
 '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.
 
-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
 `-m <msg>` or `-F <file>` is given, an editor is started for the user to type
 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.
 
 Otherwise, a tag reference that points directly at the given object
 (i.e., a lightweight tag) is created.
 
 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
 GnuPG key for signing.         The configuration variable `gpg.program`
 is used to specify custom GnuPG binary.
@@ -72,8 +72,8 @@ OPTIONS
        Override `tag.gpgSign` configuration variable that is
        set to force each and every tag to be signed.
 
--u <keyid>::
---local-user=<keyid>::
+-u <key-id>::
+--local-user=<key-id>::
        Make a GPG-signed tag, using the given key.
 
 -f::
@@ -164,14 +164,14 @@ This option is only applicable when listing tags without annotation lines.
        Use the given tag message (instead of prompting).
        If multiple `-m` options are given, their values are
        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.
 
 -F <file>::
 --file=<file>::
        Take the tag message from the given file.  Use '-' to
        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.
 
 -e::
@@ -220,7 +220,7 @@ it in the repository configuration as follows:
 
 -------------------------------------
 [user]
-    signingKey = <gpg-keyid>
+    signingKey = <gpg-key_id>
 -------------------------------------
 
 `pager.tag` is only respected when listing tags, i.e., when `-l` is

diff --git a/Documentation/git-upload-archive.txt b/Documentation/git-upload-archive.txt
index fba0f1c1b27c629b31c86f78fbe22fdfd3ce360d..e8eb10baad79dd8648efbaab9e302114a65d90f9 100644 (file)
--- a/Documentation/git-upload-archive.txt
+++ b/Documentation/git-upload-archive.txt
@@ -9,7 +9,7 @@ git-upload-archive - Send archive back to git-archive
 SYNOPSIS
 --------
 [verse]
-'git upload-archive' <directory>
+'git upload-archive' <repository>
 
 DESCRIPTION
 -----------
@@ -54,7 +54,7 @@ access via non-smart-http.
 
 OPTIONS
 -------
-<directory>::
+<repository>::
        The repository to get a tar archive from.
 
 GIT

diff --git a/builtin/bugreport.c b/builtin/bugreport.c
index 61d93383f515d4a3722a9a0fa5752d161816e763..96052541cbfe74cda5aff77396c94f4fb6397ae7 100644 (file)
--- a/builtin/bugreport.c
+++ b/builtin/bugreport.c
@@ -60,7 +60,7 @@ static void get_populated_hooks(struct strbuf *hook_info, int nongit)
 }
 
 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>]]"),
        NULL
 };

diff --git a/builtin/clean.c b/builtin/clean.c
index 5466636e66604ef5331a6f508d7d4a62e330d1e7..6f039f555b23a5a43be2bc988ee8a8f4908e93a1 100644 (file)
--- a/builtin/clean.c
+++ b/builtin/clean.c
@@ -26,7 +26,7 @@ static struct string_list del_list = STRING_LIST_INIT_DUP;
 static unsigned int colopts;
 
 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
 };
 

diff --git a/builtin/commit-graph.c b/builtin/commit-graph.c
index c21cfd56696f43fab9750679cc46d439d5fdf110..0a68935d9eedab351ec92cfbc33ab4596e9c5244 100644 (file)
--- a/builtin/commit-graph.c
+++ b/builtin/commit-graph.c
@@ -10,10 +10,10 @@
 #include "tag.h"
 
 #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 \
-       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" \
           "                       [--changed-paths] [--[no-]max-new-filters <n>] [--[no-]progress]\n" \
           "                       <split options>")

diff --git a/builtin/for-each-repo.c b/builtin/for-each-repo.c
index fd86e5a8619256fd903122b08e937141eb1725f0..c6379b783c8407c954f734ce9bbb49202f29a12a 100644 (file)
--- a/builtin/for-each-repo.c
+++ b/builtin/for-each-repo.c
@@ -6,7 +6,7 @@
 #include "string-list.h"
 
 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
 };
 

diff --git a/builtin/pack-redundant.c b/builtin/pack-redundant.c
index ed9b9013a5fea10c0e99616ac928661130b4c21e..ecd49ca268f53bb4b986d5fdbf3876c0dc010733 100644 (file)
--- a/builtin/pack-redundant.c
+++ b/builtin/pack-redundant.c
@@ -14,7 +14,7 @@
 #define BLKSIZE 512
 
 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;
 

diff --git a/builtin/rerere.c b/builtin/rerere.c
index 83d7a778e374be053f861145690c161b21d9801c..12570537d37ac5ef16b6e08034b922278bfccdd6 100644 (file)
--- a/builtin/rerere.c
+++ b/builtin/rerere.c
@@ -10,7 +10,7 @@
 #include "pathspec.h"
 
 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,
 };
 

diff --git a/builtin/rev-list.c b/builtin/rev-list.c
index f67e2b33555367126892a2e708a962074492e14d..ada68a4af5e22bf79c860d8727022bad8501614a 100644 (file)
--- a/builtin/rev-list.c
+++ b/builtin/rev-list.c
@@ -20,7 +20,7 @@
 #include "packfile.h"
 
 static const char rev_list_usage[] =
-"git rev-list [<options>] <commit-id>... [-- <path>...]\n"
+"git rev-list [<options>] <commit>... [-- <path>...]\n"
 "\n"
 "  limiting output:\n"
 "    --max-count=<n>\n"

diff --git a/builtin/stash.c b/builtin/stash.c
index 7d82ead67602a949faf9faa53385a504c04ccf26..614bb0dd4a2a5db2e89f58cf0b768d24378643f5 100644 (file)
--- a/builtin/stash.c
+++ b/builtin/stash.c
@@ -22,7 +22,7 @@
 #define INCLUDE_ALL_FILES 2
 
 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 drop [-q | --quiet] [<stash>]"),
        N_("git stash (pop | apply) [--index] [-q | --quiet] [<stash>]"),

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

diff --git a/builtin/upload-archive.c b/builtin/upload-archive.c
index 98d028dae679080af9785d57bc83525d5cd2872f..945ee2b4126719764c338ba5a8692b5410765509 100644 (file)
--- a/builtin/upload-archive.c
+++ b/builtin/upload-archive.c
@@ -10,7 +10,7 @@
 #include "strvec.h"
 
 static const char upload_archive_usage[] =
-       "git upload-archive <repo>";
+       "git upload-archive <repository>";
 
 static const char deadchild[] =
 "git upload-archive: archiver died with error";

diff --git a/builtin/verify-pack.c b/builtin/verify-pack.c
index 05c52135946b77ba6014f69b203d3e979df94ffd..db9ac5c46067db7e9017cbd1079df3cf766b9002 100644 (file)
--- a/builtin/verify-pack.c
+++ b/builtin/verify-pack.c
@@ -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[] = {
-       N_("git verify-pack [-v | --verbose] [-s | --stat-only] <pack>..."),
+       N_("git verify-pack [-v | --verbose] [-s | --stat-only] <pack>.idx..."),
        NULL
 };
 

diff --git a/builtin/worktree.c b/builtin/worktree.c
index c6710b2552006df0a3bc70fcddcde81fa2476783..5bfc18e5a242ea9b859594edceff9dac0e59703e 100644 (file)
--- a/builtin/worktree.c
+++ b/builtin/worktree.c
@@ -23,7 +23,7 @@ static const char * const worktree_usage[] = {
        N_("git worktree prune [<options>]"),
        N_("git worktree remove [<options>] <worktree>"),
        N_("git worktree repair [<path>...]"),
-       N_("git worktree unlock <path>"),
+       N_("git worktree unlock <worktree>"),
        NULL
 };