From: Andreas Ericsson Date: Sun, 20 Nov 2005 21:42:11 +0000 (+0100) Subject: git-reset.txt: Small fix + clarifications. X-Git-Tag: v0.99.9k^2~43 X-Git-Url: https://git.octo.it/?a=commitdiff_plain;h=936a23420c8e1630e013578ba9285cd69cf918f7;p=git.git git-reset.txt: Small fix + clarifications. This basically translates the man-page from 'git-developerish' to plain english, adding some almost-sample output from git-status so users can recognize what will happen. Also mention explicitly that --mixed updates the index, while --soft doesn't. I understood the old text to mean "--mixed is exactly like --soft, but verbose". Signed-off-by: Andreas Ericsson Signed-off-by: Junio C Hamano --- diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt index 31ec2076..6af3a4fd 100644 --- a/Documentation/git-reset.txt +++ b/Documentation/git-reset.txt @@ -14,19 +14,30 @@ DESCRIPTION Sets the current head to the specified commit and optionally resets the index and working tree to match. +This command is useful if you notice some small error in a recent +commit (or set of commits) and want to redo that part without showing +the undo in the history. + +If you want to undo a commit other than the latest on a branch, +gitlink:git-revert[1] is your friend. + OPTIONS ------- --mixed:: - Like --soft but reports what has not been updated. This is the - default action. + Resets the index but not the working tree (ie, the changed files + are preserved but not marked for commit) and reports what has not + been updated. This is the default action. --soft:: Does not touch the index file nor the working tree at all, but - requires them in a good order. + requires them to be in a good order. This leaves all your changed + files "Updated but not checked in", as gitlink:git-status[1] would + put it. --hard:: Matches the working tree and index to that of the tree being - switched to. + switched to. Any changes to tracked files in the working tree + since are lost. :: Commit to make the current HEAD.