Skip to content

Commit a2e9dbb

Browse files
LemmingAvalanchegitster
authored andcommitted
notes: update documentation for use_default_notes
`suppress_default_notes` was renamed to `use_default_notes` in 3a03cf6 (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 3a03cf6 agrees on this point). Signed-off-by: Kristoffer Haugsbakk <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 0d1bd1d commit a2e9dbb

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

notes.h

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -286,8 +286,9 @@ void disable_display_notes(struct display_notes_opt *opt, int *show_notes);
286286
* If 'opt' is not NULL, then it specifies additional settings for the
287287
* displaying:
288288
*
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.
291292
*
292293
* - extra_notes_refs may contain a list of globs (in the same style
293294
* as notes.displayRef) where notes should be loaded from.

0 commit comments

Comments
 (0)