[v5,0/1] range-diff: treat notes like `log`

Message

Kristoffer Haugsbakk Sept. 19, 2023, 8:26 p.m. UTC

Hi

See the previous cover letter for context.

§ Changes since version 4

• Remove “Root cause” section from commit message
• Doc change according to feedback

Kristoffer Haugsbakk (1):
  range-diff: treat notes like `log`

 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(-)

Range-diff against v4:
1:  244e102cc46 ! 1:  6e114271a2e range-diff: treat notes like `log`
    @@ Commit message
         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
    @@ Commit message
         Signed-off-by: Kristoffer Haugsbakk <[e-mail]>

      ## Documentation/pretty-options.txt ##
    -@@ Documentation/pretty-options.txt: message by 4 spaces (i.e.  'medium', which is the default, 'full',
    - and 'fuller').
    +@@ Documentation/pretty-options.txt: 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".

    - ifndef::git-rev-list[]
     +--show-notes-by-default::
    -+	Show the default notes (see `--notes`) unless subsequent arguments
    -+	are used to display specific notes.
    ++	Show the default notes unless options for displaying specific
    ++	notes are given.
     +
    - --notes[=<ref>]::
    - 	Show the notes (see linkgit:git-notes[1]) that annotate the
    - 	commit, when showing the commit log message.  This is the default
    + --show-notes[=<ref>]::
    + --[no-]standard-notes::
    + 	These options are deprecated. Use the above --notes/--no-notes

      ## range-diff.c ##
     @@ range-diff.c: static int read_patches(const char *range, struct string_list *list,
--
2.42.0