[prev in list] [next in list] [prev in thread] [next in thread]
List: git
Subject: [PATCH] notes: update documentation for `use_default_notes`
From: Kristoffer Haugsbakk <code () khaugsbakk ! name>
Date: 2023-05-31 9:52:07
Message-ID: b3829cb0d1e36a5ebb44a315fe32037f2a3f6c7a.1685526558.git.code () khaugsbakk ! name
[Download RAW message or body]
`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 <code@khaugsbakk.name>
---
Notes (series):
See also: https://lore.kernel.org/git/cover.1685441207.git.code@khaugsbakk.name
Found while working on that. But this change could be posted
separately.
notes.h | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/notes.h b/notes.h
index c1682c39a9..69b6120146 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
+ * deafult refs are show iff no other notes are given. Else treat 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
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic