{"thread":{"id":"23365","subject":"[PATCH v8] Documentation/remote-helpers: Add invocation section","startedAt":"2010-04-07T05:44:41Z","lastAt":"2010-04-07T05:44:41Z","messageCount":1,"participants":["Ramkumar Ramachandra"],"isPatch":true,"patchVersion":8,"patchTotal":null},"messages":[{"id":"138803","messageId":"h2gf3271551004062244t99a6da09o4fee6be399953c9b@mail.gmail.com","threadId":"23365","inReplyTo":null,"subject":"[PATCH v8] Documentation/remote-helpers: Add invocation section","fromName":"Ramkumar Ramachandra","fromEmail":"artagnon@gmail.com","sentAt":"2010-04-07T05:44:41Z","receivedAt":"2010-04-07T05:44:41Z","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 I forgot to send v7 to the list, so here are the changes since v6:\n Corrected some factual errors pointed out by Jonathan and incorporated\n some other minor suggestions by Junio and Jonathan.\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\nb/Documentation/git-remote-helpers.txt\nindex 7a5569c..5a11b28 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\nremote 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',\n'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@@ -206,6 +235,10 @@ OPTIONS\n \tmust 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.3\n"}]}