From: Junio C Hamano <gitster@pobox.com>
To: Kristoffer Haugsbakk <code@khaugsbakk.name>
Cc: git@vger.kernel.org,
Johannes Schindelin <johannes.schindelin@gmx.de>,
Denton Liu <liu.denton@gmail.com>, Jeff King <peff@peff.net>
Subject: Re: [PATCH v4 1/1] range-diff: treat notes like `log`
Date: Tue, 19 Sep 2023 12:27:30 -0700 [thread overview]
Message-ID: <xmqqled2ezfh.fsf@gitster.g> (raw)
In-Reply-To: <244e102cc4693bb6291e03cffea6df05cdb29df3.1695144790.git.code@khaugsbakk.name> (Kristoffer Haugsbakk's message of "Tue, 19 Sep 2023 20:05:32 +0200")
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.
next prev parent reply other threads:[~2023-09-19 19:27 UTC|newest]
Thread overview: 41+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-30 10:41 [RFC PATCH 0/3] range-diff: treat notes like `log` Kristoffer Haugsbakk
2023-05-30 10:41 ` [RFC PATCH 1/3] " Kristoffer Haugsbakk
2023-06-01 18:20 ` Jeff King
2023-06-02 10:06 ` Kristoffer Haugsbakk
2023-05-30 10:41 ` [RFC PATCH 2/3] doc: pretty-options: remove documentation for deprecated options Kristoffer Haugsbakk
2023-05-30 10:41 ` [RFC PATCH 3/3] revision: comment `--no-standard-notes` as deprecated Kristoffer Haugsbakk
2023-06-11 18:15 ` [PATCH v1 0/3] range-diff: treat notes like `log` Kristoffer Haugsbakk
2023-06-11 18:15 ` [PATCH v1 1/3] " Kristoffer Haugsbakk
2023-06-11 18:15 ` [PATCH v1 2/3] doc: pretty-options: remove documentation for deprecated options Kristoffer Haugsbakk
2023-06-11 18:15 ` [PATCH v1 3/3] revision: comment `--no-standard-notes` as deprecated Kristoffer Haugsbakk
2023-06-12 22:21 ` Junio C Hamano
2023-06-13 9:46 ` Kristoffer Haugsbakk
2023-06-12 22:25 ` [PATCH v1 0/3] range-diff: treat notes like `log` Junio C Hamano
2023-06-13 5:43 ` Kristoffer Haugsbakk
2023-09-01 16:18 ` [PATCH v2 " Kristoffer Haugsbakk
2023-09-01 16:19 ` [PATCH v2 1/3] " Kristoffer Haugsbakk
2023-09-03 12:17 ` Johannes Schindelin
2023-09-04 17:10 ` Kristoffer Haugsbakk
2023-09-05 10:56 ` Johannes Schindelin
2023-09-05 22:19 ` Junio C Hamano
2023-09-01 16:19 ` [PATCH v2 2/3] doc: pretty-options: remove documentation for deprecated options Kristoffer Haugsbakk
2023-09-01 16:19 ` [PATCH v2 3/3] revision: comment `--no-standard-notes` as deprecated Kristoffer Haugsbakk
2023-09-10 22:06 ` [PATCH v3 0/1] range-diff: treat notes like `log` Kristoffer Haugsbakk
2023-09-10 22:06 ` [PATCH v3 1/1] " Kristoffer Haugsbakk
2023-09-11 19:55 ` Junio C Hamano
2023-09-14 8:29 ` Johannes Schindelin
2023-09-14 16:18 ` Junio C Hamano
2023-09-14 20:25 ` Kristoffer Haugsbakk
2023-09-19 1:16 ` Junio C Hamano
2023-09-19 9:12 ` Kristoffer Haugsbakk
2023-09-11 13:23 ` [PATCH v3 0/1] " Johannes Schindelin
2023-09-19 18:05 ` [PATCH v4 " Kristoffer Haugsbakk
2023-09-19 18:05 ` [PATCH v4 1/1] " Kristoffer Haugsbakk
2023-09-19 19:27 ` Junio C Hamano [this message]
2023-09-19 19:44 ` Kristoffer Haugsbakk
2023-09-19 19:51 ` Junio C Hamano
2023-09-19 19:27 ` Kristoffer Haugsbakk
2023-09-19 19:43 ` Junio C Hamano
2023-09-19 20:26 ` [PATCH v5 0/1] " Kristoffer Haugsbakk
2023-09-19 20:26 ` [PATCH v5 1/1] " Kristoffer Haugsbakk
2023-09-21 12:30 ` Johannes Schindelin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqled2ezfh.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=code@khaugsbakk.name \
--cc=git@vger.kernel.org \
--cc=johannes.schindelin@gmx.de \
--cc=liu.denton@gmail.com \
--cc=peff@peff.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).