[PATCH v6] Improve remote-helpers documentation

Previous thread: Feature Request: raw body in format strings by Eli Barzilay on Monday, March 22, 2010 - 8:28 pm. (2 messages)

Next thread: How to ignore changes on remote by Howard Miller on Tuesday, March 23, 2010 - 6:54 am. (14 messages)
From: Ramkumar Ramachandra
Date: Tuesday, March 23, 2010 - 12:45 am

Rewrote the description section to describe what exactly remote
helpers are and the need for them. Mentioned the curl family of remote
helpers as an example. Fixed minor typos in the rest of the document.

Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
---
    Complete rewrite since last revision, inspired by Junio's detailed review.

 Documentation/git-remote-helpers.txt |   89 ++++++++++++++++++++--------------
 1 files changed, 52 insertions(+), 37 deletions(-)

diff --git a/Documentation/git-remote-helpers.txt
b/Documentation/git-remote-helpers.txt
index 1b5f61a..2382fb4 100644
--- a/Documentation/git-remote-helpers.txt
+++ b/Documentation/git-remote-helpers.txt
@@ -3,7 +3,7 @@ git-remote-helpers(1)

 NAME
 ----
-git-remote-helpers - Helper programs for interoperation with remote git
+git-remote-helpers - Helper programs to interact with remote repositories

 SYNOPSIS
 --------
@@ -12,11 +12,31 @@ SYNOPSIS
 DESCRIPTION
 -----------

-These programs are normally not used directly by end users, but are
-invoked by various git programs that interact with remote repositories
-when the repository they would operate on will be accessed using
-transport code not linked into the main git binary. Various particular
-helper programs will behave as documented here.
+Remote helper programs are normally not used directly by end users,
+but are invoked by git when it needs to interact with remote
+repositories. They implement a subset of the capabilities documented
+here, and conform to the "remote helper protocol". When git needs
+needs to interact with a repository served by a remote helper, it
+spawns the helper as an independent process and interacts with it over
+the specified protocol. Essentially, git sends commands to the helper
+over standard input, and receives the result written to standard
+output by the helper over a pipe. Also, since remote helpers often
+need to link to the libraries required to interact with the remote
+repository, they avoid linking ...
From: Ramkumar Ramachandra
Date: Tuesday, March 23, 2010 - 2:38 am

Rewrote the description section to describe what exactly remote
helpers are and the need for them. Mentioned the curl family of remote
helpers as an example. Fixed minor typos in the rest of the document.

Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
---
   Complete rewrite since last revision, inspired by Junio's detailed review.

 Documentation/git-remote-helpers.txt |   89 ++++++++++++++++++++--------------
 1 files changed, 52 insertions(+), 37 deletions(-)

diff --git a/Documentation/git-remote-helpers.txt
b/Documentation/git-remote-helpers.txt
index 1b5f61a..2382fb4 100644
--- a/Documentation/git-remote-helpers.txt
+++ b/Documentation/git-remote-helpers.txt
@@ -3,7 +3,7 @@ git-remote-helpers(1)

 NAME
 ----
-git-remote-helpers - Helper programs for interoperation with remote git
+git-remote-helpers - Helper programs to interact with remote repositories

 SYNOPSIS
 --------
@@ -12,11 +12,31 @@ SYNOPSIS
 DESCRIPTION
 -----------

-These programs are normally not used directly by end users, but are
-invoked by various git programs that interact with remote repositories
-when the repository they would operate on will be accessed using
-transport code not linked into the main git binary. Various particular
-helper programs will behave as documented here.
+Remote helper programs are normally not used directly by end users,
+but are invoked by git when it needs to interact with remote
+repositories. They implement a subset of the capabilities documented
+here, and conform to the "remote helper protocol". When git needs
+needs to interact with a repository served by a remote helper, it
+spawns the helper as an independent process and interacts with it over
+the specified protocol. Essentially, git sends commands to the helper
+over standard input, and receives the result written to standard
+output by the helper over a pipe. Also, since remote helpers often
+need to link to the libraries required to interact with the remote
+repository, they avoid linking ...
From: Ramkumar Ramachandra
Date: Sunday, March 28, 2010 - 9:32 am

On Tue, Mar 23, 2010 at 3:08 PM, Ramkumar Ramachandra

Junio: So is this patch alright?

-- Ram
--

From: Junio C Hamano
Date: Sunday, March 28, 2010 - 10:43 am

It looked good to me.

--

From: Junio C Hamano
Date: Sunday, March 28, 2010 - 10:51 am

... except that the message is corrupt and does not apply.  Here is an
excerpt from it, before decoding MIME and quoted-printable.

    Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
    ---
    =A0 =A0Complete rewrite since last revision, inspired by Junio's detail=
    ed review.

    =A0Documentation/git-remote-helpers.txt | =A0 89 ++++++++++++++++++++--=
    ------------
    =A01 files changed, 52 insertions(+), 37 deletions(-)

    diff --git a/Documentation/git-remote-helpers.txt
    b/Documentation/git-remote-helpers.txt
    index 1b5f61a..2382fb4 100644
    --- a/Documentation/git-remote-helpers.txt
    +++ b/Documentation/git-remote-helpers.txt
    @@ -3,7 +3,7 @@ git-remote-helpers(1)

    =A0NAME
    =A0----

Who is replacing the SPs with A0???

--

From: Ramkumar Ramachandra
Date: Sunday, March 28, 2010 - 11:05 am

Ouch. I've just prepared a v7- I hope that applies cleanly. It's in
two parts now.

-- Ram
--

Previous thread: Feature Request: raw body in format strings by Eli Barzilay on Monday, March 22, 2010 - 8:28 pm. (2 messages)

Next thread: How to ignore changes on remote by Howard Miller on Tuesday, March 23, 2010 - 6:54 am. (14 messages)