git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Valentin Haenel <valentin.haenel@gmx.de>
To: Git-List <git@vger.kernel.org>
Cc: Thomas Rast <trast@student.ethz.ch>, Jeff King <peff@peff.net>,
	Junio C Hamano <gitster@pobox.com>,
	Valentin Haenel <valentin.haenel@gmx.de>
Subject: [PATCH v3 3/5] git-reset.txt: better docs for '--patch'
Date: Thu,  5 May 2011 20:48:46 +0200	[thread overview]
Message-ID: <1304621328-17184-3-git-send-email-valentin.haenel@gmx.de> (raw)
In-Reply-To: <1304621271-17107-1-git-send-email-valentin.haenel@gmx.de>

* Include '-p' in the synopsis.
* Include a better wording for what 'git reset -p' does.
  (interactively unstage hunks)
* Include a link to the git-add manpage for a description of the patch-mode.

Signed-off-by: Valentin Haenel <valentin.haenel@gmx.de>
Helped-by: Jeff King <peff@peff.net>
Mentored-by: Junio C Hamano <gitster@pobox.com>
---
 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..b6ed0c7 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 unstage 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

  parent reply	other threads:[~2011-05-05 18:51 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-04-30 14:54 [PATCH] config.txt: interactive.singlekey is used by Valentin Haenel
2011-05-01  4:51 ` Jeff King
2011-05-02 13:44   ` [PATCH v2 0/5] better document 'interactive.singlekey' Valentin Haenel
2011-05-02 13:44   ` [PATCH v2 1/5] config.txt: 'interactive.singlekey; is used by Valentin Haenel
2011-05-02 13:44   ` [PATCH v2 2/5] git-add.txt: document 'interactive.singlekey' Valentin Haenel
2011-05-02 17:22     ` Junio C Hamano
2011-05-03 15:38       ` Valentin Haenel
2011-05-03 18:51         ` Junio C Hamano
2011-05-04 19:58           ` [PATCH] git-add.txt: document 'add.ignoreErrors' Valentin Haenel
2011-05-05 18:47           ` [PATCH v3 0/5] better document 'interactive.singlekey' and '--patch' Valentin Haenel
2011-05-05 18:48             ` [PATCH v3 1/5] config.txt: 'interactive.singlekey; is used by Valentin Haenel
2011-05-05 18:48             ` [PATCH v3 2/5] git-add.txt: document 'interactive.singlekey' Valentin Haenel
2011-05-05 18:48             ` Valentin Haenel [this message]
2011-05-05 19:22               ` [PATCH v3 3/5] git-reset.txt: better docs for '--patch' Junio C Hamano
2011-05-05 19:41                 ` Valentin Haenel
2011-05-05 19:58                 ` [PATCH v4 " Valentin Haenel
2011-05-05 18:48             ` [PATCH v3 4/5] git-stash.txt: " Valentin Haenel
2011-05-05 18:48             ` [PATCH v3 5/5] git-checkout.txt: " Valentin Haenel
2011-05-05 19:29               ` Junio C Hamano
2011-05-05 19:16             ` [PATCH v3 0/5] better document 'interactive.singlekey' and '--patch' Junio C Hamano
2011-05-02 13:44   ` [PATCH v2 3/5] git-reset.txt: document 'interactive.singlekey' Valentin Haenel
2011-05-02 13:44   ` [PATCH v2 4/5] git-stash.txt: " Valentin Haenel
2011-05-02 13:44   ` [PATCH v2 5/5] git-checkout.txt: " Valentin Haenel

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1304621328-17184-3-git-send-email-valentin.haenel@gmx.de \
    --to=valentin.haenel@gmx.de \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=peff@peff.net \
    --cc=trast@student.ethz.ch \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).