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

From: Jonathan Nieder <jrnieder@gmail.com>
Date: Mar 30, 2010, 18:37 UTC
Message-ID: <20100330183748.GA10647@progeny.tock>
In-Reply-To: <f3271551003300947u4c7c2a83q13aaf786140bfa37@mail.gmail.com>

Hi Ram,

Ramkumar Ramachandra wrote:

Show 9 quoted lines

> +INVOCATION
> +----------
> +
> +Remote helper programs are invoked with one or optionally two
> +arguments on the command line. The first argument specifies a remote
> +to use; typically, it is either the name of a remote in the
> +configuration or just a URL. The second argument is a URL, and serves
> +to resolve ambiguities that may arise when only the first argument is
> +specified.

This last sentence (“ambiguities that may arise”) raises more questions than it answers in my opinion. Maybe it would make sense to say

 The first argument identifies a <repository> as it would be specified to
 git; typically, this is either a configured remote nickname or a URL.

 The second argument, if present, is a URL for the remote repository.
 without such an argument, invocations for remotes with multiple
 URLs set would be ambiguous.  If the second argument is missing,
 this remote nickname does not have a URL set and should probably have
 some transport-specific configuration set up separately.

 The URL in the second argument can be an arbitrary string.  It is up
 to the remote helper to assign meaning to it.

or something to that effect.

Jonathan