Re: [PATCH v2 3/3] git-remote-ext
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Sep 30, 2010, 20:03 UTC
- Message-ID
- <7vfwwrhud1.fsf@alter.siamese.dyndns.org>
- In-Reply-To
- <20100930134552.GF4850@burratino>
Jonathan Nieder <jrnieder@gmail.com> writes:
Show 28 quoted lines
> Ilari Liusvaara wrote: > >> This remote helper invokes external command and passes raw smart transport >> stream through it. This is useful for instance for invoking ssh with >> one-off odd options, connecting to git services in unix domain >> sockets, in abstract namespace, using TLS or other secure protocols, >> etc... > > Tunneling, too (e.g., native git protocol passing through draconian > firewall), right? > >> Documentation/git-remote-ext.txt | 87 ++++++++++++++++++++++++++++++++++++++ >> Makefile | 1 + >> builtin.h | 1 + >> git.c | 1 + >> 4 files changed, 90 insertions(+), 0 deletions(-) >> create mode 100644 Documentation/git-remote-ext.txt > > Where is the implementation? > >> +++ b/Documentation/git-remote-ext.txt >> @@ -0,0 +1,87 @@ >> +git-remote-ext(1) >> +================= >> + >> +NAME >> +---- >> +git-remote-ext - Bridge smart transport to external command.
Is "remote-ext" a git subcommand that "git help --all" would want to show?
Show 9 quoted lines
>> +SYNOPSIS >> +-------- >> +"ext::<command>[ <arguments>...]" (as URL) > > Maybe: > > git remote add nick "ext::<program>[ <arguments>...]" > > as a concrete example.
Ahh. I wasted minutes and hears scratching my head to figure out what that "(as URL)" was about.
Show 32 quoted lines
>> +
>> +DESCRIPTION
>> +-----------
>> +This command uses specified command to connect to remote git server.
>
> - Most users won't invoke remote-ext directly, right?
> - Missing articles ('the' and 'a').
> - Missing formatting ('command' is passed on the command line).
>
> So maybe:
>
> This remote helper uses the specified 'program' to connect
> to a remote git server.
>
>> +
>> +Between <command> and <arguments> (if present) is space. Also space
>> +splits different arguments.
>
> Arguments should be separated by a single unescaped space.
>
> Do I understand correctly?
>
>> +
>> +The following sequences have special meaning:
>
> Missing article:
>
> ... have a special meaning:
>
>> +
>> +'\ '::
>> + Don't interpret the space as command/argument separator.Is it just me who finds the placeholders with backslashes somewhat out of place where most other placeholders in git are per-cent prefixed?