@matheusbsbs / matheus-bagliano / commits / 8bf14d6ef9
Fork 0

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>

Petr Baudis committed Nov 26, 2005 at 23:12 UTC 8bf14d6ef9245f3b81d24cb7725a868f62343277
3 files changed +17 -4
Documentation/git-cherry-pick.txt
+5 -1
@@ -7,7 +7,7 @@ git-cherry-pick - Apply the change introduced by an existing commit.
7
8 SYNOPSIS
9 --------
10 -'git-cherry-pick' [-n] [-r] <commit>
10 +'git-cherry-pick' [--edit] [-n] [-r] <commit>
11
12 DESCRIPTION
13 -----------
@@ -20,6 +20,10 @@ OPTIONS
20 <commit>::
21 Commit to cherry-pick.
22
23 +--edit::
24 + With this option, `git-cherry-pick` will let you edit the commit
25 + message prior committing.
26 +
27 -r::
28 Usually the command appends which commit was
29 cherry-picked after the original commit message when
Documentation/git-revert.txt
+10 -1
@@ -7,7 +7,7 @@ git-revert - Revert an existing commit.
7
8 SYNOPSIS
9 --------
10 -'git-revert' [-n] <commit>
10 +'git-revert' [--edit | --no-edit] [-n] <commit>
11
12 DESCRIPTION
13 -----------
@@ -20,6 +20,15 @@ OPTIONS
20 <commit>::
21 Commit to revert.
22
23 +--edit::
24 + With this option, `git-revert` will let you edit the commit
25 + message prior committing the revert. This is the default if
26 + you run the command from a terminal.
27 +
28 +--no-edit::
29 + With this option, `git-revert` will not start the commit
30 + message editor.
31 +
32 -n::
33 Usually the command automatically creates a commit with
34 a commit log message stating which commit was reverted.
git-revert.sh
+2 -2
@@ -19,10 +19,10 @@ esac
19 usage () {
20 case "$me" in
21 cherry-pick)
22 - die "usage git $me [-n] [-r] <commit-ish>"
22 + die "usage git $me [--edit] [-n] [-r] <commit-ish>"
23 ;;
24 revert)
25 - die "usage git $me [-n] <commit-ish>"
25 + die "usage git $me [--edit | --no-edit] [-n] <commit-ish>"
26 ;;
27 esac
28 }