Document the --(no-)edit switch of git-revert and git-cherry-pick
This switch was not documented properly. I decided not to mention
the --no-edit switch in the git-cherry-pick documentation since
we always default to no editing.
Signed-off-by: Petr Baudis <pasky@suse.cz>
Signed-off-by: Junio C Hamano <junkio@cox.net>
diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt
index 26e0467..5e0ef5a 100644
--- a/Documentation/git-cherry-pick.txt
+++ b/Documentation/git-cherry-pick.txt
@@ -7,7 +7,7 @@
SYNOPSIS
--------
-'git-cherry-pick' [-n] [-r] <commit>
+'git-cherry-pick' [--edit] [-n] [-r] <commit>
DESCRIPTION
-----------
@@ -20,6 +20,10 @@
<commit>::
Commit to cherry-pick.
+--edit::
+ With this option, `git-cherry-pick` will let you edit the commit
+ message prior committing.
+
-r::
Usually the command appends which commit was
cherry-picked after the original commit message when
diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt
index feebd81..f471037 100644
--- a/Documentation/git-revert.txt
+++ b/Documentation/git-revert.txt
@@ -7,7 +7,7 @@
SYNOPSIS
--------
-'git-revert' [-n] <commit>
+'git-revert' [--edit | --no-edit] [-n] <commit>
DESCRIPTION
-----------
@@ -20,6 +20,15 @@
<commit>::
Commit to revert.
+--edit::
+ With this option, `git-revert` will let you edit the commit
+ message prior committing the revert. This is the default if
+ you run the command from a terminal.
+
+--no-edit::
+ With this option, `git-revert` will not start the commit
+ message editor.
+
-n::
Usually the command automatically creates a commit with
a commit log message stating which commit was reverted.
diff --git a/git-revert.sh b/git-revert.sh
index c1aebb1..5cb02b1 100755
--- a/git-revert.sh
+++ b/git-revert.sh
@@ -19,10 +19,10 @@
usage () {
case "$me" in
cherry-pick)
- die "usage git $me [-n] [-r] <commit-ish>"
+ die "usage git $me [--edit] [-n] [-r] <commit-ish>"
;;
revert)
- die "usage git $me [-n] <commit-ish>"
+ die "usage git $me [--edit | --no-edit] [-n] <commit-ish>"
;;
esac
}
