git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 0/6] Improve remote helper documentation

From
Max Horn <max@quendi.de>
Date
Dec 7, 2012, 21:41 UTC
Message-ID
<A6FF9929-74F8-4F2F-BA0B-1B1086D4E7F5@quendi.de>
In-Reply-To
<7v1uf1he6m.fsf@alter.siamese.dyndns.org>
On 07.12.2012, at 20:09, Junio C Hamano wrote:
Show 31 quoted lines
> Max Horn <max@quendi.de> writes:
> 
>> Various remote helper capabilities and commands were not
>> documented, in particular 'export', or documented in a misleading
>> way (e.g. 'for-push' was listed as a ref attribute understood by
>> git, which is not the case). This patch series changes that, and
>> also address some other things in the remote helper documentation
>> that I found jarring when reading through it.
>> 
>> Note that the description of export and (im|ex)port-marks probably can be
>> improved, and I hope that somebody who knows more about them
>> than me and/or is better at writing documentation will do just that.
>> But I felt it was better to provide something than to do nothing
>> and only complain, as I did previously on this subject ;-).
> 
> A second ping to people who have touched transport-helper.c,
> remote-testsvn.c, git-remote-testgit, and contrib/remote-helpers/ in
> the past 18 months for comments.  I've re-read the documentation
> updates myself and didn't find anything majorly objectionable.
> 
> Except for a minor nit in 6/6; I think "defined options" should be
> "defined attributes".
> 
>    --- a/Documentation/git-remote-helpers.txt
>    +++ b/Documentation/git-remote-helpers.txt
>    @@ -227,6 +227,8 @@ Support for this command is mandatory.
>            the name; unrecognized attributes are ignored. The list ends
>            with a blank line.
>     +
>    +See REF LIST ATTRIBUTES for a list of currently defined options.
>    ++
Indeed, my mistake. Dumb question since I am still not completely familiar with the procedures here: Would you just fix this yourself as you apply this, or is it better (or even required) that I reroll for this? (Of course if I ned to re-roll for other reasons, I'd fix this one as well).

Thanks, Max

Previous: Sverre RabbelierNext: Junio C Hamano
Message 13 of 16 in “Improve remote helper documentation”
  1. 0/6 Improve remote helper documentationMax Horn, Nov 27, 2012
  2. 1/6 Document invocation first, then input formatMax Horn, Nov 27, 2012
  3. 2/6 Document missing remote helper capabilitiesMax Horn, Nov 27, 2012
  4. 3/6 Fix grammarMax Horn, Nov 27, 2012
  5. Junio C HamanoNov 27, 2012
  6. Max HornNov 27, 2012
  7. Junio C HamanoNov 27, 2012
  8. 4/6 Rearrange the description of remote helper capabilitiesMax Horn, Nov 27, 2012
  9. 5/6 Make clearer which commands must be supported for which capabilitiesMax Horn, Nov 27, 2012
  10. 6/6 Remove 'for-push' from ref list attributes list, link to subsectionsMax Horn, Nov 27, 2012
  11. Junio C HamanoDec 7, 2012
  12. Sverre RabbelierDec 7, 2012
  13. Max HornDec 7, 2012
  14. Junio C HamanoDec 7, 2012
  15. Max HornDec 7, 2012
  16. Felipe ContrerasDec 12, 2012

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.