diff options
Diffstat (limited to 'notes.h')
| -rw-r--r-- | notes.h | 24 |
1 files changed, 16 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; }; @@ -266,6 +276,11 @@ struct display_notes_opt { void init_display_notes(struct display_notes_opt *opt); /* + * Release resources acquired by the display_notes_opt. + */ +void release_display_notes(struct display_notes_opt *opt); + +/* * This family of functions enables or disables the display of notes. In * particular, 'enable_default_display_notes' will display the default notes, * 'enable_ref_display_notes' will display the notes ref 'ref' and @@ -283,14 +298,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); |