From: Matthieu Moy <Matthieu.Moy@grenoble-inp•fr>
To: Jonathan Nieder <jrnieder@gmail•com>
Cc: Sverre Rabbelier <srabbelier@gmail•com>,
Junio C Hamano <gitster@pobox•com>,
git@vger•kernel.org,
Jeremie Nikaes <jeremie.nikaes@ensimag•imag.fr>,
Arnaud Lacurie <arnaud.lacurie@ensimag•imag.fr>,
Claire Fousse <claire.fousse@ensimag•imag.fr>,
David Amouyal <david.amouyal@ensimag•imag.fr>,
Ramkumar Ramachandra <artagnon@gmail•com>,
Dmitry Ivankov <divanorama@gmail•com>
Subject: Re: [PATCH 2/2] Add a remote helper to interact with mediawiki (fetch & push)
Date: Wed, 31 Aug 2011 13:54:04 +0200 [thread overview]
Message-ID: <vpqobz53ig3.fsf@bauges.imag.fr> (raw)
In-Reply-To: <20110830035608.GB6647@elie.gateway.2wire.net> (Jonathan Nieder's message of "Mon, 29 Aug 2011 22:56:08 -0500")
Jonathan Nieder <jrnieder@gmail•com> writes:
> Here's an old attempt to make the documentation a little easier to read,
> and hopefully also to add to.
Thanks, that helps. I wish we had all this earlier ;-).
> +Git sends the remote helper a list of commands on standard input, one
> +per line. The first command is always the 'capabilities' command,
Do we want to set this in stone? Wouldn't a Git implementation calling
"option" before "capabilities" be correct?
> +Capabilities
> +~~~~~~~~~~~~
(perhaps name the section "Overview of Capabilities"?)
[...]
> +'refspec' <refspec>::
> + This modifies the 'import' capability, allowing the produced
> + fast-import stream to modify refs in a private namespace
> + instead of writing to refs/heads or refs/remotes directly.
> + It is recommended that all importers providing the 'import'
> + capability use this.
> ++
> +A helper advertising the capability
> +`refspec refs/heads/{asterisk}:refs/svn/origin/branches/{asterisk}`
> +is saying that, when it is asked to `import refs/heads/topic`, the
> +stream it outputs will update the `refs/svn/origin/branches/topic`
> +ref.
> ++
> +This capability can be advertised multiple times. The first
> +applicable refspec takes precedence. The left-hand of refspecs
> +advertised with this capability must cover all refs reported by
> +the list command. If no 'refspec' capability is advertised,
> +there is an implied `refspec {asterisk}:{asterisk}`.
Since this "Capabilities" section is meant to be an overview, I'd
shorten this to
+'refspec' <refspec>::
+ This modifies the 'import' capability, allowing the produced
+ fast-import stream to modify refs in a private namespace
+ instead of writing to refs/heads or refs/remotes directly.
and drop the detailed explanation here.
> +Capabilities for Fetching
> +~~~~~~~~~~~~~~~~~~~~~~~~~
[...]
> +'refspec' <refspec>::
> + This modifies the 'import' capability.
Since this would be the "detailed explanation" part, this is the one
readers will read more carefully, so I'd put the recommandation right
here:
+ It is recommended that all importers providing the 'import'
+ capability use this.
and of course, keep this:
> ++
> +A helper advertising
> +`refspec refs/heads/{asterisk}:refs/svn/origin/branches/{asterisk}`
> +in its capabilities is saying that, when it handles
> +`import refs/heads/topic`, the stream it outputs will update the
> +`refs/svn/origin/branches/topic` ref.
> ++
> +This capability can be advertised multiple times. The first
> +applicable refspec takes precedence. The left-hand of refspecs
> +advertised with this capability must cover all refs reported by
> +the list command. If no 'refspec' capability is advertised,
> +there is an implied `refspec {asterisk}:{asterisk}`.
> +
--
Matthieu Moy
http://www-verimag.imag.fr/~moy/
next prev parent reply other threads:[~2011-08-31 11:54 UTC|newest]
Thread overview: 43+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-08-26 17:11 [PATCH 1/2] fast-import: initialize variable require_explicit_termination Matthieu Moy
2011-08-26 17:11 ` [PATCH 2/2] Add a remote helper to interact with mediawiki (fetch & push) Matthieu Moy
2011-08-26 17:53 ` Junio C Hamano
2011-08-29 5:42 ` Sverre Rabbelier
2011-08-29 6:05 ` Junio C Hamano
2011-08-29 6:41 ` Sverre Rabbelier
2011-08-30 3:56 ` Jonathan Nieder
2011-08-30 17:13 ` Junio C Hamano
2011-08-31 11:54 ` Matthieu Moy [this message]
2011-09-01 23:44 ` Jonathan Nieder
2011-08-31 12:05 ` done feature in remote-helpers (was Re: [PATCH 2/2] Add a remote helper to interact with mediawiki (fetch & push)) Matthieu Moy
2011-08-31 12:17 ` Sverre Rabbelier
2011-08-31 12:55 ` Matthieu Moy
2011-08-31 12:58 ` Sverre Rabbelier
2011-08-31 13:12 ` Matthieu Moy
2011-08-31 13:16 ` Sverre Rabbelier
2011-08-31 16:47 ` [PATCH] git-remote-helpers.txt: explain how import works with multiple refs Matthieu Moy
2011-08-31 18:14 ` [PATCH] (short) documentation for the testgit remote helper Matthieu Moy
2011-09-01 11:27 ` Sverre Rabbelier
2011-09-01 15:52 ` Matthieu Moy
2011-09-01 16:49 ` [PATCH 1/2 v2] Documentation/git-remote-helpers: explain how import works with multiple refs Matthieu Moy
2011-09-01 16:49 ` [PATCH 2/2 v2] (short) documentation for the testgit remote helper Matthieu Moy
2011-09-01 16:59 ` Sverre Rabbelier
2011-09-01 16:59 ` [PATCH 1/2 v2] Documentation/git-remote-helpers: explain how import works with multiple refs Sverre Rabbelier
2011-09-01 11:24 ` [PATCH] git-remote-helpers.txt: " Sverre Rabbelier
2011-09-01 23:17 ` Jonathan Nieder
2011-09-03 10:35 ` Matthieu Moy
2011-08-26 17:55 ` [PATCH v5] Add a remote helper to interact with mediawiki (fetch & push) Matthieu Moy
2011-08-31 16:55 ` [PATCH v6] " Matthieu Moy
2011-08-31 17:03 ` Sverre Rabbelier
2011-08-31 17:30 ` Matthieu Moy
2011-09-01 0:24 ` Junio C Hamano
2011-09-01 5:26 ` Matthieu Moy
2011-09-01 16:54 ` [PATCH 0/2] Git-MediaWiki Matthieu Moy
2011-09-01 16:54 ` [PATCH 1/2 v7] Add a remote helper to interact with mediawiki (fetch & push) Matthieu Moy
2011-09-01 16:54 ` [PATCH 2/2] git-remote-mediawiki: allow push to set MediaWiki metadata Matthieu Moy
2011-08-31 12:33 ` Clean termination of remote-helpers (was Re: [PATCH 2/2] Add a remote helper to interact with mediawiki (fetch & push)) Matthieu Moy
2011-08-31 13:25 ` Sverre Rabbelier
2011-08-31 14:53 ` Matthieu Moy
2011-08-31 15:00 ` Sverre Rabbelier
2011-08-26 17:51 ` [PATCH 1/2] fast-import: initialize variable require_explicit_termination Junio C Hamano
2011-08-26 17:59 ` Matthieu Moy
2011-08-26 18:55 ` Junio C Hamano
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=vpqobz53ig3.fsf@bauges.imag.fr \
--to=matthieu.moy@grenoble-inp$(echo .)fr \
--cc=arnaud.lacurie@ensimag$(echo .)imag.fr \
--cc=artagnon@gmail$(echo .)com \
--cc=claire.fousse@ensimag$(echo .)imag.fr \
--cc=david.amouyal@ensimag$(echo .)imag.fr \
--cc=divanorama@gmail$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=gitster@pobox$(echo .)com \
--cc=jeremie.nikaes@ensimag$(echo .)imag.fr \
--cc=jrnieder@gmail$(echo .)com \
--cc=srabbelier@gmail$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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