git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Ramkumar Ramachandra <artagnon@gmail.com>
To: Daniel Barkalow <barkalow@iabervon.org>
Cc: Git Mailing List <git@vger.kernel.org>,
	Jonathan Nieder <jrnieder@gmail.com>,
	Sverre Rabbelier <srabbelier@gmail.com>
Subject: Re: [PATCH] Improve documentation for git-remote-helpers
Date: Mon, 22 Mar 2010 08:34:07 +0530	[thread overview]
Message-ID: <f3271551003212004r4ac7db34vad5b23f5d930476d@mail.gmail.com> (raw)
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.

> 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

  parent reply	other threads:[~2010-03-22  3:04 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-03-21 17:26 [PATCH] Improve documentation for git-remote-helpers Ramkumar Ramachandra
2010-03-21 18:21 ` Ramkumar Ramachandra
2010-03-21 23:29   ` Daniel Barkalow
2010-03-21 23:35     ` Sverre Rabbelier
2010-03-22  0:06       ` Daniel Barkalow
2010-03-22 15:40         ` Sverre Rabbelier
2010-03-22  7:28       ` Ramkumar Ramachandra
2010-03-22  3:04     ` Ramkumar Ramachandra [this message]
2010-03-22  3:38       ` Ramkumar Ramachandra

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=f3271551003212004r4ac7db34vad5b23f5d930476d@mail.gmail.com \
    --to=artagnon@gmail.com \
    --cc=barkalow@iabervon.org \
    --cc=git@vger.kernel.org \
    --cc=jrnieder@gmail.com \
    --cc=srabbelier@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).