| Message ID | 244e102cc4693bb6291e03cffea6df05cdb29df3.1695144790.git.code@khaugsbakk.name (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | range-diff: treat notes like `log` | expand |
Kristoffer Haugsbakk <code@khaugsbakk.name> writes: > 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 introducing `--show-notes-by-default` that `range-diff` can > use to tell the `log` subprocess what to do. Very well described. I think the rest of the proposed log message is redundant now we have quite a good write-up above. > ifndef::git-rev-list[] > +--show-notes-by-default:: > + Show the default notes (see `--notes`) unless subsequent arguments > + are used to display specific notes. > + > --notes[=<ref>]:: > Show the notes (see linkgit:git-notes[1]) that annotate the > commit, when showing the commit log message. This is the default I think the new entry should come after the description of `--notes`, which is the primary option around the "notes" feature. In the description, I think "subsequent" is misphrased. It makes it sound as if $ git log --show-notes-by-default --notes=amlog would stop showing the notes from the default notes tree (because the notes from the .git/refs/notes/amlog is explicitly asked for), while $ git log --notes=amlog --show-notes-by-default would show both the default and the custom notes, which is not what the code does, I think, in this hunk: > @@ -3054,6 +3056,11 @@ int setup_revisions(int argc, const char **argv, struct rev_info *revs, struct s > if (revs->expand_tabs_in_log < 0) > revs->expand_tabs_in_log = revs->expand_tabs_in_log_default; > > + if (!revs->show_notes_given && revs->show_notes_by_default) { > + enable_default_display_notes(&revs->notes_opt, &revs->show_notes); > + revs->show_notes_given = 1; > + } > + > return left; > } Other than the above minor nits, looks very good. Thanks.
The original CI failed.[1] Then I rebased on `master` (d4a83d07b8c (The tenth batch, 2023-09-18)) which also failed.[2] Problem in t5559. So: fair warning. :) [1] https://github.com/LemmingAvalanche/git/actions/runs/6238806624 [2] https://github.com/LemmingAvalanche/git/actions/runs/6239585493
"Kristoffer Haugsbakk" <code@khaugsbakk.name> writes: > The original CI failed.[1] Then I rebased on `master` (d4a83d07b8c (The > tenth batch, 2023-09-18)) which also failed.[2] Problem in t5559. > > So: fair warning. :) > > [1] https://github.com/LemmingAvalanche/git/actions/runs/6238806624 > [2] https://github.com/LemmingAvalanche/git/actions/runs/6239585493 I think you can ignore these macOS ones that spew == Info: [HTTP/2] [1] ... in the log. The adjustments necessary for the redaction code to deal with these new messages from cURL are known and are cooking.
On Tue, Sep 19, 2023, at 21:27, Junio C Hamano wrote: > Kristoffer Haugsbakk <code@khaugsbakk.name> writes: > >> [snip] > > Very well described. I think the rest of the proposed log message > is redundant now we have quite a good write-up above. Thanks! > >> ifndef::git-rev-list[] >> +--show-notes-by-default:: >> + Show the default notes (see `--notes`) unless subsequent arguments >> + are used to display specific notes. >> + >> --notes[=<ref>]:: >> Show the notes (see linkgit:git-notes[1]) that annotate the >> commit, when showing the commit log message. This is the default > > I think the new entry should come after the description of `--notes`, > which is the primary option around the "notes" feature. > > In the description, I think "subsequent" is misphrased. It makes it > sound as if > > $ git log --show-notes-by-default --notes=amlog > > would stop showing the notes from the default notes tree (because > the notes from the .git/refs/notes/amlog is explicitly asked for), > while > > $ git log --notes=amlog --show-notes-by-default > > would show both the default and the custom notes, which is not what > the code does, I think, in this hunk: > >> @@ -3054,6 +3056,11 @@ int setup_revisions(int argc, const char **argv, struct rev_info *revs, struct s >> if (revs->expand_tabs_in_log < 0) >> revs->expand_tabs_in_log = revs->expand_tabs_in_log_default; >> >> + if (!revs->show_notes_given && revs->show_notes_by_default) { >> + enable_default_display_notes(&revs->notes_opt, &revs->show_notes); >> + revs->show_notes_given = 1; >> + } >> + >> return left; >> } > > Other than the above minor nits, looks very good. > > Thanks. Okay I think I understand. With that in mind I would change it to the patch below. I can make a new version if that looks okay. -- >8 -- diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt index dcd501ee505..d2df1aad647 100644 --- a/Documentation/pretty-options.txt +++ b/Documentation/pretty-options.txt @@ -59,10 +59,6 @@ message by 4 spaces (i.e. 'medium', which is the default, 'full', and 'fuller'). ifndef::git-rev-list[] ---show-notes-by-default:: - Show the default notes (see `--notes`) unless subsequent arguments - are used to display specific notes. - --notes[=<ref>]:: Show the notes (see linkgit:git-notes[1]) that annotate the commit, when showing the commit log message. This is the default @@ -91,6 +87,10 @@ being displayed. Examples: "--notes=foo" will show only notes from "--notes --notes=foo --no-notes --notes=bar" will only show notes from "refs/notes/bar". +--show-notes-by-default:: + Show the default notes unless arguments are given for displaying + specific notes. + --show-notes[=<ref>]:: --[no-]standard-notes:: These options are deprecated. Use the above --notes/--no-notes
"Kristoffer Haugsbakk" <code@khaugsbakk.name> writes: > Okay I think I understand. With that in mind I would change it to the > patch below. > > I can make a new version if that looks okay. Looking good, although I would say "unless other options are given" ("other" is optional) instead of "arguments" if I were writing this. Thanks.
diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt index dc685be363..dcd501ee50 100644 --- a/Documentation/pretty-options.txt +++ b/Documentation/pretty-options.txt @@ -59,6 +59,10 @@ message by 4 spaces (i.e. 'medium', which is the default, 'full', and 'fuller'). ifndef::git-rev-list[] +--show-notes-by-default:: + Show the default notes (see `--notes`) unless subsequent arguments + are used to display specific notes. + --notes[=<ref>]:: Show the notes (see linkgit:git-notes[1]) that annotate the commit, when showing the commit log message. This is the default diff --git a/range-diff.c b/range-diff.c index 2e86063491..56f6870ff9 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", + "--show-notes-by-default", NULL); strvec_push(&cp.args, range); if (other_arg) diff --git a/revision.c b/revision.c index 2f4c53ea20..49d385257a 100644 --- a/revision.c +++ b/revision.c @@ -2484,6 +2484,8 @@ static int handle_revision_opt(struct rev_info *revs, int argc, const char **arg revs->break_bar = xstrdup(optarg); revs->track_linear = 1; revs->track_first_time = 1; + } else if (!strcmp(arg, "--show-notes-by-default")) { + revs->show_notes_by_default = 1; } else if (skip_prefix(arg, "--show-notes=", &optarg) || skip_prefix(arg, "--notes=", &optarg)) { if (starts_with(arg, "--show-notes=") && @@ -3054,6 +3056,11 @@ int setup_revisions(int argc, const char **argv, struct rev_info *revs, struct s if (revs->expand_tabs_in_log < 0) revs->expand_tabs_in_log = revs->expand_tabs_in_log_default; + if (!revs->show_notes_given && revs->show_notes_by_default) { + enable_default_display_notes(&revs->notes_opt, &revs->show_notes); + revs->show_notes_given = 1; + } + return left; } diff --git a/revision.h b/revision.h index 82ab400139..50091bbd13 100644 --- a/revision.h +++ b/revision.h @@ -253,6 +253,7 @@ struct rev_info { shown_dashes:1, show_merge:1, show_notes_given:1, + show_notes_by_default:1, show_signature:1, pretty_given:1, abbrev_commit:1, 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 introducing `--show-notes-by-default` that `range-diff` can use to tell the `log` subprocess what to do. § Root cause 8cf51561d1e (range-diff: fix a crash in parsing git-log output, 2020-04-15) added `--notes` in order to deal with a side-effect of `--pretty=medium`: > To fix this explicitly set the output format of the internally executed > `git log` with `--pretty=medium`. Because that cancels `--notes`, add > explicitly `--notes` at the end. § Authors • Fix by Johannes • Tests by Kristoffer † 1: See e.g. 66b2ed09c2 (Fix "log" family not to be too agressive about showing notes, 2010-01-20). Co-authored-by: Johannes Schindelin <Johannes.Schindelin@gmx.de> Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name> --- Documentation/pretty-options.txt | 4 ++++ range-diff.c | 2 +- revision.c | 7 +++++++ revision.h | 1 + t/t3206-range-diff.sh | 28 ++++++++++++++++++++++++++++ 5 files changed, 41 insertions(+), 1 deletion(-)