[PATCH v4 3/5] git-reset.txt: better docs for '--patch'
- From
Valentin Haenel <valentin.haenel@gmx.de>
- Date
- May 5, 2011, 19:58 UTC
- Message-ID
- <1304625498-23475-1-git-send-email-valentin.haenel@gmx.de>
- In-Reply-To
- <7v7ha56jh4.fsf@alter.siamese.dyndns.org>
Describe '-p' as a short form of '--patch' in synopsis. Also include a better explanation of this option and additionally refer the reader to the patch mode description of git-add documentation.
Helped-by: Jeff King <peff@peff.net> Mentored-by: Junio C Hamano <gitster@pobox.com> Signed-off-by: Valentin Haenel <valentin.haenel@gmx.de> ---
Reworded the option description, turned the bullet points in the commit-message into proper sentences, and fixed the sign-off-chain. Sending only patch 3/5 of v4 since the others have already been queued.
Documentation/git-reset.txt | 7 ++++--- 1 files changed, 4 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt index 8481f9d..82001f2 100644 --- a/Documentation/git-reset.txt +++ b/Documentation/git-reset.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'git reset' [-q] [<commit>] [--] <paths>... -'git reset' --patch [<commit>] [--] [<paths>...] +'git reset' --patch|-p [<commit>] [--] [<paths>...] 'git reset' [--soft | --mixed | --hard | --merge | --keep] [-q] [<commit>] DESCRIPTION @@ -39,8 +39,9 @@ working tree in one go. and <commit> (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]). +This means that `git reset -p` is the opposite of `git add -p`, i.e. +you can use it to selectively reset hunks. See the ``Interactive Mode'' +section of linkgit:git-add[1] to learn how to operate the `\--patch` mode. 'git reset' [--<mode>] [<commit>]:: This form resets the current branch head to <commit> and
-- 1.7.1