Document "git cherry-pick" and "git revert"
authorJunio C Hamano <junkio@cox.net>
Sun, 28 Aug 2005 10:01:09 +0000 (03:01 -0700)
committerJunio C Hamano <junkio@cox.net>
Mon, 29 Aug 2005 19:52:03 +0000 (12:52 -0700)
Signed-off-by: Junio C Hamano <junkio@cox.net>
Documentation/git-cherry-pick-script.txt [new file with mode: 0644]
Documentation/git-revert-script.txt
Documentation/git.txt

diff --git a/Documentation/git-cherry-pick-script.txt b/Documentation/git-cherry-pick-script.txt
new file mode 100644 (file)
index 0000000..ab9fb22
--- /dev/null
@@ -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
+
index 727073e27958cfeaff10c0a4db2fb77b5f2ae73c..9609dcd325062d88871bf91b9642bef61f8f9224 100644 (file)
@@ -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>
index 807a470076fc0b53a92a6ceaad9bc6d7f0b47ab6..221889bc75f47e35cf20b58df33b4f01c0c6698c 100644 (file)
@@ -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.