diff options
| author | Petr Baudis <pasky@suse.cz> | 2008-07-16 14:35:22 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2008-07-16 08:50:07 -0700 |
| commit | 8bd867ee0e9714457e5ea973849b0025f3e99efc (patch) | |
| tree | 0773146a7218533c24250b776c8ac0a5513b6a10 | |
| parent | 191a8e32b38c7ff0dd884df7bd323b7a5bd4336c (diff) | |
| download | git-8bd867ee0e9714457e5ea973849b0025f3e99efc.tar.gz git-8bd867ee0e9714457e5ea973849b0025f3e99efc.tar.xz | |
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>
| -rw-r--r-- | Documentation/git-cherry-pick.txt | 10 | ||||
| -rw-r--r-- | Documentation/git-revert.txt | 16 |
2 files changed, 13 insertions, 13 deletions
diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt index 5ac9cfb0e..4ef5af4ca 100644 --- a/Documentation/git-cherry-pick.txt +++ b/Documentation/git-cherry-pick.txt @@ -58,14 +58,14 @@ OPTIONS 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 + to cherry-pick the named commit to your working tree + and the index, but does not make the commit. In addition, + when this option is used, your index does not have to match 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' -effect to your working tree in a row. +effect to your index in a row. -s:: --signoff:: diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt index 5b49b8138..f7f4bd468 100644 --- a/Documentation/git-revert.txt +++ b/Documentation/git-revert.txt @@ -43,16 +43,16 @@ OPTIONS -n:: --no-commit:: 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. + a commit log message stating which commit was + reverted. This flag applies the change necessary + to revert the named commit to your working tree + and the index, but does not make the commit. In addition, + when this option is used, your index does not have to match + the HEAD commit. The revert is done against the + beginning state of your index. + 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:: --signoff:: |