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

Re: branch description as a note?

From
Bence Ferdinandy <bence@ferdinandy.com>
Date
Dec 11, 2024, 21:57 UTC
Message-ID
<D697HA5ZDN2K.1I643FREX8WKC@ferdinandy.com>
In-Reply-To
<xmqq4j3ai4it.fsf@gitster.g>
On Wed Dec 11, 2024 at 17:11, Junio C Hamano <gitster@pobox.com> wrote:
Show 31 quoted lines
> "Bence Ferdinandy" <bence@ferdinandy.com> writes:
>
>> so I've been wondering about branch descriptions being just a local
>> configuration. The only use-case I know for them is generating cover letters
>> and request-pull, although I could imagine maybe the maintainer uses branch
>> descriptions for storing the - well - branch descriptions for the "What's
>> cooking" emails and the merge commit messages. 
>
> FWIW, that is not how I maintain "What's cooking".  Rather, the next
> issue os "What's cooking" is pretty much edited manually, plus a
> tool that notices when an existing topic advances in order to insert
> these "(merged to 'next' on such and such day)" lines and turn '-'
> bullets into '+', and move topics from other sections to 'graduated'
> section.  Especially when writing comments on a topic, being able to
> read about other topics (which may be related) and the list of titles
> helps a lot.
>
> There may be folks who find branch descriptions a useful way to keep
> a quick reminder about the branch.  I was also hoping it may be like
> so, but I seem to have failed to exploit it as a useful component in
> my workflow.
>
>> Now my problem with the description being a local configuration, is that
>> I often work on patches on two different computers. I can easily share my patch
>> notes with myself, but not the branch description. If these could be pushed and
>> fetched like a note, I think that would open up some other nice possibilities
>> as well, like having a standard place for MR/PR messages for forges, sharing
>> proposed merge commit messages, maybe other things.
>
> If this is about draft work, I would use an empty commit at the tip
> of the branch.

No, this is about storing some meta-info about a branch, somewhat similarly how you can store meta-info about a commit in a note.

Show 19 quoted lines
>
>> For my personal issue of sharing branch descriptions with myself, I could
>> probably just make up a convention for myself, say using refs/notes/branches,
>> but it would be nice to have this built in, instead of the local config branch
>> description.
>>
>> From usage perspective I could imagine a new `--branch` flag for notes, which
>> would tell `git notes` to operate on notes attached to branches instead of
>> specific commits, probably stored under refs/notes/branches by default. Maybe
>> add an `--edit-branch-note` to `git branch`. And of course have the option to
>> use this note instead of the description configuration wherever it makes sense.
>>
>> What do you think?
>
> The notes tree is a hashmap that uses object names as the key.  The
> point of a branch is that it can grow by accumulating new commits on
> it, or its commits rewritten with "rebase -i", and there are branches
> with more than one commit.  So to what commit on the branch would you
> hang such a note on?

Not to a commit, but to a branch. I mean I know a branch is just a reference to a specific commit, but in this case the mapping would be from the branch's _name_ to the note object.

-- 
bence.ferdinandy.com
Previous: Konstantin RyabitsevNext: Junio C Hamano
Message 7 of 16 in “branch description as a note?”
  1. Bence FerdinandyDec 11, 2024
  2. Junio C HamanoDec 11, 2024
  3. Konstantin RyabitsevDec 11, 2024
  4. Bence FerdinandyDec 11, 2024
  5. Junio C HamanoDec 12, 2024
  6. Konstantin RyabitsevDec 12, 2024
  7. Bence FerdinandyDec 11, 2024
  8. Junio C HamanoDec 12, 2024
  9. Bence FerdinandyDec 12, 2024
  10. Justin ToblerDec 11, 2024
  11. Bence FerdinandyDec 11, 2024
  12. Junio C HamanoDec 12, 2024
  13. Bence FerdinandyDec 12, 2024
  14. Kristoffer HaugsbakkDec 11, 2024
  15. Kristoffer HaugsbakkDec 11, 2024
  16. Oswald BuddenhagenDec 12, 2024

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.