[PATCH v3] Documentation/remote-helpers: Add invocation section
Add an invocation section to specify what the command line arguments
mean. Also include a link to git-remote in the see also section.
---
What changed since v2: Explained the meaning of ambiguity, and
improved overall clarity.
Documentation/git-remote-helpers.txt | 17 +++++++++++++++++
1 files changed, 17 insertions(+), 0 deletions(-)
diff --git a/Documentation/git-remote-helpers.txt
b/Documentation/git-remote-helpers.txt
index 2382fb4..4375678 100644
--- a/Documentation/git-remote-helpers.txt
+++ b/Documentation/git-remote-helpers.txt
@@ -38,6 +38,17 @@ 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 it would be in git; typically, it is either the name of
+a configured remote or just a URL. The second argument, if present, is
+a URL, and serves to resolve ambiguities that may arise when only the
+first argument is specified (i.e. when a remote has more than one
+configured URL).
+
COMMANDS
--------
@@ -206,6 +217,12 @@ 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
Ramkumar Ramachandra <artagnon@gmail.com>