| Message ID | 8cc8eddfced1b64156008f7f923c430981d472af.1685441207.git.code@khaugsbakk.name (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | range-diff: treat notes like `log` | expand |
On Tue, May 30, 2023 at 12:41:29PM +0200, Kristoffer Haugsbakk wrote: > Currently, `range-diff` shows the default notes if no notes-related > arguments are given. This is also how `log` behaves. But unlike > `range-diff`, `log` does *not* show the default notes if > `--notes=<custom>` are given. In other words, this: > > git log --notes=custom > > is equivalent to this: > > git log --no-notes --notes=custom > > While: > > git range-diff --notes=custom > > acts like this: > > git log --notes --notes-custom > > This can’t be how the user expects `range-diff` to behave given that the > man page for `range diff` under `--[no-]notes[=<ref>]` says: > > > This flag is passed to the git log program (see git-log(1)) that > > generates the patches. Yeah, I certainly agree that the behavior of range-diff is surprising, and that this is a bug. I'd have expected the solution here would be for range-diff to stop passing "--notes", and let "log" decide whether to show notes (based on specific --notes=foo it gets from other_arg). But... > This behavior also affects `format-patch` since it uses `range-diff` for > the cover letter. Unlike `log`, though, `format-patch` is not supposed > to show the default notes if no notes-related arguments are given.[1] > But this promise is broken when the range-diff happens to have something > to say about the changes to the default notes, since that will be shown > in the cover letter. > > Remedy this by co-opting the `--standard-notes` option which has been > deprecated since ab18b2c0df[2] and which is currently only documented in > `pretty-options`. I'm not clear on whether you're actually fixing two separate bugs here, or if they need to be intertwined. It seems like passing --standard-notes means that format-patch's range-diff will still show the standard notes by default. Maybe I'm misunderstanding the problem, though. -Peff
Hi Peff! On Thu, Jun 1, 2023, at 20:20, Jeff King wrote: >> This can’t be how the user expects `range-diff` to behave given that the >> man page for `range diff` under `--[no-]notes[=<ref>]` says: >> >> > This flag is passed to the git log program (see git-log(1)) that >> > generates the patches. > > Yeah, I certainly agree that the behavior of range-diff is surprising, > and that this is a bug. > > I'd have expected the solution here would be for range-diff to stop > passing "--notes", and let "log" decide whether to show notes (based on > specific --notes=foo it gets from other_arg). I tried that (removing `--notes`) but it didn’t work out for me. I’d had hoped that `--notes` was just a holdover from a previous change that wasn’t needed any more, but it seems according to my testing that `range diff` needs to pass *some* notes-related argument to `log` in order for the test suite to pass. Thinking about it again now it doesn’t really make sense in the isolated case of `range-diff`. But maybe it’s needed in conjunction with `format-patch`. A relevant series is “range-diff: learn `--notes`” by Denton Liu (f3c7bfdde2 (Merge branch 'dl/range-diff-with-notes', 2019-12-05)).[1] On the commit before that merge, `range-diff.c` does not pass `--notes` to `log`. Denton describes the behavior in the first cover letter: > When I was using range-diff at $DAYJOB earlier, I realised that it > includes commit notes as part of the commit message comparison. So just like the default behavior of `log`. However, the next version (v2) is about teaching `range-diff` to pass notes down to `log`: > This patchset teaches range-diff and format-patch to pass `--notes` > options down to the `git log` machinery. This should make the > behaviour more configurable for users who either don't want notes to > be displayed or want multiple notes refs to be displayed. So apparently `range-diff` couldn’t pass on/down `--notes=<ref>` before that. That series also teaches `format-patch` to handle notes in 5b583e6a09 (format-patch: pass notes configuration to range-diff, 2019-11-20). [1] https://lore.kernel.org/git/cover.1574125554.git.liu.denton@gmail.com/ > > But... > >> This behavior also affects `format-patch` since it uses `range-diff` for >> the cover letter. Unlike `log`, though, `format-patch` is not supposed >> to show the default notes if no notes-related arguments are given.[1] >> But this promise is broken when the range-diff happens to have something >> to say about the changes to the default notes, since that will be shown >> in the cover letter. >> >> Remedy this by co-opting the `--standard-notes` option which has been >> deprecated since ab18b2c0df[2] and which is currently only documented in >> `pretty-options`. > > I'm not clear on whether you're actually fixing two separate bugs here, > or if they need to be intertwined. I guess it depends on your perspective. ;) I would say that they are so intertwined that fixing one also fixes the other. > It seems like passing --standard-notes means that format-patch's > range-diff will still show the standard notes by default. Maybe I'm > misunderstanding the problem, though. No, that should still work. See the test `format-patch --range-diff does not compare notes by default`. That kind of thing seems to be handled by `log.c:get_notes_args`; `--no-notes` is sent to `log` if no notes should be shown. Cheers
diff --git a/range-diff.c b/range-diff.c index 6a704e6f47..2c92af337f 100644 --- a/range-diff.c +++ b/range-diff.c @@ -59,7 +59,7 @@ static int read_patches(const char *range, struct string_list *list, "--output-indicator-context=#", "--no-abbrev-commit", "--pretty=medium", - "--notes", + "--standard-notes", NULL); strvec_push(&cp.args, range); if (other_arg) diff --git a/revision.c b/revision.c index b33cc1d106..a0ab7fb784 100644 --- a/revision.c +++ b/revision.c @@ -2524,8 +2524,11 @@ static int handle_revision_opt(struct rev_info *revs, int argc, const char **arg disable_display_notes(&revs->notes_opt, &revs->show_notes); revs->show_notes_given = 1; } else if (!strcmp(arg, "--standard-notes")) { - revs->show_notes_given = 1; - revs->notes_opt.use_default_notes = 1; + disable_display_notes(&revs->notes_opt, &revs->show_notes); + revs->show_notes_given = 0; + enable_default_display_notes(&revs->notes_opt, + &revs->show_notes); + revs->notes_opt.use_default_notes = -1; } else if (!strcmp(arg, "--no-standard-notes")) { revs->notes_opt.use_default_notes = 0; } else if (!strcmp(arg, "--oneline")) { diff --git a/t/t3206-range-diff.sh b/t/t3206-range-diff.sh index b5f4d6a653..b33afa1c6a 100755 --- a/t/t3206-range-diff.sh +++ b/t/t3206-range-diff.sh @@ -662,6 +662,20 @@ test_expect_success 'range-diff with multiple --notes' ' test_cmp expect actual ' +# `range-diff` should act like `log` with regards to notes +test_expect_success 'range-diff with --notes=custom does not show default notes' ' + git notes add -m "topic note" topic && + git notes add -m "unmodified note" unmodified && + git notes --ref=custom add -m "topic note" topic && + git notes --ref=custom add -m "unmodified note" unmodified && + test_when_finished git notes remove topic unmodified && + test_when_finished git notes --ref=custom remove topic unmodified && + git range-diff --notes=custom main..topic main..unmodified \ + >actual && + ! grep "## Notes ##" actual && + grep "## Notes (custom) ##" actual +' + test_expect_success 'format-patch --range-diff does not compare notes by default' ' git notes add -m "topic note" topic && git notes add -m "unmodified note" unmodified && @@ -679,6 +693,20 @@ test_expect_success 'format-patch --range-diff does not compare notes by default ! grep "note" 0000-* ' +test_expect_success 'format-patch --notes=custom --range-diff only compares custom notes' ' + git notes add -m "topic note" topic && + git notes --ref=custom add -m "topic note (custom)" topic && + git notes add -m "unmodified note" unmodified && + git notes --ref=custom add -m "unmodified note (custom)" unmodified && + test_when_finished git notes remove topic unmodified && + test_when_finished git notes --ref=custom remove topic unmodified && + git format-patch --notes=custom --cover-letter --range-diff=$prev \ + main..unmodified >actual && + test_when_finished "rm 000?-*" && + grep "## Notes (custom) ##" 0000-* && + ! grep "## Notes ##" 0000-* +' + test_expect_success 'format-patch --range-diff with --no-notes' ' git notes add -m "topic note" topic && git notes add -m "unmodified note" unmodified &&
Currently, `range-diff` shows the default notes if no notes-related arguments are given. This is also how `log` behaves. But unlike `range-diff`, `log` does *not* show the default notes if `--notes=<custom>` are given. In other words, this: git log --notes=custom is equivalent to this: git log --no-notes --notes=custom While: git range-diff --notes=custom acts like this: git log --notes --notes-custom This can’t be how the user expects `range-diff` to behave given that the man page for `range diff` under `--[no-]notes[=<ref>]` says: > This flag is passed to the git log program (see git-log(1)) that > generates the patches. This behavior also affects `format-patch` since it uses `range-diff` for the cover letter. Unlike `log`, though, `format-patch` is not supposed to show the default notes if no notes-related arguments are given.[1] But this promise is broken when the range-diff happens to have something to say about the changes to the default notes, since that will be shown in the cover letter. Remedy this by co-opting the `--standard-notes` option which has been deprecated since ab18b2c0df[2] and which is currently only documented in `pretty-options`. † 1: See e.g. 66b2ed09c2 (Fix "log" family not to be too agressive about showing notes, 2010-01-20). † 2: log/pretty-options: Document --[no-]notes and deprecate old notes options, 2011-03-30 Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name> --- range-diff.c | 2 +- revision.c | 7 +++++-- t/t3206-range-diff.sh | 28 ++++++++++++++++++++++++++++ 3 files changed, 34 insertions(+), 3 deletions(-)