War on whitespace

[thirdparty/git.git] / Documentation / git-cherry-pick.txt

diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt
index bfa950ca19c701bd3837a874bbeeb18b440ed44f..47b1e8c2fcd567b7e9d673f2d3ff30c9c32a1b83 100644 (file)
--- 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' [--edit] [-n] [-r] <commit>
+'git-cherry-pick' [--edit] [-n] [-x] <commit>
 
 DESCRIPTION
 -----------
@@ -19,18 +19,29 @@ OPTIONS
 -------
 <commit>::
        Commit to cherry-pick.
+       For a more complete list of ways to spell commits, see
+       "SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1].
 
 -e|--edit::
        With this option, `git-cherry-pick` will let you edit the commit
        message prior committing.
 
--r|--replay::
-       Usually the command appends which commit was
+-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.
+       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::
+       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|--no-commit::
        Usually the command automatically creates a commit with
@@ -57,4 +68,3 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 GIT
 ---
 Part of the gitlink:git[7] suite
-