Skip to content

Commit f6a8ef0

Browse files
avargitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent a0c3244 commit f6a8ef0

18 files changed

+35
-35
lines changed

Documentation/git-clean.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ git-clean - Remove untracked files from the working tree
88
SYNOPSIS
99
--------
1010
[verse]
11-
'git clean' [-d] [-f] [-i] [-n] [-q] [-e <pattern>] [-x | -X] [--] <path>...
11+
'git clean' [-d] [-f] [-i] [-n] [-q] [-e <pattern>] [-x | -X] [--] <pathspec>...
1212

1313
DESCRIPTION
1414
-----------
@@ -20,16 +20,16 @@ Normally, only files unknown to Git are removed, but if the `-x`
2020
option is specified, ignored files are also removed. This can, for
2121
example, be useful to remove all build products.
2222

23-
If any optional `<path>...` arguments are given, only those paths
24-
are affected.
23+
If any optional `<pathspec>...` arguments are given, only those paths
24+
that match the pathspec are affected.
2525

2626
OPTIONS
2727
-------
2828
-d::
29-
Normally, when no <path> is specified, git clean will not
29+
Normally, when no <pathspec> is specified, git clean will not
3030
recurse into untracked directories to avoid removing too much.
3131
Specify -d to have it recurse into such directories as well.
32-
If any paths are specified, -d is irrelevant; all untracked
32+
If a <pathspec> is specified, -d is irrelevant; all untracked
3333
files matching the specified paths (with exceptions for nested
3434
git directories mentioned under `--force`) will be removed.
3535

Documentation/git-credential-cache--daemon.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ git-credential-cache--daemon - Temporarily store user credentials in memory
88
SYNOPSIS
99
--------
1010
[verse]
11-
'git credential-cache{litdd}daemon' [--debug] <socket>
11+
'git credential-cache{litdd}daemon' [--debug] <socket-path>
1212

1313
DESCRIPTION
1414
-----------
1515

1616
NOTE: You probably don't want to invoke this command yourself; it is
1717
started automatically when you use linkgit:git-credential-cache[1].
1818

19-
This command listens on the Unix domain socket specified by `<socket>`
19+
This command listens on the Unix domain socket specified by `<socket-path>`
2020
for `git-credential-cache` clients. Clients may store and retrieve
2121
credentials. Each credential is held for a timeout specified by the
2222
client; once no credentials are held, the daemon exits.

Documentation/git-mv.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ git-mv - Move or rename a file, a directory, or a symlink
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git mv' [<options>] <args>...
12+
'git mv' [<options>] <source>... <destination>
1313

1414
DESCRIPTION
1515
-----------
@@ -30,7 +30,7 @@ OPTIONS
3030
-------
3131
-f::
3232
--force::
33-
Force renaming or moving of a file even if the target exists
33+
Force renaming or moving of a file even if the <destination> exists.
3434
-k::
3535
Skip move or rename actions which would lead to an error
3636
condition. An error happens when a source is neither existing nor

Documentation/git-receive-pack.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ git-receive-pack - Receive what is pushed into the repository
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git-receive-pack' <directory>
12+
'git-receive-pack' <git-dir>
1313

1414
DESCRIPTION
1515
-----------
@@ -38,7 +38,7 @@ its behavior, see linkgit:git-config[1].
3838

3939
OPTIONS
4040
-------
41-
<directory>::
41+
<git-dir>::
4242
The repository to sync into.
4343

4444
--http-backend-info-refs::

Documentation/git-tag.txt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ git-tag - Create, list, delete or verify a tag object signed with GPG
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git tag' [-a | -s | -u <keyid>] [-f] [-m <msg> | -F <file>] [-e]
12+
'git tag' [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>] [-e]
1313
<tagname> [<commit> | <object>]
1414
'git tag' -d <tagname>...
1515
'git tag' [-n[<num>]] -l [--contains <commit>] [--no-contains <commit>]
@@ -26,19 +26,19 @@ to delete, list or verify tags.
2626

2727
Unless `-f` is given, the named tag must not yet exist.
2828

29-
If one of `-a`, `-s`, or `-u <keyid>` is passed, the command
29+
If one of `-a`, `-s`, or `-u <key-id>` is passed, the command
3030
creates a 'tag' object, and requires a tag message. Unless
3131
`-m <msg>` or `-F <file>` is given, an editor is started for the user to type
3232
in the tag message.
3333

34-
If `-m <msg>` or `-F <file>` is given and `-a`, `-s`, and `-u <keyid>`
34+
If `-m <msg>` or `-F <file>` is given and `-a`, `-s`, and `-u <key-id>`
3535
are absent, `-a` is implied.
3636

