While I was working on [1] I found that the doc for the struct `display_notes_opt` hadn’t been updated when one of the members were renamed. I chose to post a separate patch/series. [1] https://lore.kernel.org/git/cover.1685441207.git.code@xxxxxxxxxxxxxxx § Changes in v3 by patch • 1: change initial “else” to “otherwise” • 1. tweak commit message • 2: New: move documentation to struct definition Kristoffer Haugsbakk (2): notes: update documentation for `use_default_notes` notes: move the documentation to the struct notes.h | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) Range-diff against v2: 1: 3c757bcb3d ! 1: 3eaa725d3a notes: update documentation for `use_default_notes` @@ Commit message 2011-03-29). The commit message says that “values less than one [indicates] “not - set” ”, but I think what was meant was “less than zero”. + set” ”, but what was meant was probably “less than zero” (the author of + 3a03cf6b1d agrees on this point). Signed-off-by: Kristoffer Haugsbakk <code@xxxxxxxxxxxxxxx> - - ## Notes (series) ## - § v2 - - • Fix sloppy typos (sorry about that) - • “default notes” instead of “default refs” - • Don’t drop “it” (“treat it like”) - ## notes.h ## @@ notes.h: void disable_display_notes(struct display_notes_opt *opt, int *show_notes); * If 'opt' is not NULL, then it specifies additional settings for the @@ notes.h: void disable_display_notes(struct display_notes_opt *opt, int *show_not - * - suppress_default_notes indicates that the notes from - * core.notesRef and notes.displayRef should not be loaded. + * - use_default_notes: less than `0` is "unset", which means that the -+ * default notes are shown iff no other notes are given. Else treat it -+ * like a boolean. ++ * default notes are shown iff no other notes are given. Otherwise, ++ * treat it like a boolean. * * - extra_notes_refs may contain a list of globs (in the same style * as notes.displayRef) where notes should be loaded from. -: ---------- > 2: 99c88c74ce notes: move the documentation to the struct -- 2.41.0
