git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v4 1/1] range-diff: treat notes like `log`

From
Kristoffer Haugsbakk <code@khaugsbakk.name>
Date
Sep 19, 2023, 19:44 UTC
Message-ID
<6ad470bd-207f-4735-9ab5-2da5010d9ef4@app.fastmail.com>
In-Reply-To
<xmqqled2ezfh.fsf@gitster.g>
On Tue, Sep 19, 2023, at 21:27, Junio C Hamano wrote:
Show 6 quoted lines
> 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!
Show 42 quoted lines
>
>>  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
Previous: Junio C HamanoNext: Junio C Hamano
Message 35 of 41 in “range-diff: treat notes like `log`”
  1. 0/3 range-diff: treat notes like `log`Kristoffer Haugsbakk, May 30, 2023
  2. 1/3 range-diff: treat notes like `log`Kristoffer Haugsbakk, May 30, 2023
  3. Jeff KingJun 1, 2023
  4. Kristoffer HaugsbakkJun 2, 2023
  5. 2/3 doc: pretty-options: remove documentation for deprecated optionsKristoffer Haugsbakk, May 30, 2023
  6. 3/3 revision: comment `--no-standard-notes` as deprecatedKristoffer Haugsbakk, May 30, 2023
  7. 0/3 range-diff: treat notes like `log`Kristoffer Haugsbakk, Jun 11, 2023
  8. 2/3 doc: pretty-options: remove documentation for deprecated optionsKristoffer Haugsbakk, Jun 11, 2023
  9. 3/3 revision: comment `--no-standard-notes` as deprecatedKristoffer Haugsbakk, Jun 11, 2023
  10. Junio C HamanoJun 12, 2023
  11. Kristoffer HaugsbakkJun 13, 2023
  12. 1/3 range-diff: treat notes like `log`Kristoffer Haugsbakk, Jun 11, 2023
  13. Junio C HamanoJun 12, 2023
  14. Kristoffer HaugsbakkJun 13, 2023
  15. 0/3 range-diff: treat notes like `log`Kristoffer Haugsbakk, Sep 1, 2023
  16. 1/3 range-diff: treat notes like `log`Kristoffer Haugsbakk, Sep 1, 2023
  17. Johannes SchindelinSep 3, 2023
  18. Kristoffer HaugsbakkSep 4, 2023
  19. Johannes SchindelinSep 5, 2023
  20. Junio C HamanoSep 5, 2023
  21. 2/3 doc: pretty-options: remove documentation for deprecated optionsKristoffer Haugsbakk, Sep 1, 2023
  22. 3/3 revision: comment `--no-standard-notes` as deprecatedKristoffer Haugsbakk, Sep 1, 2023
  23. 0/1 range-diff: treat notes like `log`Kristoffer Haugsbakk, Sep 10, 2023
  24. 1/1 range-diff: treat notes like `log`Kristoffer Haugsbakk, Sep 10, 2023
  25. Junio C HamanoSep 11, 2023
  26. Johannes SchindelinSep 14, 2023
  27. Junio C HamanoSep 14, 2023
  28. Kristoffer HaugsbakkSep 14, 2023
  29. Junio C HamanoSep 19, 2023
  30. Kristoffer HaugsbakkSep 19, 2023
  31. Johannes SchindelinSep 11, 2023
  32. 0/1 range-diff: treat notes like `log`Kristoffer Haugsbakk, Sep 19, 2023
  33. 1/1 range-diff: treat notes like `log`Kristoffer Haugsbakk, Sep 19, 2023
  34. Junio C HamanoSep 19, 2023
  35. Kristoffer HaugsbakkSep 19, 2023
  36. Junio C HamanoSep 19, 2023
  37. Kristoffer HaugsbakkSep 19, 2023
  38. Junio C HamanoSep 19, 2023
  39. 0/1 range-diff: treat notes like `log`Kristoffer Haugsbakk, Sep 19, 2023
  40. 1/1 range-diff: treat notes like `log`Kristoffer Haugsbakk, Sep 19, 2023
  41. Johannes SchindelinSep 21, 2023

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.