Documentation/git-cherry-pick.txt et al.: Fix misleading -n description

The manual page of git-cherry-pick and git-revert asserts that -n works
primarily on the working tree, while in fact the primary object it operates
on is the index, and the changes only "accidentally" propagate to the
working tree. This e.g. leads innocent #git IRC folks to believe that you
can use -n to prepare changes for git-add -i staging.

Signed-off-by: Petr Baudis <pasky@suse.cz>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Petr Baudis 2008-07-16 14:35:22 +02:00 committed by Junio C Hamano
parent 191a8e32b3
commit 8bd867ee0e
2 changed files with 13 additions and 13 deletions

View File

@ -58,14 +58,14 @@ OPTIONS
Usually the command automatically creates a commit with Usually the command automatically creates a commit with
a commit log message stating which commit was a commit log message stating which commit was
cherry-picked. This flag applies the change necessary cherry-picked. This flag applies the change necessary
to cherry-pick the named commit to your working tree, to cherry-pick the named commit to your working tree
but does not make the commit. In addition, when this and the index, but does not make the commit. In addition,
option is used, your working tree does not have to match when this option is used, your index does not have to match
the HEAD commit. The cherry-pick is done against the the HEAD commit. The cherry-pick is done against the
beginning state of your working tree. beginning state of your index.
+ +
This is useful when cherry-picking more than one commits' This is useful when cherry-picking more than one commits'
effect to your working tree in a row. effect to your index in a row.


-s:: -s::
--signoff:: --signoff::

View File

@ -43,16 +43,16 @@ OPTIONS
-n:: -n::
--no-commit:: --no-commit::
Usually the command automatically creates a commit with Usually the command automatically creates a commit with
a commit log message stating which commit was reverted. a commit log message stating which commit was
This flag applies the change necessary to revert the reverted. This flag applies the change necessary
named commit to your working tree, but does not make the to revert the named commit to your working tree
commit. In addition, when this option is used, your and the index, but does not make the commit. In addition,
working tree does not have to match the HEAD commit. when this option is used, your index does not have to match
The revert is done against the beginning state of your the HEAD commit. The revert is done against the
working tree. beginning state of your index.
+ +
This is useful when reverting more than one commits' This is useful when reverting more than one commits'
effect to your working tree in a row. effect to your index in a row.


-s:: -s::
--signoff:: --signoff::