diff options
author | Junio C Hamano <gitster@pobox.com> | 2023-06-21 01:53:12 +0300 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2023-06-21 01:53:12 +0300 |
commit | 6069c1a5a7631deeec550d85c19ebd004c134ea5 (patch) | |
tree | 2d0eb3044fe2425a593401930508094fd7cf89e3 | |
parent | 0899beb63c525c8254b2367e879cc8744092243f (diff) | |
parent | aeee1408ce98f0527d9d22c3aee96360f341443b (diff) |
Merge branch 'kh/use-default-notes-doc'
Doc update.
* kh/use-default-notes-doc:
notes: move the documentation to the struct
notes: update documentation for `use_default_notes`
-rw-r--r-- | notes.h | 19 |
1 files changed, 11 insertions, 8 deletions
@@ -256,7 +256,17 @@ void free_notes(struct notes_tree *t); struct string_list; struct display_notes_opt { + /* + * Less than `0` is "unset", which means that the default notes + * are shown iff no other notes are given. Otherwise, + * treat it like a boolean. + */ int use_default_notes; + + /* + * A list of globs (in the same style as notes.displayRef) where + * notes should be loaded from. + */ struct string_list extra_notes_refs; }; @@ -283,14 +293,7 @@ void disable_display_notes(struct display_notes_opt *opt, int *show_notes); /* * Load the notes machinery for displaying several notes trees. * - * 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. - * - * - extra_notes_refs may contain a list of globs (in the same style - * as notes.displayRef) where notes should be loaded from. + * 'opt' may be NULL. */ void load_display_notes(struct display_notes_opt *opt); |