Browse Source

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>
maint
Matthieu Moy 9 years ago committed by Junio C Hamano
parent
commit
340f2c5e63
  1. 6
      Documentation/git-cherry-pick.txt
  2. 2
      Documentation/git-commit.txt
  3. 2
      Documentation/git-merge.txt
  4. 6
      Documentation/git-revert.txt
  5. 18
      Documentation/git-tag.txt

6
Documentation/git-cherry-pick.txt

@ -9,7 +9,7 @@ SYNOPSIS @@ -9,7 +9,7 @@ SYNOPSIS
--------
[verse]
'git cherry-pick' [--edit] [-n] [-m parent-number] [-s] [-x] [--ff]
[-S[<key-id>]] <commit>...
[-S[<keyid>]] <commit>...
'git cherry-pick' --continue
'git cherry-pick' --quit
'git cherry-pick' --abort
@ -101,8 +101,8 @@ effect to your index in a row. @@ -101,8 +101,8 @@ effect to your index in a row.
--signoff::
Add Signed-off-by line at the end of the commit message.

-S[<key-id>]::
--gpg-sign[=<key-id>]::
-S[<keyid>]::
--gpg-sign[=<keyid>]::
GPG-sign commits.

--ff::

2
Documentation/git-commit.txt

@ -13,7 +13,7 @@ SYNOPSIS @@ -13,7 +13,7 @@ SYNOPSIS
[-F <file> | -m <msg>] [--reset-author] [--allow-empty]
[--allow-empty-message] [--no-verify] [-e] [--author=<author>]
[--date=<date>] [--cleanup=<mode>] [--[no-]status]
[-i | -o] [-S[<key-id>]] [--] [<file>...]
[-i | -o] [-S[<keyid>]] [--] [<file>...]

DESCRIPTION
-----------

2
Documentation/git-merge.txt

@ -10,7 +10,7 @@ SYNOPSIS @@ -10,7 +10,7 @@ SYNOPSIS
--------
[verse]
'git merge' [-n] [--stat] [--no-commit] [--squash] [--[no-]edit]
[-s <strategy>] [-X <strategy-option>] [-S[<key-id>]]
[-s <strategy>] [-X <strategy-option>] [-S[<keyid>]]
[--[no-]rerere-autoupdate] [-m <msg>] [<commit>...]
'git merge' <msg> HEAD <commit>...
'git merge' --abort

6
Documentation/git-revert.txt

@ -8,7 +8,7 @@ git-revert - Revert some existing commits @@ -8,7 +8,7 @@ git-revert - Revert some existing commits
SYNOPSIS
--------
[verse]
'git revert' [--[no-]edit] [-n] [-m parent-number] [-s] [-S[<key-id>]] <commit>...
'git revert' [--[no-]edit] [-n] [-m parent-number] [-s] [-S[<keyid>]] <commit>...
'git revert' --continue
'git revert' --quit
'git revert' --abort
@ -80,8 +80,8 @@ more details. @@ -80,8 +80,8 @@ more details.
This is useful when reverting more than one commits'
effect to your index in a row.

-S[<key-id>]::
--gpg-sign[=<key-id>]::
-S[<keyid>]::
--gpg-sign[=<keyid>]::
GPG-sign commits.

-s::

18
Documentation/git-tag.txt

@ -9,7 +9,7 @@ git-tag - Create, list, delete or verify a tag object signed with GPG @@ -9,7 +9,7 @@ git-tag - Create, list, delete or verify a tag object signed with GPG
SYNOPSIS
--------
[verse]
'git tag' [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>]
'git tag' [-a | -s | -u <keyid>] [-f] [-m <msg> | -F <file>]
<tagname> [<commit> | <object>]
'git tag' -d <tagname>...
'git tag' [-n[<num>]] -l [--contains <commit>] [--points-at <object>]
@ -24,19 +24,19 @@ to delete, list or verify tags. @@ -24,19 +24,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 <key-id>` is passed, the command
If one of `-a`, `-s`, or `-u <keyid>` 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 <key-id>`
If `-m <msg>` or `-F <file>` is given and `-a`, `-s`, and `-u <keyid>`
are absent, `-a` is implied.

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

A GnuPG signed tag object will be created when `-s` or `-u
<key-id>` is used. When `-u <key-id>` is not used, the
<keyid>` is used. When `-u <keyid>` 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.
@ -63,8 +63,8 @@ OPTIONS @@ -63,8 +63,8 @@ OPTIONS
--sign::
Make a GPG-signed tag, using the default e-mail address's key.

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

-f::
@ -125,14 +125,14 @@ This option is only applicable when listing tags without annotation lines. @@ -125,14 +125,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 <key-id>`
Implies `-a` if none of `-a`, `-s`, or `-u <keyid>`
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 <key-id>`
Implies `-a` if none of `-a`, `-s`, or `-u <keyid>`
is given.

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

-------------------------------------
[user]
signingKey = <gpg-key-id>
signingKey = <gpg-keyid>
-------------------------------------



Loading…
Cancel
Save