@matheusbsbs / matheus-bagliano / commits / 8b426c84f3

notes: do not trigger editor when adding an empty note

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, which can cause problems for non-interactive callers[1]. This behaviour started with 90bc19b3ae (notes.c: introduce '--separator=<paragraph-break>' option, 2023-05-27), which changed editor invocation logic to check for a zero length note_data buffer. Restore the original behaviour of "git note" that takes the contents given via the "-m", "-C", "-F" options without invoking an editor, by checking for any prior parameter callbacks, indicated by a non-zero note_data.msg_nr. Remove the now-unneeded note_data.given flag. Add a test for this regression by checking whether GIT_EDITOR is invoked alongside "git notes add -C $empty_blob --allow-empty" [1] https://github.com/ddiss/icyci/issues/12 Signed-off-by: David Disseldorp <ddiss@suse.de> [jc: enhanced the test with -m/-F options] Signed-off-by: Junio C Hamano <gitster@pobox.com>

David Disseldorp committed Jul 29, 2024 at 17:14 UTC 8b426c84f376657e1e10839f3f5dafd9ba99593d

2 files changed +20 -12

builtin/notes.c

+10 -12

@@ -114,7 +114,6 @@ struct note_msg {

114 };

115

116 struct note_data {

117 - int given;

117 int use_editor;

118 int stripspace;

119 char *edit_path;

@@ -193,7 +192,7 @@ static void write_commented_object(int fd, const struct object_id *object)

192 static void prepare_note_data(const struct object_id *object, struct note_data *d,

193 const struct object_id *old_note)

194 {

196 - if (d->use_editor || !d->given) {

195 + if (d->use_editor || !d->msg_nr) {

196 int fd;

197 struct strbuf buf = STRBUF_INIT;

198

@@ -201,7 +200,7 @@ static void prepare_note_data(const struct object_id *object, struct note_data *

200 d->edit_path = git_pathdup("NOTES_EDITMSG");

201 fd = xopen(d->edit_path, O_CREAT | O_TRUNC | O_WRONLY, 0600);

202

204 - if (d->given)

203 + if (d->msg_nr)

204 write_or_die(fd, d->buf.buf, d->buf.len);

205 else if (old_note)

206 copy_obj_to_fd(fd, old_note);

@@ -515,7 +514,6 @@ static int add(int argc, const char **argv, const char *prefix)

514

515 if (d.msg_nr)

516 concat_messages(&d);

518 - d.given = !!d.buf.len;

517

518 object_ref = argc > 1 ? argv[1] : "HEAD";

519

@@ -528,7 +526,7 @@ static int add(int argc, const char **argv, const char *prefix)

526 if (note) {

527 if (!force) {

528 free_notes(t);

531 - if (d.given) {

529 + if (d.msg_nr) {

530 free_note_data(&d);

531 return error(_("Cannot add notes. "

532 "Found existing notes for object %s. "

@@ -690,14 +688,14 @@ static int append_edit(int argc, const char **argv, const char *prefix)

688 usage_with_options(usage, options);

689 }

690

693 - if (d.msg_nr)

691 + if (d.msg_nr) {

692 concat_messages(&d);

695 - d.given = !!d.buf.len;

696 -

697 - if (d.given && edit)

698 - fprintf(stderr, _("The -m/-F/-c/-C options have been deprecated "

699 - "for the 'edit' subcommand.\n"

700 - "Please use 'git notes add -f -m/-F/-c/-C' instead.\n"));

693 + if (edit)

694 + fprintf(stderr, _("The -m/-F/-c/-C options have been "

695 + "deprecated for the 'edit' subcommand.\n"

696 + "Please use 'git notes add -f -m/-F/-c/-C' "

697 + "instead.\n"));

698 + }

699

700 object_ref = 1 < argc ? argv[1] : "HEAD";

701

t/t3301-notes.sh

+10

@@ -1557,4 +1557,14 @@ test_expect_success 'empty notes are displayed by git log' '

1557 test_cmp expect actual

1558 '

1559

1560 +test_expect_success 'empty notes do not invoke the editor' '

1561 + test_commit 18th &&

1562 + GIT_EDITOR="false" git notes add -C "$empty_blob" --allow-empty &&

1563 + git notes remove HEAD &&

1564 + GIT_EDITOR="false" git notes add -m "" --allow-empty &&

1565 + git notes remove HEAD &&

1566 + GIT_EDITOR="false" git notes add -F /dev/null --allow-empty &&

1567 + git notes remove HEAD

1568 +'

1569 +

1570 test_done