From: Jonathan Nieder Date: Fri, 21 Jan 2011 18:37:34 +0000 (-0600) Subject: Documentation: do not treat reset --keep as a special case X-Git-Tag: v1.7.4-rc3~3 X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=8c0db6fd51cec5fd82cf4054818c0a1ca4a58f37;p=git.git 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 followed by git update-ref HEAD ). 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 Signed-off-by: Junio C Hamano --- diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt index fd7297637..927ecee2f 100644 --- a/Documentation/git-reset.txt +++ b/Documentation/git-reset.txt @@ -76,15 +76,10 @@ In other words, --merge does something like a 'git read-tree -u -m ', but carries forward unmerged index entries. --keep:: - Resets the index, updates files in the working tree that are - different between and HEAD, but keeps those - which are different between HEAD and the working tree (i.e. - which have local changes). + Resets index entries and updates files in the working tree that are + different between and HEAD. If a file that is different between and HEAD has local changes, reset is aborted. -+ -In other words, --keep does a 2-way merge between and HEAD followed by -'git reset --mixed '. -- If you want to undo a commit other than the latest on a branch,