Documentation/git-svn: document some of the newer features
[gitweb.git] / Documentation / git-cherry-pick.txt
index e6a8c878538acd32061546dac365634cdd532a89..875edb6b9f5ddc6d19b2de29cebbad5ebb7d37a0 100644 (file)
@@ -1,14 +1,13 @@
 git-cherry-pick(1)
 ==================
-v0.99.5 Aug 2005
 
 NAME
 ----
-git-cherry-pick - Apply the change introduced by an existing commit.
+git-cherry-pick - Apply the change introduced by an existing commit
 
 SYNOPSIS
 --------
-'git-cherry-pick' [-n] [-r] <commit>
+'git-cherry-pick' [--edit] [-n] [-x] <commit>
 
 DESCRIPTION
 -----------
@@ -21,15 +20,28 @@ OPTIONS
 <commit>::
        Commit to cherry-pick.
 
--r::
-       Usuall the command appends which commit was
+-e|--edit::
+       With this option, `git-cherry-pick` will let you edit the commit
+       message prior committing.
+
+-x::
+       Cause the command to append 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'.
+       making a commit.  Do not use this option if you are
+       cherry-picking from your private branch because the
+       information is useless to the recipient.  If on the
+       other hand you are cherry-picking between two publicly
+       visible branches (e.g. backporting a fix to a
+       maintenance branch for an older release from a
+       development branch), adding this information can be
+       useful.
+
+-r|--replay::
+       It used to be that the command defaulted to do `-x`
+       described above, and `-r` was to disable it.  Now the
+       default is not to do `-x` so this option is a no-op.
 
--n::
+-n|--no-commit::
        Usually the command automatically creates a commit with
        a commit log message stating which commit was
        cherry-picked.  This flag applies the change necessary
@@ -38,9 +50,9 @@ OPTIONS
        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.
++
+This is useful when cherry-picking more than one commits'
+effect to your working tree in a row.
 
 
 Author