{"thread":{"id":"23508","subject":"[PATCH 3/5] Documentation/remote-helpers: Add invocation section","startedAt":"2010-04-18T00:55:27Z","lastAt":"2010-04-18T00:55:27Z","messageCount":1,"participants":["Ramkumar Ramachandra"],"isPatch":true,"patchVersion":1,"patchTotal":5},"messages":[{"id":"139798","messageId":"1271552116-sup-1388@kytes","threadId":"23508","inReplyTo":null,"subject":"[PATCH 3/5] Documentation/remote-helpers: Add invocation section","fromName":"Ramkumar Ramachandra","fromEmail":"artagnon@gmail.com","sentAt":"2010-04-18T00:55:27Z","receivedAt":"2010-04-18T00:55:27Z","isPatch":true,"sender":{"key":"r@artagnon.com","avatar":"https://avatars.githubusercontent.com/u/37226?v=4"},"body":"Add an 'Invocation' section to specify what the command line arguments\nmean. Also include a link to git-remote in the 'See Also' section.\n\nSigned-off-by: Ramkumar Ramachandra <artagnon@gmail.com>\n---\n Documentation/git-remote-helpers.txt |   35 +++++++++++++++++++++++++++++++++-\n 1 files changed, 34 insertions(+), 1 deletions(-)\n\ndiff --git a/Documentation/git-remote-helpers.txt b/Documentation/git-remote-helpers.txt\nindex 15214ae..25a0a16 100644\n--- a/Documentation/git-remote-helpers.txt\n+++ b/Documentation/git-remote-helpers.txt\n@@ -7,7 +7,7 @@ git-remote-helpers - Helper programs to interact with remote repositories\n \n SYNOPSIS\n --------\n-'git remote-<transport>' <remote>\n+'git remote-<transport>' <repository> [<URL>]\n \n DESCRIPTION\n -----------\n@@ -38,6 +38,35 @@ transport protocols, such as 'git-remote-http', 'git-remote-https',\n 'git-remote-ftp' and 'git-remote-ftps'. They implement the capabilities\n 'fetch', 'option', and 'push'.\n \n+INVOCATION\n+----------\n+\n+Remote helper programs are invoked with one or (optionally) two\n+arguments. The first argument specifies a remote repository as in git;\n+it is either the name of a configured remote or a URL. The second\n+argument specifies a URL of the form '<transport>://<address>' or\n+'<transport>::<address>', where '<address>' may be an arbitrary\n+string.\n+\n+When git encounters a URL of the form '<transport>://<address>', where\n+'<transport>' is a protocol that it cannot handle natively, it\n+automatically invokes 'git remote-<transport>' with the full URL as\n+the second argument. If such a URL is encountered directly on the\n+command line, the first argument is the same as the second, and if it\n+is encountered in a configured remote, the first argument is the name\n+of that remote.\n+\n+A URL of the form '<transport>::<address>' explicitly instructs git to\n+invoke 'git remote-<transport>' with '<address>' as the second\n+argument. If such a URL is encountered directly on the command line,\n+the first argument is '<address>', and if it is encountered in a\n+configured remote, the first argument is the name of that remote.\n+\n+Additionally, when a configured remote has 'remote.<name>.vcs' set to\n+'<transport>', git explicitly invokes 'git remote-<transport>' with\n+'<name>' as the first argument. If set, the second argument is\n+'remote.<name>.url'; otherwise, the second argument is omitted.\n+\n COMMANDS\n --------\n \n@@ -211,6 +240,10 @@ OPTIONS\n \thelper MUST NOT rely on this option being set before\n \tconnect request occurs.\n \n+SEE ALSO\n+--------\n+linkgit:git-remote[1]\n+\n Documentation\n -------------\n Documentation by Daniel Barkalow and Ilari Liusvaara\n-- \n1.7.0.4\n"}]}