From f6a8ef07009bf44e2fed292439161c241e09b40d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=86var=20Arnfj=C3=B6r=C3=B0=20Bjarmason?= Date: Thu, 13 Oct 2022 17:39:10 +0200 Subject: [PATCH] doc txt & -h consistency: fix mismatching labels MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Signed-off-by: Junio C Hamano --- Documentation/git-clean.txt | 10 +++++----- Documentation/git-credential-cache--daemon.txt | 4 ++-- Documentation/git-mv.txt | 4 ++-- Documentation/git-receive-pack.txt | 4 ++-- Documentation/git-tag.txt | 18 +++++++++--------- Documentation/git-upload-archive.txt | 4 ++-- builtin/bugreport.c | 2 +- builtin/clean.c | 2 +- builtin/commit-graph.c | 4 ++-- builtin/for-each-repo.c | 2 +- builtin/pack-redundant.c | 2 +- builtin/rerere.c | 2 +- builtin/rev-list.c | 2 +- builtin/stash.c | 2 +- builtin/unpack-file.c | 2 +- builtin/upload-archive.c | 2 +- builtin/verify-pack.c | 2 +- builtin/worktree.c | 2 +- 18 files changed, 35 insertions(+), 35 deletions(-) diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index a7f309dff5..d5587cdd84 100644 --- 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 ] [-x | -X] [--] ... +'git clean' [-d] [-f] [-i] [-n] [-q] [-e ] [-x | -X] [--] ... 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 `...` arguments are given, only those paths -are affected. +If any optional `...` arguments are given, only those paths +that match the pathspec are affected. OPTIONS ------- -d:: - Normally, when no is specified, git clean will not + Normally, when no 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 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 01e1c214dd..650a15a7ed 100644 --- 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] +'git credential-cache{litdd}daemon' [--debug] 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 `` +This command listens on the Unix domain socket specified by `` 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 972a055fbd..fb0220fd18 100644 --- 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' [] ... +'git mv' [] ... 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 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 014a78409b..5c297db1a4 100644 --- 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' +'git-receive-pack' DESCRIPTION ----------- @@ -38,7 +38,7 @@ its behavior, see linkgit:git-config[1]. OPTIONS ------- -:: +:: The repository to sync into. --http-backend-info-refs:: diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt index 31a97a1b6c..fdc72b5875 100644 --- 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 ] [-f] [-m | -F ] [-e] +'git tag' [-a | -s | -u ] [-f] [-m | -F ] [-e] [ | ] 'git tag' -d ... 'git tag' [-n[]] -l [--contains ] [--no-contains ] @@ -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 ` is passed, the command +If one of `-a`, `-s`, or `-u ` is passed, the command creates a 'tag' object, and requires a tag message. Unless `-m ` or `-F ` is given, an editor is started for the user to type in the tag message. -If `-m ` or `-F ` is given and `-a`, `-s`, and `-u ` +If `-m ` or `-F ` is given and `-a`, `-s`, and `-u ` 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 -` is used. When `-u ` is not used, the +` is used. When `-u ` 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 :: ---local-user=:: +-u :: +--local-user=:: 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 ` + Implies `-a` if none of `-a`, `-s`, or `-u ` is given. -F :: --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 ` + Implies `-a` if none of `-a`, `-s`, or `-u ` is given. -e:: @@ -220,7 +220,7 @@ it in the repository configuration as follows: ------------------------------------- [user] - signingKey = + signingKey = ------------------------------------- `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 fba0f1c1b2..e8eb10baad 100644 --- 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' +'git upload-archive' DESCRIPTION ----------- @@ -54,7 +54,7 @@ access via non-smart-http. OPTIONS ------- -:: +:: The repository to get a tar archive from. GIT diff --git a/builtin/bugreport.c b/builtin/bugreport.c index 61d93383f5..96052541cb 100644 --- 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) ] [(-s | --suffix) ]\n" + N_("git bugreport [(-o | --output-directory) ] [(-s | --suffix) ]\n" " [--diagnose[=]]"), NULL }; diff --git a/builtin/clean.c b/builtin/clean.c index 5466636e66..6f039f555b 100644 --- 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 ] [-x | -X] [--] ..."), + N_("git clean [-d] [-f] [-i] [-n] [-q] [-e ] [-x | -X] [--] ..."), NULL }; diff --git a/builtin/commit-graph.c b/builtin/commit-graph.c index c21cfd5669..0a68935d9e 100644 --- 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 ] [--shallow] [--[no-]progress]") + N_("git commit-graph verify [--object-dir ] [--shallow] [--[no-]progress]") #define BUILTIN_COMMIT_GRAPH_WRITE_USAGE \ - N_("git commit-graph write [--object-dir ] [--append]\n" \ + N_("git commit-graph write [--object-dir ] [--append]\n" \ " [--split[=]] [--reachable | --stdin-packs | --stdin-commits]\n" \ " [--changed-paths] [--[no-]max-new-filters ] [--[no-]progress]\n" \ " ") diff --git a/builtin/for-each-repo.c b/builtin/for-each-repo.c index fd86e5a861..c6379b783c 100644 --- 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= "), + N_("git for-each-repo --config= "), NULL }; diff --git a/builtin/pack-redundant.c b/builtin/pack-redundant.c index ed9b9013a5..ecd49ca268 100644 --- 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 | ...)"; +"git pack-redundant [--verbose] [--alt-odb] (--all | ...)"; static int load_all_packs, verbose, alt_odb; diff --git a/builtin/rerere.c b/builtin/rerere.c index 83d7a778e3..12570537d3 100644 --- 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 ... | status | remaining | diff | gc]"), + N_("git rerere [clear | forget ... | status | remaining | diff | gc]"), NULL, }; diff --git a/builtin/rev-list.c b/builtin/rev-list.c index f67e2b3355..ada68a4af5 100644 --- 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 [] ... [-- ...]\n" +"git rev-list [] ... [-- ...]\n" "\n" " limiting output:\n" " --max-count=\n" diff --git a/builtin/stash.c b/builtin/stash.c index 7d82ead676..614bb0dd4a 100644 --- 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 []"), + N_("git stash list []"), N_("git stash show [] []"), N_("git stash drop [-q | --quiet] []"), N_("git stash (pop | apply) [--index] [-q | --quiet] []"), diff --git a/builtin/unpack-file.c b/builtin/unpack-file.c index 58652229f2..9e8119dd35 100644 --- 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 "); + usage("git unpack-file "); 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 98d028dae6..945ee2b412 100644 --- 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 "; + "git upload-archive "; static const char deadchild[] = "git upload-archive: archiver died with error"; diff --git a/builtin/verify-pack.c b/builtin/verify-pack.c index 05c5213594..db9ac5c460 100644 --- 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] ..."), + N_("git verify-pack [-v | --verbose] [-s | --stat-only] .idx..."), NULL }; diff --git a/builtin/worktree.c b/builtin/worktree.c index c6710b2552..5bfc18e5a2 100644 --- a/builtin/worktree.c +++ b/builtin/worktree.c @@ -23,7 +23,7 @@ static const char * const worktree_usage[] = { N_("git worktree prune []"), N_("git worktree remove [] "), N_("git worktree repair [...]"), - N_("git worktree unlock "), + N_("git worktree unlock "), NULL };