Re: [PATCH] Improve documentation for git-remote-helpers

From: Ramkumar Ramachandra <artagnon@gmail.com>
Date: Mar 22, 2010, 03:04 UTC
Message-ID: <f3271551003212004r4ac7db34vad5b23f5d930476d@mail.gmail.com>
In-Reply-To: <alpine.LNX.2.00.1003211907390.14365@iabervon.org>

> I'd like to start by saying that it's good to see patches early, and also
> that I think the best documentation comes from people who are new to
> something going back and forth with people who know it too well to know
> what needs to be said about it.

Thanks :) I just posted a second revision of the patch incorporating your suggestions.

Show 5 quoted lines

> Yup. Or maybe these should be documented as a list of capabilities which
> mean that the helper supports the command with the same name, since that's
> a common pattern, and documenting it as a pattern makes it obvious that,
> if we have a new 'export' command, and it needs a capability, it'll fit
> the pattern.

Every capability doesn't necessarily have a corresponding command with the same name, and vice-versa (see refspec spec?). Besides, I think it's necessary for the manpage to have a list of capabilities listed in one place. I'll think about a better format when we get more capabilities/ commands.

-- Ram