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 26e04677972f410cbec93c72ba2210c28d1f39bc..5e0ef5ae0be005ad2da128f9304fe2d178d732d6 100644 (file)
--- a/Documentation/git-cherry-pick.txt
+++ b/Documentation/git-cherry-pick.txt
@@ -7,7 +7,7 @@ git-cherry-pick - Apply the change introduced by an existing commit.
 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------

-'git-cherry-pick' [-n] [-r] <commit>
+'git-cherry-pick' [--edit] [-n] [-r] <commit>

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


@@ -20,6 +20,10 @@ OPTIONS
 <commit>::
        Commit to cherry-pick.
 
 <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
 -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 feebd81da5889da2e77dc8508f8b7e3d642e6214..f471037b97ad72fc098859e60ccfeb75b559d3a3 100644 (file)
--- a/Documentation/git-revert.txt
+++ b/Documentation/git-revert.txt
@@ -7,7 +7,7 @@ git-revert - Revert an existing commit.
 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------

-'git-revert' [-n] <commit>
+'git-revert' [--edit | --no-edit] [-n] <commit>

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


@@ -20,6 +20,15 @@ OPTIONS
 <commit>::
        Commit to revert.
 
 <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.
 -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 c1aebb159cab86f419ff2aaab2a8f1d9d79a9a72..5cb02b1ec2f8a128439039dbde442d03a8763baf 100755 (executable)
--- a/git-revert.sh
+++ b/git-revert.sh
@@ -19,10 +19,10 @@ esac
 usage () {
        case "$me" in
        cherry-pick)
 usage () {
        case "$me" in
        cherry-pick)

-               die "usage git $me [-n] [-r] <commit-ish>"
+               die "usage git $me [--edit] [-n] [-r] <commit-ish>"

                ;;
        revert)
                ;;
        revert)

-               die "usage git $me [-n] <commit-ish>"
+               die "usage git $me [--edit | --no-edit] [-n] <commit-ish>"

                ;;
        esac
 }
                ;;
        esac
 }