Documentating branches (was: nicer frontend to get rebased tree?)
From: Marius Vollmer <hidden>
Date: 2016-06-15 22:45:13
Linus Torvalds [off-list ref] 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.