Re: [PATCH] Improve --patch option documentation in git-add

From

Jari Aalto <jari.aalto@cante.net>

Date

Sep 13, 2009, 14:09 UTC

Message-ID

<87vdjnlywo.fsf@jondo.cante.net>

In-Reply-To

<237967ef0909130648l36b592aft9c50ccff5d03d1b1@mail.gmail.com>

Mikael Magnusson <mikachu@gmail.com> writes:

>> +       Interactively choose hunks of patch between the index and the
> diff probably makes more sense than patch here
>
>> +       work tree and add them to the index. This gives a change to
> a chance
>
>> +       review the difference before adding modified contents to the
> differences? Not sure which I prefer on this one.
>
>> +       index.
>> +
>> +       This effectively runs ``add --interactive``, but bypass the
> bypasses
>
>> +       initial command menu and directly jump to `patch` subcommand.
> jumps

>From beca0d3dcd668e1b578588378149320cd3aed9d9 Mon Sep 17 00:00:00 2001

From: Jari Aalto <jari.aalto@cante.net>
Date: Sun, 13 Sep 2009 17:08:51 +0300
Subject: [PATCH] Improve --patch option documentation in git-add

Signed-off-by: Jari Aalto <jari.aalto@cante.net>
---
 Documentation/git-add.txt |   11 ++++++++---
 1 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt
index e67b7e8..0b2a2a6 100644
--- a/Documentation/git-add.txt
+++ b/Documentation/git-add.txt
@@ -72,9 +72,14 @@ OPTIONS
 
 -p::
 --patch::
-	Similar to Interactive mode but the initial command loop is
-	bypassed and the 'patch' subcommand is invoked using each of
-	the specified filepatterns before exiting.
+	Interactively choose hunks of diff between the index and the
+	work tree and add them to the index. This gives a change to
+	review the differences before adding modified contents to the
+	index.
+
+	This effectively runs ``add --interactive``, but bypass the
+	initial command menu and directly jumps to `patch` subcommand.
+	See ``Interactive mode'' for details.
 
 -e, \--edit::
 	Open the diff vs. the index in an editor and let the user

-- 
1.6.3.3