| Message ID | e9a59108311369d8197b9870a8810d5283ec124f.1693584310.git.code@khaugsbakk.name (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | range-diff: treat notes like `log` | expand |
Hi Kristoffer, On Fri, 1 Sep 2023, 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. > > 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. Very well explained. The root cause for this is 8cf51561d1e (range-diff: fix a crash in parsing git-log output, 2020-04-15) which added the `--notes` argument in `read_patches()`' call. The commit message explains why this is needed: the (necessary) `--pretty=medium` would turn off the notes, therefore `--notes` had to be added to reinstate the original behavior (except, as you pointed out, in the case `--notes=<ref>` was specified). > 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`. This sounds a bit less desirable, though, than passing the `--notes` argument only as needed. This patch (on top of `notes-range-diff` in your fork) lets the new test still pass while leaving `--standard-notes` deprecated: -- snipsnap -- diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt index 8c982609c99..dc685be363a 100644 --- a/Documentation/pretty-options.txt +++ b/Documentation/pretty-options.txt @@ -88,6 +88,7 @@ being displayed. Examples: "--notes=foo" will show only notes from from "refs/notes/bar". --show-notes[=<ref>]:: +--[no-]standard-notes:: These options are deprecated. Use the above --notes/--no-notes options instead. endif::git-rev-list[] diff --git a/range-diff.c b/range-diff.c index f070e4a4ceb..fbb81a92cc0 100644 --- a/range-diff.c +++ b/range-diff.c @@ -41,12 +41,20 @@ static int read_patches(const char *range, struct string_list *list, struct child_process cp = CHILD_PROCESS_INIT; struct strbuf buf = STRBUF_INIT, contents = STRBUF_INIT; struct patch_util *util = NULL; - int in_header = 1; + int i, implicit_notes_arg = 1, in_header = 1; char *line, *current_filename = NULL; ssize_t len; size_t size; int ret = -1; + for (i = 0; other_arg && i < other_arg->nr; i++) + if (!strcmp(other_arg->v[i], "--notes") || + starts_with(other_arg->v[i], "--notes=") || + !strcmp(other_arg->v[i], "--no-notes")) { + implicit_notes_arg = 0; + break; + } + strvec_pushl(&cp.args, "log", "--no-color", "-p", "--no-merges", "--reverse", "--date-order", "--decorate=no", "--no-prefix", "--submodule=short", @@ -60,8 +68,9 @@ static int read_patches(const char *range, struct string_list *list, "--output-indicator-context=#", "--no-abbrev-commit", "--pretty=medium", - "--standard-notes", NULL); + if (implicit_notes_arg) + strvec_push(&cp.args, "--notes"); strvec_push(&cp.args, range); if (other_arg) strvec_pushv(&cp.args, other_arg->v); diff --git a/revision.c b/revision.c index 44a04004a70..2f4c53ea207 100644 --- a/revision.c +++ b/revision.c @@ -2495,13 +2495,9 @@ 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")) { - 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; + revs->show_notes_given = 1; + revs->notes_opt.use_default_notes = 1; } else if (!strcmp(arg, "--no-standard-notes")) { - /* Deprecated */ revs->notes_opt.use_default_notes = 0; } else if (!strcmp(arg, "--oneline")) { revs->verbose_header = 1;
Hi Dscho On Sun, Sep 3, 2023, at 14:17, Johannes Schindelin wrote: > Hi Kristoffer, > > On Fri, 1 Sep 2023, Kristoffer Haugsbakk wrote: > > > [snip] > > Very well explained. > > The root cause for this is 8cf51561d1e (range-diff: fix a crash in parsing > git-log output, 2020-04-15) which added the `--notes` argument in > `read_patches()`' call. The commit message explains why this is needed: > the (necessary) `--pretty=medium` would turn off the notes, therefore > `--notes` had to be added to reinstate the original behavior (except, as > you pointed out, in the case `--notes=<ref>` was specified). That's interesting. I didn't find that commit in my history spelunking. >> 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`. > > This sounds a bit less desirable, though, than passing the `--notes` > argument only as needed. This patch (on top of `notes-range-diff` in your > fork) lets the new test still pass while leaving `--standard-notes` > deprecated: > > [snip] I like it. I didn't like my solution but it was the only thing that I could get to work. I would like to use your solution instead. Thank you. Maybe you could supply a commit message for v3? v3 would then consist of two commits: 1. Your fix 2. Those two tests Or should it be handled in some other way? Cheers
Hi Kristoffer, On Mon, 4 Sep 2023, Kristoffer Haugsbakk wrote: > I would like to use your solution instead. Thank you. Please do! You're welcome. > Maybe you could supply a commit message for v3? v3 would then consist of > two commits: > > 1. Your fix > 2. Those two tests > > Or should it be handled in some other way? Personally, I'd prefer it if you just squashed the changes into your patch. If you want, I'd be delighted about a Helped-by (or even Co-authored-by) footer, but taking ownership would be fine with me, too. Ciao, Johannes
Johannes Schindelin <Johannes.Schindelin@gmx.de> writes: > Hi Kristoffer, > > On Mon, 4 Sep 2023, Kristoffer Haugsbakk wrote: > >> I would like to use your solution instead. Thank you. > > Please do! You're welcome. > >> Maybe you could supply a commit message for v3? v3 would then consist of >> two commits: >> >> 1. Your fix >> 2. Those two tests >> >> Or should it be handled in some other way? > > Personally, I'd prefer it if you just squashed the changes into your > patch. If you want, I'd be delighted about a Helped-by (or even > Co-authored-by) footer, but taking ownership would be fine with me, too. Sounds very sensible. Thanks, both. Will look forward to seeing an updated series.
diff --git a/range-diff.c b/range-diff.c index 2e86063491..f070e4a4ce 100644 --- a/range-diff.c +++ b/range-diff.c @@ -60,7 +60,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 2f4c53ea20..64aebc014b 100644 --- a/revision.c +++ b/revision.c @@ -2495,8 +2495,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(-)