mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'kh/use-default-notes-doc' into next

Browse Source 
Doc update.

* kh/use-default-notes-doc:
  notes: move the documentation to the struct
  notes: update documentation for `use_default_notes`
This commit is contained in:
Junio C Hamano
2023-06-15 14:04:52 -07:00
parent ebe3216719 aeee1408ce
commit f25ced157e
1 changed files with 11 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
notes.h
View File

@ -256,7 +256,17 @@ void free_notes(struct notes_tree *t);
struct string_list; struct string_list;
struct display_notes_opt { 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; 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; 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. * Load the notes machinery for displaying several notes trees.
* *
* If 'opt' is not NULL, then it specifies additional settings for the * 'opt' may be NULL.
* 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.
*/ */
void load_display_notes(struct display_notes_opt *opt); void load_display_notes(struct display_notes_opt *opt);