Skip to content

Commit 340f2c5

Browse files
moygitster
authored andcommitted
Documentation: use 'keyid' consistently, not 'key-id'
Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr> Reviewed-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent ee6ad5f commit 340f2c5

File tree

5 files changed

+17
-17
lines changed

5 files changed

+17
-17
lines changed

Documentation/git-cherry-pick.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ SYNOPSIS
99
--------
1010
[verse]
1111
'git cherry-pick' [--edit] [-n] [-m parent-number] [-s] [-x] [--ff]
12-
[-S[<key-id>]] <commit>...
12+
[-S[<keyid>]] <commit>...
1313
'git cherry-pick' --continue
1414
'git cherry-pick' --quit
1515
'git cherry-pick' --abort
@@ -101,8 +101,8 @@ effect to your index in a row.
101101
--signoff::
102102
Add Signed-off-by line at the end of the commit message.
103103

104-
-S[<key-id>]::
105-
--gpg-sign[=<key-id>]::
104+
-S[<keyid>]::
105+
--gpg-sign[=<keyid>]::
106106
GPG-sign commits.
107107

108108
--ff::

Documentation/git-commit.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ SYNOPSIS
1313
[-F <file> | -m <msg>] [--reset-author] [--allow-empty]
1414
[--allow-empty-message] [--no-verify] [-e] [--author=<author>]
1515
[--date=<date>] [--cleanup=<mode>] [--[no-]status]
16-
[-i | -o] [-S[<key-id>]] [--] [<file>...]
16+
[-i | -o] [-S[<keyid>]] [--] [<file>...]
1717

1818
DESCRIPTION
1919
-----------

Documentation/git-merge.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ SYNOPSIS
1010
--------
1111
[verse]
1212
'git merge' [-n] [--stat] [--no-commit] [--squash] [--[no-]edit]
13-
[-s <strategy>] [-X <strategy-option>] [-S[<key-id>]]
13+
[-s <strategy>] [-X <strategy-option>] [-S[<keyid>]]
1414
[--[no-]rerere-autoupdate] [-m <msg>] [<commit>...]
1515
'git merge' <msg> HEAD <commit>...
1616
'git merge' --abort

Documentation/git-revert.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ git-revert - Revert some existing commits
88
SYNOPSIS
99
--------
1010
[verse]
11-
'git revert' [--[no-]edit] [-n] [-m parent-number] [-s] [-S[<key-id>]] <commit>...
11+
'git revert' [--[no-]edit] [-n] [-m parent-number] [-s] [-S[<keyid>]] <commit>...
1212
'git revert' --continue
1313
'git revert' --quit
1414
'git revert' --abort
@@ -80,8 +80,8 @@ more details.
8080
This is useful when reverting more than one commits'
8181
effect to your index in a row.
8282

83-
-S[<key-id>]::
84-
--gpg-sign[=<key-id>]::
83+
-S[<keyid>]::
84+
--gpg-sign[=<keyid>]::
8585
GPG-sign commits.
8686

8787
-s::

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 <key-id>] [-f] [-m <msg> | -F <file>]
12+
'git tag' [-a | -s | -u <keyid>] [-f] [-m <msg> | -F <file>]
1313
<tagname> [<commit> | <object>]
1414
'git tag' -d <tagname>...
1515
'git tag' [-n[<num>]] -l [--contains <commit>] [--points-at <object>]
@@ -24,19 +24,19 @@ to delete, list or verify tags.
2424

2525
Unless `-f` is given, the named tag must not yet exist.
2626

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

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

3535
Otherwise just a tag reference for the SHA-1 object name of the commit object is
3636
created (i.e. a lightweight tag).
3737

3838
A GnuPG signed tag object will be created when `-s` or `-u
39-
<key-id>` is used. When `-u <key-id>` is not used, the
39+
<keyid>` is used. When `-u <keyid>` is not used, the
4040
committer identity for the current user is used to find the
4141
GnuPG key for signing. The configuration variable `gpg.program`
4242
is used to specify custom GnuPG binary.
@@ -63,8 +63,8 @@ OPTIONS
6363
--sign::
6464
Make a GPG-signed tag, using the default e-mail address's key.
6565

66-
-u <key-id>::
67-
--local-user=<key-id>::
66+
-u <keyid>::
67+
--local-user=<keyid>::
6868
Make a GPG-signed tag, using the given key.
6969

7070
-f::
@@ -125,14 +125,14 @@ This option is only applicable when listing tags without annotation lines.
125125
Use the given tag message (instead of prompting).
126126
If multiple `-m` options are given, their values are
127127
concatenated as separate paragraphs.
128-
Implies `-a` if none of `-a`, `-s`, or `-u <key-id>`
128+
Implies `-a` if none of `-a`, `-s`, or `-u <keyid>`
129129
is given.
130130

131131
-F <file>::
132132
--file=<file>::
133133
Take the tag message from the given file. Use '-' to
134134
read the message from the standard input.
135-
Implies `-a` if none of `-a`, `-s`, or `-u <key-id>`
135+
Implies `-a` if none of `-a`, `-s`, or `-u <keyid>`
136136
is given.
137137

138138
--cleanup=<mode>::
@@ -163,7 +163,7 @@ it in the repository configuration as follows:
163163

164164
-------------------------------------
165165
[user]
166-
signingKey = <gpg-key-id>
166+
signingKey = <gpg-keyid>
167167
-------------------------------------
168168

169169

0 commit comments

Comments
 (0)