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

[PATCH v2 0/6] Improve remote helper documentation

From
Max Horn <max@quendi.de>
Date
Nov 27, 2012, 23:03 UTC
Message-ID
<1354057407-83151-1-git-send-email-max@quendi.de>

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 ;-).

Max Horn (6):
  git-remote-helpers.txt: document invocation before input format
  git-remote-helpers.txt: document missing capabilities
  git-remote-helpers.txt: minor grammar fix
  git-remote-helpers.txt: rearrange description of capabilities
  git-remote-helpers.txt: clarify command <-> capability correspondences
  git-remote-helpers.txt: clarify options & ref list attributes
 Documentation/git-remote-helpers.txt | 245 ++++++++++++++++++++---------------
 1 file changed, 140 insertions(+), 105 deletions(-)
-- 
1.8.0.393.gcc9701d
Next: Max Horn
Message 1 of 16 in “Improve remote helper documentation”
  1. 0/6 Improve remote helper documentationMax Horn, Nov 27, 2012
  2. 1/6 git-remote-helpers.txt: document invocation before input formatMax Horn, Nov 27, 2012
  3. Felipe ContrerasDec 12, 2012
  4. Max HornDec 12, 2012
  5. Felipe ContrerasDec 12, 2012
  6. Max HornDec 12, 2012
  7. Junio C HamanoDec 12, 2012
  8. Max HornDec 12, 2012
  9. Junio C HamanoDec 12, 2012
  10. 2/6 git-remote-helpers.txt: document missing capabilitiesMax Horn, Nov 27, 2012
  11. 3/6 git-remote-helpers.txt: minor grammar fixMax Horn, Nov 27, 2012
  12. 4/6 git-remote-helpers.txt: rearrange description of capabilitiesMax Horn, Nov 27, 2012
  13. 5/6 git-remote-helpers.txt: clarify command <-> capability correspondencesMax Horn, Nov 27, 2012
  14. 6/6 git-remote-helpers.txt: clarify options & ref list attributesMax Horn, Nov 27, 2012
  15. 6/6 git-remote-helpers.txt: clarify ref list attributes, link to subsectionsMax Horn, Nov 27, 2012
  16. Max HornNov 27, 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.