git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v2 1/6] git-remote-helpers.txt: document invocation before input format

From
Felipe Contreras <felipe.contreras@gmail.com>
Date
Dec 12, 2012, 22:14 UTC
Message-ID
<CAMP44s3vO9b4-XxqatEc2w3KJLqLGgyjPuKpQkAXHQwTJJEQTg@mail.gmail.com>
In-Reply-To
<1354057407-83151-2-git-send-email-max@quendi.de>
On Tue, Nov 27, 2012 at 5:03 PM, Max Horn <max@quendi.de> wrote:
Show 26 quoted lines
> index 5ce4cda..9a7e583 100644
> --- a/Documentation/git-remote-helpers.txt
> +++ b/Documentation/git-remote-helpers.txt
> @@ -35,6 +35,37 @@ transport protocols, such as 'git-remote-http', 'git-remote-https',
>  'git-remote-ftp' and 'git-remote-ftps'. They implement the capabilities
>  'fetch', 'option', and 'push'.
>
> +INVOCATION
> +----------
> +
> +Remote helper programs are invoked with one or (optionally) two
> +arguments. The first argument specifies a remote repository as in git;
> +it is either the name of a configured remote or a URL. The second
> +argument specifies a URL; it is usually of the form
> +'<transport>://<address>', but any arbitrary string is possible.
> +The 'GIT_DIR' environment variable is set up for the remote helper
> +and can be used to determine where to store additional data or from
> +which directory to invoke auxiliary git commands.
> +
> +When git encounters a URL of the form '<transport>://<address>', where
> +'<transport>' is a protocol that it cannot handle natively, it
> +automatically invokes 'git remote-<transport>' with the full URL as
> +the second argument. If such a URL is encountered directly on the
> +command line, the first argument is the same as the second, and if it
> +is encountered in a configured remote, the first argument is the name
> +of that remote.

Maybe it's worth mentioning that if the alias of the remote is not specified, the URL is used instead.

Show 10 quoted lines
> +A URL of the form '<transport>::<address>' explicitly instructs git to
> +invoke 'git remote-<transport>' with '<address>' as the second
> +argument. If such a URL is encountered directly on the command line,
> +the first argument is '<address>', and if it is encountered in a
> +configured remote, the first argument is the name of that remote.
> +
> +Additionally, when a configured remote has 'remote.<name>.vcs' set to
> +'<transport>', git explicitly invokes 'git remote-<transport>' with
> +'<name>' as the first argument. If set, the second argument is
> +'remote.<name>.url'; otherwise, the second argument is omitted.

I find all this text a bit confusing. First argument, second argument, etc. Personally, I would describe everything in the terms of alias (1st arg), and URL (2nd arg).

-- 
Felipe Contreras
Previous: Max HornNext: Max Horn
Message 3 of 16 in “Improve remote helper documentation”
  1. 0/6 Improve remote helper documentationMax Horn, Nov 27, 2012
  2. 1/6 git-remote-helpers.txt: document invocation before input formatMax Horn, Nov 27, 2012
  3. Felipe ContrerasDec 12, 2012
  4. Max HornDec 12, 2012
  5. Felipe ContrerasDec 12, 2012
  6. Max HornDec 12, 2012
  7. Junio C HamanoDec 12, 2012
  8. Max HornDec 12, 2012
  9. Junio C HamanoDec 12, 2012
  10. 2/6 git-remote-helpers.txt: document missing capabilitiesMax Horn, Nov 27, 2012
  11. 3/6 git-remote-helpers.txt: minor grammar fixMax Horn, Nov 27, 2012
  12. 4/6 git-remote-helpers.txt: rearrange description of capabilitiesMax Horn, Nov 27, 2012
  13. 5/6 git-remote-helpers.txt: clarify command <-> capability correspondencesMax Horn, Nov 27, 2012
  14. 6/6 git-remote-helpers.txt: clarify options & ref list attributesMax Horn, Nov 27, 2012
  15. 6/6 git-remote-helpers.txt: clarify ref list attributes, link to subsectionsMax Horn, Nov 27, 2012
  16. Max HornNov 27, 2012

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.