[PATCH v4] Documentation/remote-helpers: Add invocation section

From

Ramkumar Ramachandra <artagnon@gmail.com>

Date

Mar 31, 2010, 19:40 UTC

Message-ID

<x2zf3271551003311240i53ecb2fck173c8f34bdb3257@mail.gmail.com>

Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
---
 What changed since v3: Clarification on what URLs can be, and
 possibility of second argument making the first redundant.

 Documentation/git-remote-helpers.txt |   18 ++++++++++++++++++
 1 files changed, 18 insertions(+), 0 deletions(-)

diff --git a/Documentation/git-remote-helpers.txt
b/Documentation/git-remote-helpers.txt
index 2382fb4..f2b2738 100644
--- a/Documentation/git-remote-helpers.txt
+++ b/Documentation/git-remote-helpers.txt
@@ -38,6 +38,20 @@ Git comes with a "curl" family of remote helpers,
specifically
 'git-remote-ftps'. They implement the capabilities 'fetch', 'option',
 and 'push'.

+INVOCATION
+----------
+
+Remote helper programs are invoked with one or (optionally) two
+command line arguments. The first argument specifies a remote
+repository as in git; typically, it is either the name of a configured
+remote or just a URL. The second argument, if present, is a URL. When
+the remote specified in the first argument has more than one
+configured URL, it serves to resolve the ambiguity and pick one of the
+URLs. Depending on the remote helper, supplying the second argument
+can make the first argument redundant. URLs may be those normally
+recognized by git, or arbitrary URL-like strings recognized by the
+specific remote helper being invoked.
+
 COMMANDS
 --------

@@ -206,6 +220,10 @@ OPTIONS
 	must not rely on this option being set before
 	connect request occurs.

+SEE ALSO
+--------
+linkgit:git-remote[1]
+
 Documentation
 -------------
 Documentation by Daniel Barkalow and Ilari Liusvaara

-- 
1.7.0.3