Re: [PATCH v2] Documentation/remote-helpers: Add invocation section

From: Ramkumar Ramachandra <artagnon@gmail.com>
Date: Mar 30, 2010, 20:42 UTC
Message-ID: <f3271551003301342j2fcefee6l1e9c9fa2d012bc11@mail.gmail.com>
In-Reply-To: <20100330202511.GC10977@progeny.tock>

Hi,

On Wed, Mar 31, 2010 at 1:55 AM, Jonathan Nieder <jrnieder@gmail.com> wrote:

> Hmm.  urls.txt is not currently its own page; instead, it is included
> in git-clone(1) and so on.  I hope to change that this weekend.

My thoughts exactly. The giturls(7) idea will have to be dropped. It looks like we have to post a patch for urls.txt to include some introductory text and turn it into giturls(1), a manpage in its own right. Then we have to remove references to urls.txt from all the documents and make them point to gituls(1). I suspect the whole thing will have to be done bit by bit, and go through several reviews. I can help out a bit, but I wait for you to write most of it first.

One very realistic problem: Ambiguity between general URLS, "URLS recognized by Git", and "arbitrary strings that perform the same function as URLS".

> More to the point, wouldn’t "URL recognized by Git" mean a string
> like fd::3,4 rather than the 3,4 that is passed to ‘git remote-fd’?

That falls under the <transport>::<address> category, but Ilari might very well come up with a totally new syntax for a remote helper he writes tomorrow.

> Also worth keeping in mind: we want to support third-party helpers, too.
> So it is hard to have one centralized document that completely explains
> all possible URLs.

Okay, I'll try to word it accordingly then. "URLS recognized by git, and arbitrary URL-like strings recognized by that specific remote helper program".

-- Ram