Documentation: do not treat reset --keep as a special case

The current treatment of "git reset --keep" emphasizes how it
differs from --hard (treatment of local changes) and how it breaks
down into plumbing (git read-tree -m -u HEAD <commit> followed by git
update-ref HEAD <commit>).  This can discourage people from using
it, since it might seem to be a complex or niche option.

Better to emphasize what the --keep flag is intended for --- moving
the index and worktree from one commit to another, like "git checkout"
would --- so the reader can make a more informed decision about the
appropriate situations in which to use it.

Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Jonathan Nieder 2011-01-21 12:37:34 -06:00 committed by Junio C Hamano
parent 25f3af3f9d
commit 8c0db6fd51
1 changed files with 2 additions and 7 deletions

View File

@ -76,15 +76,10 @@ In other words, --merge does something like a 'git read-tree -u -m <commit>',
but carries forward unmerged index entries. but carries forward unmerged index entries.


--keep:: --keep::
Resets the index, updates files in the working tree that are Resets index entries and updates files in the working tree that are
different between <commit> and HEAD, but keeps those different between <commit> and HEAD.
which are different between HEAD and the working tree (i.e.
which have local changes).
If a file that is different between <commit> and HEAD has local changes, If a file that is different between <commit> and HEAD has local changes,
reset is aborted. reset is aborted.
+
In other words, --keep does a 2-way merge between <commit> and HEAD followed by
'git reset --mixed <commit>'.
-- --


If you want to undo a commit other than the latest on a branch, If you want to undo a commit other than the latest on a branch,