Re: [PATCH v4 3/5] notes.c: drop unreachable code in 'append_edit()'
- From
Eric Sunshine <sunshine@sunshineco.com>
- Date
- Jan 15, 2023, 20:59 UTC
- Message-ID
- <CAPig+cR5s3XzmY+L_jDW2g_PEgi5E791x0GuV+VPkxFA_6sB7A@mail.gmail.com>
- In-Reply-To
- <7b756b4c605e148f6938fee74882091661382173.1673490953.git.dyroneteng@gmail.com>
On Wed, Jan 11, 2023 at 9:48 PM Teng Long <dyroneteng@gmail.com> wrote:
Show 25 quoted lines
> Situation of note "removing" shouldn't happen in 'append_edit()',
> unless it's a bug. So, let's drop the unreachable "else" code
> in "append_edit()".
>
> The notes operation "append" is different with "add", the latter
> supports to overwrite the existing note then let the "removing"
> happen (e.g. execute `git notes add -f -F /dev/null` on an existing
> note), but the former will not because it only does "appends" but
> not doing "overwrites".
>
> Signed-off-by: Teng Long <dyroneteng@gmail.com>
> ---
> diff --git a/builtin/notes.c b/builtin/notes.c
> @@ -630,13 +630,8 @@ static int append_edit(int argc, const char **argv, const char *prefix)
> if (add_note(t, &object, &new_note, combine_notes_overwrite))
> BUG("combine_notes_overwrite failed");
> logmsg = xstrfmt("Notes added by 'git notes %s'", argv[0]);
> - } else {
> - fprintf(stderr, _("Removing note for object %s\n"),
> - oid_to_hex(&object));
> - remove_note(t, object.hash);
> - logmsg = xstrfmt("Notes removed by 'git notes %s'", argv[0]);
> + commit_notes(the_repository, t, logmsg);
> }
> - commit_notes(the_repository, t, logmsg);This change breaks removal of notes using "git notes edit". Prior to this change, if you delete the content of a note using "git notes edit", then the note is removed. Following this change, the note remains, which contradicts documented[1] behavior.
[1]: Unfortunately, perhaps, this behavior is documented under the "remove" subcommand rather than the "edit" subcommand, but it is nevertheless documented and has worked this way for ages, so this patch causes a regression.