diff options
| author | Petr Baudis <pasky@suse.cz> | 2005-11-26 23:12:44 +0100 |
|---|---|---|
| committer | Junio C Hamano <junkio@cox.net> | 2005-12-04 16:34:35 -0800 |
| commit | 8bf14d6ef9245f3b81d24cb7725a868f62343277 (patch) | |
| tree | 33000c6d02b51071235ff646aee16aa9a16f1474 | |
| parent | 287f860054345505e4f737466279efa6c3ff04b5 (diff) | |
| download | git-8bf14d6ef9245f3b81d24cb7725a868f62343277.tar.gz git-8bf14d6ef9245f3b81d24cb7725a868f62343277.tar.xz | |
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>
| -rw-r--r-- | Documentation/git-cherry-pick.txt | 6 | ||||
| -rw-r--r-- | Documentation/git-revert.txt | 11 | ||||
| -rwxr-xr-x | git-revert.sh | 4 |
3 files changed, 17 insertions, 4 deletions
diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt index 26e046779..5e0ef5ae0 100644 --- 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 -------- -'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 diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt index feebd81da..f471037b9 100644 --- a/Documentation/git-revert.txt +++ b/Documentation/git-revert.txt @@ -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. diff --git a/git-revert.sh b/git-revert.sh index c1aebb159..5cb02b1ec 100755 --- a/git-revert.sh +++ b/git-revert.sh @@ -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 } |