[PATCH 1/2] Documentation/remote-helpers: Add invocation and see also sections
Add Invocation section, and fill it with documentation by Ilari
Liusvaara. Add See Also section refering to the git-config page
because several configration options are referred to in the Invocation
section.
---
Documentation/git-remote-helpers.txt | 51 +++++++++++++++++++++++++++++++++
1 files changed, 51 insertions(+), 0 deletions(-)
diff --git a/Documentation/git-remote-helpers.txt
b/Documentation/git-remote-helpers.txt
index 2382fb4..58533e5 100644
--- a/Documentation/git-remote-helpers.txt
+++ b/Documentation/git-remote-helpers.txt
@@ -38,6 +38,54 @@ Git comes with a "curl" family of remote helpers,
specifically
'git-remote-ftps'. They implement the capabilities 'fetch', 'option',
and 'push'.
+INVOCATION
+----------
+
+These programs can always be invoked as 'git remote-<transport>' by
+the end user. However, the following are five situations in which
+these programs are automatically invoked by git in decreasing order of
+priority.
+
+1. URL using <transport>::<string> syntax is used directly on command
+ line.
++
+The helper is invoked with <transport>::<string> as the first argument
+and <string> as the second argument.
++
+<name> can only contain alphanumeric characters 0-9, A-Z and a-z.
+
+2. remote.<name>.url is unset, but remote.<name>.vcs is set to
+ <transport>.
++
+The helper is invoked with a single argument, <name>.
+
+3. remote.<name>.url is set to a value using the <transport>::<string>
+ syntax.
++
+The helper is invoked with <name> as the first argument and <string>
+as the second argument.
++
+<name> can only contain alphanumeric characters 0-9, A-Z and a-z.
+
+4. remote.<name>.url is set to a value using the
+ <transport>://<rest-of-URL> syntax.
++
+The helper is invoked with <name> as the first argument and
+<helper>://<rest-of-URL> as the second argument.
++
+<transport> cannot be equal to any of builtin protocols 'rsync',
+'file', 'git', 'ssh', 'git+ssh' and 'ssh+git'
+
+5. URL using <transport>://<rest-of-URL> syntax is used directly on
+ command line.
++
+The helper is invoked with two arguments, both equal to
+<transport>://<rest-of-URL>.
++
+<transport> cannot be equal to any of builtin protocols 'rsync',
+'file', 'git', 'ssh', 'git+ssh' and 'ssh+git'
+
COMMANDS
--------
@@ -206,6 +254,10 @@ OPTIONS
must not rely on this option being set before
connect request occurs.
+SEE ALSO
+--------
+linkgit:git-config[1]
+
Documentation
-------------
Documentation by Daniel Barkalow and Ilari Liusvaara
--
1.7.0.3
Ramkumar Ramachandra <artagnon@gmail.com>