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>
This commit is contained in:
Petr Baudis 2005-11-26 23:12:44 +01:00 committed by Junio C Hamano
parent 287f860054
commit 8bf14d6ef9
3 changed files with 17 additions and 4 deletions

View file

@ -7,7 +7,7 @@ git-cherry-pick - Apply the change introduced by an existing commit.
SYNOPSIS
--------
'git-cherry-pick' [-n] [-r] <commit>
'git-cherry-pick' [--edit] [-n] [-r] <commit>
DESCRIPTION
-----------
@ -20,6 +20,10 @@ OPTIONS
<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

View file

@ -7,7 +7,7 @@ git-revert - Revert an existing commit.
SYNOPSIS
--------
'git-revert' [-n] <commit>
'git-revert' [--edit | --no-edit] [-n] <commit>
DESCRIPTION
-----------
@ -20,6 +20,15 @@ OPTIONS
<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.

View file

@ -19,10 +19,10 @@ esac
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
}