diff options
author | Denton Liu <liu.denton@gmail.com> | 2019-12-09 05:10:39 -0800 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2019-12-09 13:36:42 -0800 |
commit | 1e6ed5441a61b5085978e0429691e2e2425f6846 (patch) | |
tree | 3acc778854d212121450fd6c67808043454feb63 /notes.h | |
parent | 13cdf78094a5ba2968adb90707d27b98f53db1f7 (diff) | |
download | git-1e6ed5441a61b5085978e0429691e2e2425f6846.tar.gz |
notes: rename to load_display_notes()
According to the function comment, init_display_notes() was supposed to
"Load the notes machinery for displaying several notes trees." Rename
this function to load_display_notes() so that its use is more accurately
represented.
This is done because, in a future commit, we will reuse the name
init_display_notes().
Signed-off-by: Denton Liu <liu.denton@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'notes.h')
-rw-r--r-- | notes.h | 6 |
1 files changed, 3 insertions, 3 deletions
@@ -272,18 +272,18 @@ struct display_notes_opt { * - extra_notes_refs may contain a list of globs (in the same style * as notes.displayRef) where notes should be loaded from. */ -void init_display_notes(struct display_notes_opt *opt); +void load_display_notes(struct display_notes_opt *opt); /* * Append notes for the given 'object_sha1' from all trees set up by - * init_display_notes() to 'sb'. The 'flags' are a bitwise + * load_display_notes() to 'sb'. The 'flags' are a bitwise * combination of * * - NOTES_SHOW_HEADER: add a 'Notes (refname):' header * * - NOTES_INDENT: indent the notes by 4 places * - * You *must* call init_display_notes() before using this function. + * You *must* call load_display_notes() before using this function. */ void format_display_notes(const struct object_id *object_oid, struct strbuf *sb, const char *output_encoding, int raw); |