{"thread":{"id":"23355","subject":"[PATCH v5] Documentation/remote-helpers: Add invocation section","startedAt":"2010-04-06T11:04:35Z","lastAt":"2010-04-06T13:23:00Z","messageCount":2,"participants":["Ramkumar Ramachandra"],"isPatch":true,"patchVersion":5,"patchTotal":null},"messages":[{"id":"138735","messageId":"t2sf3271551004060404xe41ff754i9d16a265a4222a28@mail.gmail.com","threadId":"23355","inReplyTo":null,"subject":"[PATCH v5] Documentation/remote-helpers: Add invocation section","fromName":"Ramkumar Ramachandra","fromEmail":"artagnon@gmail.com","sentAt":"2010-04-06T11:04:35Z","receivedAt":"2010-04-06T11:04:35Z","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 \n---\n What changed: After Junio's review, invocation section is more detailed.\n\n Documentation/git-remote-helpers.txt | 48 +++++++++++++++++++++++++++++++++-\n 1 files changed, 47 insertions(+), 1 deletions(-)\n\ndiff --git a/Documentation/git-remote-helpers.txt\nb/Documentation/git-remote-helpers.txt\nindex 2382fb4..b3b42ff 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-' \n+'git remote-' []\n\n DESCRIPTION\n -----------\n@@ -38,6 +38,48 @@ Git comes with a \"curl\" family of remote helpers,\nspecifically\n 'git-remote-ftps'. They implement the capabilities 'fetch', 'option',\n and 'push'.\n\n+INVOCATION\n+----------\n+\n+Remote helper programs are invoked with one or (optionally) two\n+command line arguments. The first argument specifies a remote\n+repository as in git; typically, it is either the name of a configured\n+remote or just a URL. The second argument specifies a URL; it may\n+either be a URL recognized by git, or an arbitrary URL-like string\n+recognized by the specific helper being invoked. When the remote\n+specified in the first argument has more than one configured URL, it\n+serves to resolve the ambiguity and pick one of the URLs. Depending on\n+the helper, supplying the second argument can make the first argument\n+redundant.\n+\n+When git encounters a URL of the form '://
', where\n+ is a protocol that it cannot handle natively, it\n+implicitly invokes 'git remote-' with\n+the full URL as the second argument. The first argument\n+is either the same as the second, when called from directly from\n+command line, or corresponding to the configured remote's name.\n+\n+A URL of the form '::
' explicitly instructs git to\n+invoke the corresponding helper with '
' as the second\n+argument. '::' is the first argument when the\n+helper is invoked directly from the command line, or ''\n+corresponding to the configured remote's name.\n+\n+Another explicit invocation case arises when a configured remote\n+includes the remote..vcs is set to , in which case\n+the 'git remote-' is invoked with a single argument,\n+.\n+\n+\n+ with vcs set\n+~~~~~~~~~~~~~~~~~~~~~~~\n+\n+A remote can be configured to use the\n+'git remote-' helper by setting the vcs variable to\n+ in the [remote \"\"] section of a configuration file.\n+The url variable in such a section is optional and can be set to an\n+arbitrary string
.\n+\n COMMANDS\n --------\n\n@@ -206,6 +248,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"},{"id":"138750","messageId":"o2yf3271551004060623z46cdc599kec7f6f6dc0f28e9@mail.gmail.com","threadId":"23355","inReplyTo":"t2sf3271551004060404xe41ff754i9d16a265a4222a28@mail.gmail.com","subject":"Re: [PATCH v5] Documentation/remote-helpers: Add invocation section","fromName":"Ramkumar Ramachandra","fromEmail":"artagnon@gmail.com","sentAt":"2010-04-06T13:23:00Z","receivedAt":"2010-04-06T13:23:00Z","isPatch":true,"sender":{"key":"r@artagnon.com","avatar":"https://avatars.githubusercontent.com/u/37226?v=4"},"body":"> + with vcs set\n> +~~~~~~~~~~~~~~~~~~~~~~~\n> +\n> +A remote can be configured to use the\n> +'git remote-' helper by setting the vcs variable to\n> + in the [remote \"\"] section of a configuration file.\n> +The url variable in such a section is optional and can be set to an\n> +arbitrary string
.\n\nI'm sorry- this was sloppy. Plus, it doesn't apply to master or pu.\nI'll send in another revision of the patch with this hunk removed\nrebased on pu.\n\n-- Ram\n"}]}