[PATCH v2] 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.
---
The first version contained too much information.
Followed Daniel Barkalow's suggestion to strip it of caller information.
Documentation/git-remote-helpers.txt | 16 ++++++++++++++++
1 files changed, 16 insertions(+), 0 deletions(-)
diff --git a/Documentation/git-remote-helpers.txt
b/Documentation/git-remote-helpers.txt
index 2382fb4..e9c9d77 100644
--- a/Documentation/git-remote-helpers.txt
+++ b/Documentation/git-remote-helpers.txt
@@ -38,6 +38,16 @@ 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
+arguments on the command line. The first argument specifies a remote
+to use; typically, it is either the name of a remote in the
+configuration or just a URL. The second argument is a URL, and serves
+to resolve ambiguities that may arise when only the first argument is
+specified.
+
COMMANDS
--------
@@ -206,6 +216,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>