notes: update documentation for `use_default_notes`
`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 what was meant was probably “less than zero” (the author of 3a03cf6b1d agrees on this point). Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Kristoffer Haugsbakk committed
Jun 5, 2023 at 12:05 UTC
a2e9dbb8849a29d010dceea2d5d1cab62d4dee6d
1 file changed
+3
-2
notes.h
+3
-2
@@ -286,8 +286,9 @@ void disable_display_notes(struct display_notes_opt *opt, int *show_notes);
286
* If 'opt' is not NULL, then it specifies additional settings for the
287
* displaying:
288
*
289
- * - suppress_default_notes indicates that the notes from
290
- * core.notesRef and notes.displayRef should not be loaded.
289
+ * - use_default_notes: less than `0` is "unset", which means that the
290
+ * default notes are shown iff no other notes are given. Otherwise,
291
+ * treat it like a boolean.
292
*
293
* - extra_notes_refs may contain a list of globs (in the same style
294
* as notes.displayRef) where notes should be loaded from.