aboutsummaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJunio C Hamano <junkio@cox.net>2005-08-28 03:01:09 -0700
committerJunio C Hamano <junkio@cox.net>2005-08-29 12:52:03 -0700
commitde2b82c65dac0e9768bc32f38e96b61d0b778843 (patch)
treee0d819a13934058dddb2b8f6477aee1bc6442eff /Documentation
parente47e35acdda5e334befcde6ffaf207cb5a63b6f4 (diff)
downloadgit-de2b82c65dac0e9768bc32f38e96b61d0b778843.tar.gz
git-de2b82c65dac0e9768bc32f38e96b61d0b778843.tar.xz
Document "git cherry-pick" and "git revert"
Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-cherry-pick-script.txt57
-rw-r--r--Documentation/git-revert-script.txt16
-rw-r--r--Documentation/git.txt3
3 files changed, 75 insertions, 1 deletions
diff --git a/Documentation/git-cherry-pick-script.txt b/Documentation/git-cherry-pick-script.txt
new file mode 100644
index 000000000..ab9fb227d
--- /dev/null
+++ b/Documentation/git-cherry-pick-script.txt
@@ -0,0 +1,57 @@
+git-cherry-pick-script(1)
+=========================
+v0.99.5 Aug 2005
+
+NAME
+----
+git-cherry-pick-script - Apply the change introduced by an existing commit.
+
+SYNOPSIS
+--------
+'git-cherry-pick-script' [-n] [-r] <commit>
+
+DESCRIPTION
+-----------
+Given one existing commit, apply the change the patch introduces, and record a
+new commit that records it. This requires your working tree to be clean (no
+modifications from the HEAD commit).
+
+OPTIONS
+-------
+<commit>::
+ Commit to cherry-pick.
+
+-r::
+ Usuall the command appends which commit was
+ cherry-picked after the original commit message when
+ making a commit. This option, '--replay', causes it to
+ use the original commit message intact. This is useful
+ when you are reordering the patches in your private tree
+ before publishing, and is used by 'git rebase'.
+
+-n::
+ Usually the command automatically creates a commit with
+ a commit log message stating which commit was
+ cherry-picked. This flag applies the change necessary
+ to cherry-pick the named commit to your working tree,
+ but does not make the commit. In addition, when this
+ option is used, your working tree does not have to match
+ the HEAD commit. The cherry-pick is done against the
+ beginning state of your working tree.
+
+ This is useful when cherry-picking more than one commits'
+ effect to your working tree in a row.
+
+
+Author
+------
+Written by Junio C Hamano <junkio@cox.net>
+
+Documentation
+--------------
+Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
+
+GIT
+---
+Part of the link:git.html[git] suite
+
diff --git a/Documentation/git-revert-script.txt b/Documentation/git-revert-script.txt
index 727073e27..9609dcd32 100644
--- a/Documentation/git-revert-script.txt
+++ b/Documentation/git-revert-script.txt
@@ -7,7 +7,7 @@ git-revert-script - Revert an existing commit.
SYNOPSIS
--------
-'git-revert-script' <commit>
+'git-revert-script' [-n] <commit>
DESCRIPTION
-----------
@@ -20,6 +20,20 @@ OPTIONS
<commit>::
Commit to revert.
+-n::
+ Usually the command automatically creates a commit with
+ a commit log message stating which commit was reverted.
+ This flag applies the change necessary to revert the
+ named commit to your working tree, but does not make the
+ commit. In addition, when this option is used, your
+ working tree does not have to match the HEAD commit.
+ The revert is done against the beginning state of your
+ working tree.
+
+ This is useful when reverting more than one commits'
+ effect to your working tree in a row.
+
+
Author
------
Written by Junio C Hamano <junkio@cox.net>
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 807a47007..221889bc7 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -198,6 +198,9 @@ Porcelain-ish Commands
link:git-revert-script.html[git-revert-script]::
Revert an existing commit.
+link:git-cherry-pick-script.html[git-cherry-pick-script]::
+ Cherry-pick the effect of an existing commit.
+
link:git-rebase-script.html[git-rebase-script]::
Rebase local commits to new upstream head.