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

Documentating branches (was: nicer frontend to get rebased tree?)

From
MVMarius Vollmer <marius.vollmer@uni-dortmund.de>
Date
Aug 23, 2008, 21:38 UTC
Message-ID
<87k5e7fm3q.fsf_-_@uni-dortmund.de>
In-Reply-To
<alpine.LFD.1.10.0808231152250.3363@nehalem.linux-foundation.org>
Linus Torvalds <torvalds@linux-foundation.org> writes:
> So part of it is not even necessarily about _git_ documentation, but about 
> the documentation for some of the trees that use git, but that aren't 
> really meant for others to then use. 
Incidentally, can Git attach random blurbs to branches?

I know that gitweb uses ".git/description" to describe the whole repository. Is there a way I can add descriptions for individual branches?

Junio periodically posts "A note from the maintainer" that explains how the Git repository is structured and what each of the branches is for. It would good if this information could be found in a standard location in the repository itself.

Putting a README or HACKING (or MaintNote) file in the project sources itself doesn't seem right, since the sources can be offered from many repositories, each with their own way of doing things.

One could extend the .git/description convention to .git/descriptions/refs/heads/master, say, and gitweb would put that next to the link for master.

But what about putting this information into proper objects, so that we have the goodness of git to handle it. There could be a head called "README", and gitweb (and everybody else) could look there for blurbs.

A simple convention should suffice, and maybe there is already one that I just don't know about. No changes to Git are needed. But implementing it in gitweb would both be useful and would help people finding them.

Previous: Björn SteinbrinkNext: Miklos Vajna
Message 22 of 42 in “nicer frontend to get rebased tree?”
  1. Andi KleenAug 22, 2008
  2. Linus TorvaldsAug 22, 2008
  3. Andi KleenAug 22, 2008
  4. Linus TorvaldsAug 22, 2008
  5. Paolo CiarrocchiAug 22, 2008
  6. Linus TorvaldsAug 22, 2008
  7. Björn SteinbrinkAug 22, 2008
  8. Paolo CiarrocchiAug 22, 2008
  9. Linus TorvaldsAug 22, 2008
  10. Junio C HamanoAug 22, 2008
  11. Andi KleenAug 23, 2008
  12. Paolo BonziniAug 23, 2008
  13. Andi KleenAug 23, 2008
  14. Paolo BonziniAug 23, 2008
  15. Linus TorvaldsAug 23, 2008
  16. Andi KleenAug 23, 2008
  17. Linus TorvaldsAug 23, 2008
  18. Ingo MolnarAug 25, 2008
  19. Björn SteinbrinkAug 23, 2008
  20. Linus TorvaldsAug 23, 2008
  21. Björn SteinbrinkAug 23, 2008
  22. Documentating branches (was: nicer frontend to get rebased tree?)Marius Vollmer, Aug 23, 2008
  23. Miklos VajnaAug 23, 2008
  24. Marius VollmerAug 23, 2008
  25. Marius VollmerAug 23, 2008
  26. Avery PennarunAug 22, 2008
  27. Andi KleenAug 22, 2008
  28. Paolo CiarrocchiAug 22, 2008
  29. Jakub NarebskiAug 22, 2008
  30. Andi KleenAug 23, 2008
  31. Paolo CiarrocchiAug 23, 2008
  32. Jakub NarebskiAug 23, 2008
  33. Andi KleenAug 23, 2008
  34. Paolo CiarrocchiAug 23, 2008
  35. Linus TorvaldsAug 23, 2008
  36. Paolo CiarrocchiAug 23, 2008
  37. Björn SteinbrinkAug 23, 2008
  38. Junio C HamanoAug 24, 2008
  39. Jakub NarebskiAug 23, 2008
  40. Theodore TsoAug 23, 2008
  41. A proposed solution (Was: nicer frontend to get rebased tree?)Theodore Tso, Aug 23, 2008
  42. Mikael MagnussonAug 22, 2008

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.