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

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

From
Jeff King <peff@peff.net>
Date
Jun 1, 2023, 18:20 UTC
Message-ID
<20230601182020.GC4165405@coredump.intra.peff.net>
In-Reply-To
<8cc8eddfced1b64156008f7f923c430981d472af.1685441207.git.code@khaugsbakk.name>
On Tue, May 30, 2023 at 12:41:29PM +0200, Kristoffer Haugsbakk wrote:
Show 24 quoted lines
> 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.

Yeah, I certainly agree that the behavior of range-diff is surprising, and that this is a bug.

I'd have expected the solution here would be for range-diff to stop passing "--notes", and let "log" decide whether to show notes (based on specific --notes=foo it gets from other_arg).

But...
Show 10 quoted lines
> 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`.

I'm not clear on whether you're actually fixing two separate bugs here, or if they need to be intertwined.

It seems like passing --standard-notes means that format-patch's range-diff will still show the standard notes by default. Maybe I'm misunderstanding the problem, though.

-Peff
Previous: Kristoffer HaugsbakkNext: Kristoffer Haugsbakk
Message 3 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.