Re: [PATCH 2/2] notes: revert note_data.given behavior with empty notes add

From: Kristoffer Haugsbakk <code@khaugsbakk.name>
Date: Jul 25, 2024, 17:22 UTC
Message-ID: <ae5dc48b-07df-45ab-a3b7-4d5c27fdbfa2@app.fastmail.com>
In-Reply-To: <xmqqzfq5flfd.fsf@gitster.g>

On Thu, Jul 25, 2024, at 19:09, Junio C Hamano wrote:

Show 9 quoted lines

>> Fixes: 90bc19b3ae ("notes.c: introduce '--separator=<paragraph-break>' option")
>> Link: https://github.com/ddiss/icyci/issues/12
>
> We generally refrain from using these two trailers.  Please drop them.
>
> Especially "Fixes" claim can later prove incorrect (we thought this
> was a good fix when committing, but it later turned out to be a bad
> one), and besides you will be referring to the problematic commit in
> your proposed log message already anyway.

David, if you want to mention your downstream issue you can use a “footnote” in the commit message:

    With "git notes add -C $blob", the given blob contents are
    to be made into a note without involving an editor.  But
    when "--allow-empty" is given, the editor is invoked.[1]

    <rest of the commit message>

    [1] https://github.com/ddiss/icyci/issues/12

    Signed-off-by: …

This is widely practiced.

-- 
Kristoffer Haugsbakk