From: Thomas Rast Date: Fri, 16 Jul 2010 09:44:39 GMT Subject: [RFC PATCH 2/5] Documentation/reset: separate options by mode Message-ID: <0bfc95a7c144ccc811b58321a33caf89d20495e1.1279273256.git.trast@student.ethz.ch> In-Reply-To: Remove all but -q from the OPTIONS section, and instead explain the options separated by usage mode, since they only apply to one each. Signed-off-by: Thomas Rast fixup! Documentation/reset: separate options by mode --- Documentation/git-reset.txt | 58 +++++++++++++++++++++++------------------- 1 files changed, 32 insertions(+), 26 deletions(-) diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt index dbb810d..46b2d2a 100644 --- a/Documentation/git-reset.txt +++ b/Documentation/git-reset.txt @@ -8,29 +8,38 @@ git-reset - Reset current HEAD to the specified state SYNOPSIS -------- [verse] -'git reset' [--soft | --mixed | --hard | --merge | --keep] [-q] [] 'git reset' [-q] [] [--] ... 'git reset' --patch [] [--] [...] +'git reset' [--soft | --mixed | --hard | --merge | --keep] [-q] [] 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, -linkgit:git-revert[1] is your friend. - -The second and third forms with 'paths' and/or --patch are used to -revert selected paths in the index from a given commit, without moving -HEAD. +Sets the current branch to the specified and optionally +resets the index and working tree to match. The defaults to +HEAD in all forms. + +'git reset' [-q] [] [--] ...:: + This form resets the index entries for all to their + state at the . (It does not affect the worktree, nor + the current branch.) ++ +This means that `git reset ` is the opposite of `git add +`, provided that the were already tracked. +'git reset' --patch|-p [] [--] [...]:: + Interactively select hunks in the difference between the index + and (defaults to HEAD). The chosen hunks are applied + in reverse to the index. ++ +This means that `git reset -p` is the opposite of `git add -p` (see +linkgit:git-add[1]). -OPTIONS -------- +'git reset' [--] []:: + This form points the current branch to and then + updates index and working tree according to , which must + be one of the following: ++ +-- --soft:: Does not touch the index file nor the working tree at all, but requires them to be in a good order. This leaves all your changed @@ -59,22 +68,19 @@ OPTIONS the given commit. If a file that is different between the current commit and the given commit has local changes, reset is aborted. +-- --p:: ---patch:: - Interactively select hunks in the difference between the index - and (defaults to HEAD). The chosen hunks are applied - in reverse to the index. -+ -This means that `git reset -p` is the opposite of `git add -p` (see -linkgit:git-add[1]). +If you want to undo a commit other than the latest on a branch, +linkgit:git-revert[1] is your friend. + + +OPTIONS +------- -q:: --quiet:: Be quiet, only report errors. -:: - Commit to make the current HEAD. If not given defaults to HEAD. DISCUSSION ---------- -- 1.7.2.rc3.259.g43154