summaryrefslogtreecommitdiff
path: root/Documentation/git-revert.txt
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2015-10-05 12:30:26 -0700
committerLibravatar Junio C Hamano <gitster@pobox.com>2015-10-05 12:30:26 -0700
commite13d854322ad802213aea13409505c765b5c68d1 (patch)
tree5517efbeafd23b49f4ff7dbcb769ac90749bb180 /Documentation/git-revert.txt
parentMerge branch 'bb/remote-get-url' (diff)
parentDocumentation: explain optional arguments better (diff)
downloadtgif-e13d854322ad802213aea13409505c765b5c68d1.tar.xz
Merge branch 'mm/keyid-docs'
Very small number of options take a parameter that is optional (which is not a great UI element as they can only appear at the end of the command line). Add notice to documentation of each and every one of them. * mm/keyid-docs: Documentation: explain optional arguments better Documentation/grep: fix documentation of -O Documentation: use 'keyid' consistently, not 'key-id'
Diffstat (limited to 'Documentation/git-revert.txt')
-rw-r--r--Documentation/git-revert.txt10
1 files changed, 6 insertions, 4 deletions
diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt
index cceb5f2f7f..b15139ffdc 100644
--- a/Documentation/git-revert.txt
+++ b/Documentation/git-revert.txt
@@ -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,9 +80,11 @@ 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>]::
- GPG-sign commits.
+-S[<keyid>]::
+--gpg-sign[=<keyid>]::
+ GPG-sign commits. The `keyid` argument is optional and
+ defaults to the committer identity; if specified, it must be
+ stuck to the option without a space.
-s::
--signoff::