development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-08-27 11:39:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation: use 'keyid' consistently, not 'key-id'

Browse source 
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>
This commit is contained in:
Matthieu Moy 2015-09-19 09:47:48 +02:00 committed by Junio C Hamano
parent ee6ad5f4d5
commit 340f2c5e63
5 changed files with 17 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
Documentation/git-cherry-pick.txt
View file

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

2
Documentation/git-commit.txt
View file

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

2
Documentation/git-merge.txt
View file

@ -10,7 +10,7 @@ SYNOPSIS
-------- --------
[verse] [verse]
'git merge' [-n] [--stat] [--no-commit] [--squash] [--[no-]edit] '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>...] [--[no-]rerere-autoupdate] [-m <msg>] [<commit>...]
'git merge' <msg> HEAD <commit>... 'git merge' <msg> HEAD <commit>...
'git merge' --abort 'git merge' --abort

6
Documentation/git-revert.txt
View file

@ -8,7 +8,7 @@ git-revert - Revert some existing commits
SYNOPSIS SYNOPSIS
-------- --------
[verse] [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' --continue
'git revert' --quit 'git revert' --quit
'git revert' --abort 'git revert' --abort
@ -80,8 +80,8 @@ more details.
This is useful when reverting more than one commits' This is useful when reverting more than one commits'
effect to your index in a row. effect to your index in a row.
-S[<key-id>]:: -S[<keyid>]::
--gpg-sign[=<key-id>]:: --gpg-sign[=<keyid>]::
GPG-sign commits. GPG-sign commits.
-s:: -s::

18
Documentation/git-tag.txt
View file

@ -9,7 +9,7 @@ git-tag - Create, list, delete or verify a tag object signed with GPG
SYNOPSIS SYNOPSIS
-------- --------
[verse] [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>] <tagname> [<commit> | <object>]
'git tag' -d <tagname>... 'git tag' -d <tagname>...
'git tag' [-n[<num>]] -l [--contains <commit>] [--points-at <object>] 'git tag' [-n[<num>]] -l [--contains <commit>] [--points-at <object>]
@ -24,19 +24,19 @@ to delete, list or verify tags.
Unless `-f` is given, the named tag must not yet exist. 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 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 `-m <msg>` or `-F <file>` is given, an editor is started for the user to type
in the tag message. 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. are absent, `-a` is implied.
Otherwise just a tag reference for the SHA-1 object name of the commit object is Otherwise just a tag reference for the SHA-1 object name of the commit object is
created (i.e. a lightweight tag). created (i.e. a lightweight tag).
A GnuPG signed tag object will be created when `-s` or `-u 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 committer identity for the current user is used to find the
GnuPG key for signing. The configuration variable `gpg.program` GnuPG key for signing. The configuration variable `gpg.program`
is used to specify custom GnuPG binary. is used to specify custom GnuPG binary.
@ -63,8 +63,8 @@ OPTIONS
--sign:: --sign::
Make a GPG-signed tag, using the default e-mail address's key. Make a GPG-signed tag, using the default e-mail address's key.
-u <key-id>:: -u <keyid>::
--local-user=<key-id>:: --local-user=<keyid>::
Make a GPG-signed tag, using the given key. Make a GPG-signed tag, using the given key.
-f:: -f::
@ -125,14 +125,14 @@ This option is only applicable when listing tags without annotation lines.
Use the given tag message (instead of prompting). Use the given tag message (instead of prompting).
If multiple `-m` options are given, their values are If multiple `-m` options are given, their values are
concatenated as separate paragraphs. 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. is given.
-F <file>:: -F <file>::
--file=<file>:: --file=<file>::
Take the tag message from the given file. Use '-' to Take the tag message from the given file. Use '-' to
read the message from the standard input. 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. is given.
--cleanup=<mode>:: --cleanup=<mode>::
@ -163,7 +163,7 @@ it in the repository configuration as follows:
------------------------------------- -------------------------------------
[user] [user]
signingKey = <gpg-key-id> signingKey = <gpg-keyid>
------------------------------------- -------------------------------------