[PATCH v2] notes: update documentation for `use_default_notes`
From: Kristoffer Haugsbakk <hidden>
Date: 2023-05-31 12:15:45
Subsystem:
the rest · Maintainer:
Linus Torvalds
`suppress_default_notes` was renamed to `use_default_notes` in
3a03cf6b1d (notes: refactor display notes default handling,
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”.
Signed-off-by: Kristoffer Haugsbakk <redacted>
---
Notes (series):
§ v2
• Fix sloppy typos (sorry about that)
• “default notes” instead of “default refs”
• Don’t drop “it” (“treat it like”)
notes.h | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/notes.h b/notes.h
index c1682c39a9..826a2595fa 100644
--- a/notes.h
+++ b/notes.h@@ -286,8 +286,9 @@ void disable_display_notes(struct display_notes_opt *opt, int *show_notes); * If 'opt' is not NULL, then it specifies additional settings for the * displaying: * - * - 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. * * - extra_notes_refs may contain a list of globs (in the same style * as notes.displayRef) where notes should be loaded from.
--
2.41.0.rc2