@matheusbsbs / matheus-bagliano / commits / 2e0d30d928

range-diff: treat notes like `log`

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. § 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> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Kristoffer Haugsbakk committed Sep 19, 2023 at 22:26 UTC 2e0d30d928dbb8899ebae749ceeb257e634d57f7
5 files changed +41 -1
Documentation/pretty-options.txt
+4
@@ -87,6 +87,10 @@ being displayed. Examples: "--notes=foo" will show only notes from
87 "--notes --notes=foo --no-notes --notes=bar" will only show notes
88 from "refs/notes/bar".
89
90 +--show-notes-by-default::
91 + Show the default notes unless options for displaying specific
92 + notes are given.
93 +
94 --show-notes[=<ref>]::
95 --[no-]standard-notes::
96 These options are deprecated. Use the above --notes/--no-notes
range-diff.c
+1 -1
@@ -60,7 +60,7 @@ static int read_patches(const char *range, struct string_list *list,
60 "--output-indicator-context=#",
61 "--no-abbrev-commit",
62 "--pretty=medium",
63 - "--notes",
63 + "--show-notes-by-default",
64 NULL);
65 strvec_push(&cp.args, range);
66 if (other_arg)
revision.c
+7
@@ -2484,6 +2484,8 @@ static int handle_revision_opt(struct rev_info *revs, int argc, const char **arg
2484 revs->break_bar = xstrdup(optarg);
2485 revs->track_linear = 1;
2486 revs->track_first_time = 1;
2487 + } else if (!strcmp(arg, "--show-notes-by-default")) {
2488 + revs->show_notes_by_default = 1;
2489 } else if (skip_prefix(arg, "--show-notes=", &optarg) ||
2490 skip_prefix(arg, "--notes=", &optarg)) {
2491 if (starts_with(arg, "--show-notes=") &&
@@ -3054,6 +3056,11 @@ int setup_revisions(int argc, const char **argv, struct rev_info *revs, struct s
3056 if (revs->expand_tabs_in_log < 0)
3057 revs->expand_tabs_in_log = revs->expand_tabs_in_log_default;
3058
3059 + if (!revs->show_notes_given && revs->show_notes_by_default) {
3060 + enable_default_display_notes(&revs->notes_opt, &revs->show_notes);
3061 + revs->show_notes_given = 1;
3062 + }
3063 +
3064 return left;
3065 }
3066
revision.h
+1
@@ -253,6 +253,7 @@ struct rev_info {
253 shown_dashes:1,
254 show_merge:1,
255 show_notes_given:1,
256 + show_notes_by_default:1,
257 show_signature:1,
258 pretty_given:1,
259 abbrev_commit:1,
t/t3206-range-diff.sh
+28
@@ -662,6 +662,20 @@ test_expect_success 'range-diff with multiple --notes' '
662 test_cmp expect actual
663 '
664
665 +# `range-diff` should act like `log` with regards to notes
666 +test_expect_success 'range-diff with --notes=custom does not show default notes' '
667 + git notes add -m "topic note" topic &&
668 + git notes add -m "unmodified note" unmodified &&
669 + git notes --ref=custom add -m "topic note" topic &&
670 + git notes --ref=custom add -m "unmodified note" unmodified &&
671 + test_when_finished git notes remove topic unmodified &&
672 + test_when_finished git notes --ref=custom remove topic unmodified &&
673 + git range-diff --notes=custom main..topic main..unmodified \
674 + >actual &&
675 + ! grep "## Notes ##" actual &&
676 + grep "## Notes (custom) ##" actual
677 +'
678 +
679 test_expect_success 'format-patch --range-diff does not compare notes by default' '
680 git notes add -m "topic note" topic &&
681 git notes add -m "unmodified note" unmodified &&
@@ -679,6 +693,20 @@ test_expect_success 'format-patch --range-diff does not compare notes by default
693 ! grep "note" 0000-*
694 '
695
696 +test_expect_success 'format-patch --notes=custom --range-diff only compares custom notes' '
697 + git notes add -m "topic note" topic &&
698 + git notes --ref=custom add -m "topic note (custom)" topic &&
699 + git notes add -m "unmodified note" unmodified &&
700 + git notes --ref=custom add -m "unmodified note (custom)" unmodified &&
701 + test_when_finished git notes remove topic unmodified &&
702 + test_when_finished git notes --ref=custom remove topic unmodified &&
703 + git format-patch --notes=custom --cover-letter --range-diff=$prev \
704 + main..unmodified >actual &&
705 + test_when_finished "rm 000?-*" &&
706 + grep "## Notes (custom) ##" 0000-* &&
707 + ! grep "## Notes ##" 0000-*
708 +'
709 +
710 test_expect_success 'format-patch --range-diff with --no-notes' '
711 git notes add -m "topic note" topic &&
712 git notes add -m "unmodified note" unmodified &&