[v2,17/35] doc txt & -h consistency: fix mismatching labels

Message ID	patch-v2-17.35-97873747a1e-20220928T082458Z-avarab@gmail.com (mailing list archive)
State	Superseded
Headers	show Return-Path: <git-owner@kernel.org> From: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= <avarab@gmail.com> To: git@vger.kernel.org Cc: Junio C Hamano <gitster@pobox.com>, Victoria Dye <vdye@github.com>, Taylor Blau <me@ttaylorr.com>, Emily Shaffer <emilyshaffer@google.com>, Jonathan Nieder <jrnieder@gmail.com>, John Cai <johncai86@gmail.com>, =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= <avarab@gmail.com> Subject: [PATCH v2 17/35] doc txt & -h consistency: fix mismatching labels Date: Wed, 28 Sep 2022 10:39:12 +0200 Message-Id: <patch-v2-17.35-97873747a1e-20220928T082458Z-avarab@gmail.com> In-Reply-To: <cover-v2-00.35-00000000000-20220928T082458Z-avarab@gmail.com> References: <cover-00.34-00000000000-20220902T092734Z-avarab@gmail.com> <cover-v2-00.35-00000000000-20220928T082458Z-avarab@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Precedence: bulk
Series	doc/UX: make txt & -h output more consistent \| expand [v2,00/35] doc/UX: make txt & -h output more consistent [v2,01/35] CodingGuidelines: update and clarify command-line conventions [v2,02/35] builtin/bundle.c: use \t, not fix indentation 2-SP indentation [v2,03/35] bundle: define subcommand -h in terms of command -h [v2,04/35] blame: use a more detailed usage_msg_optf() error on bad -L [v2,05/35] doc SYNOPSIS: don't use ' for subcommands [v2,06/35] doc SYNOPSIS: consistently use ' for commands [v2,07/35] doc SYNOPSIS & -h: fix incorrect alternates syntax [v2,08/35] built-ins: consistently add "\n" between "usage" and options [v2,09/35] doc txt & -h consistency: word-wrap [v2,10/35] doc txt & -h consistency: fix incorrect alternates syntax [v2,11/35] doc txt & -h consistency: add "-z" to cat-file "-h" [v2,12/35] doc txt & -h consistency: add missing "]" to bugreport "-h" [v2,13/35] doc txt & -h consistency: correct padding around "[]()" [v2,14/35] stash doc SYNOPSIS & -h: correct padding around "[]()" [v2,15/35] doc txt & -h consistency: use "<options>", not "<options>..." [v2,16/35] t/helper/test-proc-receive.c: use "<options>", not "<options>..." [v2,17/35] doc txt & -h consistency: fix mismatching labels [v2,18/35] doc txt & -h consistency: add or fix optional "--" syntax [v2,19/35] doc txt & -h consistency: make output order consistent [v2,20/35] doc txt & -h consistency: add missing options and labels [v2,21/35] doc txt & -h consistency: make "rerere" consistent [v2,22/35] doc txt & -h consistency: make "read-tree" consistent [v2,23/35] doc txt & -h consistency: make "bundle" consistent [v2,24/35] doc txt & -h consistency: use "git foo" form, not "git-foo" [v2,25/35] doc txt & -h consistency: add missing options [v2,26/35] doc txt & -h consistency: make "stash" consistent [v2,27/35] doc txt & -h consistency: make "annotate" consistent [v2,28/35] doc txt & -h consistency: use "[<label>...]" for "zero or more" [v2,29/35] doc txt & -h consistency: make "diff-tree" consistent [v2,30/35] doc txt & -h consistency: make "commit" consistent [v2,31/35] reflog doc: list real subcommands up-front [v2,32/35] worktree: define subcommand -h in terms of command -h [v2,33/35] doc txt & -h consistency: make "worktree" consistent [v2,34/35] tests: start asserting that *.txt SYNOPSIS matches -h output [v2,35/35] tests: assert consistent whitespace in -h output

diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index 91742633fa8..3f16f200d9a 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 <pattern>] [-x | -X] [--] <path>... +'git clean' [-d] [-f] [-i] [-n] [-q] [-e <pattern>] [-x | -X] [--] <pathspec>... DESCRIPTION ----------- @@ -20,13 +20,13 @@ 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 +If any optional `<pathspec>...` arguments are given, only those paths 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 diff --git a/Documentation/git-credential-cache--daemon.txt b/Documentation/git-credential-cache--daemon.txt index 01e1c214dd8..74832d06806 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] <socket> +'git credential-cache{litdd}daemon' [--debug] <socket-path> DESCRIPTION ----------- diff --git a/Documentation/git-mv.txt b/Documentation/git-mv.txt index 972a055fbd8..c612a5fd5b9 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' [<options>] <args>... +'git mv' [<options>] <source>... <destination> DESCRIPTION ----------- diff --git a/Documentation/git-receive-pack.txt b/Documentation/git-receive-pack.txt index 014a78409b9..eec1268b10f 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' <directory> +'git-receive-pack' <git-dir> DESCRIPTION ----------- diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt index 31a97a1b6c5..c15ec895720 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 <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>] diff --git a/Documentation/git-upload-archive.txt b/Documentation/git-upload-archive.txt index fba0f1c1b27..e8eb10baad7 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' <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 61d93383f51..96052541cbf 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) <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 5466636e666..6f039f555b2 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 <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 cd346f95f08..b656a535c05 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 <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/credential-cache--daemon.c b/builtin/credential-cache--daemon.c index 4c6c89ab0de..ca672a6a619 100644 --- a/builtin/credential-cache--daemon.c +++ b/builtin/credential-cache--daemon.c @@ -267,7 +267,7 @@ int cmd_credential_cache_daemon(int argc, const char **argv, const char *prefix) const char *socket_path; int ignore_sighup = 0; static const char *usage[] = { - "git-credential-cache--daemon [opts] <socket_path>", + "git-credential-cache--daemon [opts] <socket-path>", NULL }; int debug = 0; diff --git a/builtin/for-each-repo.c b/builtin/for-each-repo.c index fd86e5a8619..c6379b783c8 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=<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 ed9b9013a5f..ecd49ca268f 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 | <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 83d7a778e37..12570537d37 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 <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 f67e2b33555..ada68a4af5e 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 [<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 d91cf5fd3e1..83c9591ea6d 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 [<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 58652229f27..9e8119dd354 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 <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 98d028dae67..945ee2b4126 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 <repo>"; + "git upload-archive <repository>"; static const char deadchild[] = "git upload-archive: archiver died with error"; diff --git a/builtin/worktree.c b/builtin/worktree.c index c6710b25520..5bfc18e5a24 100644 --- 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 };

[v2,17/35] doc txt & -h consistency: fix mismatching labels

Commit Message

Patch