3737
Otherwise, a tag reference that points directly at the given object
3838
(i.e., a lightweight tag) is created.
3939

4040
A GnuPG signed tag object will be created when `-s` or `-u
41-
<keyid>` is used. When `-u <keyid>` is not used, the
41+
<key-id>` is used. When `-u <key-id>` is not used, the
4242
committer identity for the current user is used to find the
4343
GnuPG key for signing. The configuration variable `gpg.program`
4444
is used to specify custom GnuPG binary.
@@ -72,8 +72,8 @@ OPTIONS
7272
Override `tag.gpgSign` configuration variable that is
7373
set to force each and every tag to be signed.
7474

75-
-u <keyid>::
76-
--local-user=<keyid>::
75+
-u <key-id>::
76+
--local-user=<key-id>::
7777
Make a GPG-signed tag, using the given key.
7878

7979
-f::
@@ -164,14 +164,14 @@ This option is only applicable when listing tags without annotation lines.
164164
Use the given tag message (instead of prompting).
165165
If multiple `-m` options are given, their values are
166166
concatenated as separate paragraphs.
167-
Implies `-a` if none of `-a`, `-s`, or `-u <keyid>`
167+
Implies `-a` if none of `-a`, `-s`, or `-u <key-id>`
168168
is given.
169169

170170
-F <file>::
171171
--file=<file>::
172172
Take the tag message from the given file. Use '-' to
173173
read the message from the standard input.
174-
Implies `-a` if none of `-a`, `-s`, or `-u <keyid>`
174+
Implies `-a` if none of `-a`, `-s`, or `-u <key-id>`
175175
is given.
176176

177177
-e::
@@ -220,7 +220,7 @@ it in the repository configuration as follows:
220220

221221
-------------------------------------
222222
[user]
223-
signingKey = <gpg-keyid>
223+
signingKey = <gpg-key_id>
224224
-------------------------------------
225225

226226
`pager.tag` is only respected when listing tags, i.e., when `-l` is

Documentation/git-upload-archive.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ git-upload-archive - Send archive back to git-archive
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git upload-archive' <directory>
12+
'git upload-archive' <repository>
1313

1414
DESCRIPTION
1515
-----------
@@ -54,7 +54,7 @@ access via non-smart-http.
5454

5555
OPTIONS
5656
-------
57-
<directory>::
57+
<repository>::
5858
The repository to get a tar archive from.
5959

6060
GIT

builtin/bugreport.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ static void get_populated_hooks(struct strbuf *hook_info, int nongit)
6060
}
6161

6262
static const char * const bugreport_usage[] = {
63-
N_("git bugreport [(-o | --output-directory) <file>] [(-s | --suffix) <format>]\n"
63+
N_("git bugreport [(-o | --output-directory) <path>] [(-s | --suffix) <format>]\n"
6464
" [--diagnose[=<mode>]]"),
6565
NULL
6666
};

builtin/clean.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ static struct string_list del_list = STRING_LIST_INIT_DUP;
2626
static unsigned int colopts;
2727

2828
static const char *const builtin_clean_usage[] = {
29-
N_("git clean [-d] [-f] [-i] [-n] [-q] [-e <pattern>] [-x | -X] [--] <paths>..."),
29+
N_("git clean [-d] [-f] [-i] [-n] [-q] [-e <pattern>] [-x | -X] [--] <pathspec>..."),
3030
NULL
3131
};
3232

builtin/commit-graph.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@
1010
#include "tag.h"
1111

1212
#define BUILTIN_COMMIT_GRAPH_VERIFY_USAGE \
13-
N_("git commit-graph verify [--object-dir <objdir>] [--shallow] [--[no-]progress]")
13+
N_("git commit-graph verify [--object-dir <dir>] [--shallow] [--[no-]progress]")
1414

1515
#define BUILTIN_COMMIT_GRAPH_WRITE_USAGE \
16-
N_("git commit-graph write [--object-dir <objdir>] [--append]\n" \
16+
N_("git commit-graph write [--object-dir <dir>] [--append]\n" \
1717
" [--split[=<strategy>]] [--reachable | --stdin-packs | --stdin-commits]\n" \
1818
" [--changed-paths] [--[no-]max-new-filters <n>] [--[no-]progress]\n" \
1919
" <split options>")

builtin/for-each-repo.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
#include "string-list.h"
77

88
static const char * const for_each_repo_usage[] = {
9-
N_("git for-each-repo --config=<config> <command-args>"),
9+
N_("git for-each-repo --config=<config> <arguments>"),
1010
NULL
1111
};
1212

0 commit comments

Comments
 (0)