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>
This commit is contained in:
Denton Liu 2019-12-09 05:10:39 -08:00 committed by Junio C Hamano
parent 13cdf78094
commit 1e6ed5441a
3 changed files with 6 additions and 6 deletions

View File

@ -202,7 +202,7 @@ static void cmd_log_init_finish(int argc, const char **argv, const char *prefix,
if (!rev->show_notes_given && (!rev->pretty_given || w.notes)) if (!rev->show_notes_given && (!rev->pretty_given || w.notes))
rev->show_notes = 1; rev->show_notes = 1;
if (rev->show_notes) if (rev->show_notes)
init_display_notes(&rev->notes_opt); load_display_notes(&rev->notes_opt);
if ((rev->diffopt.pickaxe_opts & DIFF_PICKAXE_KINDS_MASK) || if ((rev->diffopt.pickaxe_opts & DIFF_PICKAXE_KINDS_MASK) ||
rev->diffopt.filter || rev->diffopt.flags.follow_renames) rev->diffopt.filter || rev->diffopt.flags.follow_renames)
@ -1749,7 +1749,7 @@ int cmd_format_patch(int argc, const char **argv, const char *prefix)
rev.diffopt.flags.binary = 1; rev.diffopt.flags.binary = 1;
if (rev.show_notes) if (rev.show_notes)
init_display_notes(&rev.notes_opt); load_display_notes(&rev.notes_opt);
if (!output_directory && !use_stdout) if (!output_directory && !use_stdout)
output_directory = config_output_directory; output_directory = config_output_directory;

View File

@ -1039,7 +1039,7 @@ struct notes_tree **load_notes_trees(struct string_list *refs, int flags)
return trees; return trees;
} }
void init_display_notes(struct display_notes_opt *opt) void load_display_notes(struct display_notes_opt *opt)
{ {
char *display_ref_env; char *display_ref_env;
int load_config_refs = 0; int load_config_refs = 0;

View File

@ -272,18 +272,18 @@ struct display_notes_opt {
* - extra_notes_refs may contain a list of globs (in the same style * - extra_notes_refs may contain a list of globs (in the same style
* as notes.displayRef) where notes should be loaded from. * 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 * 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 * combination of
* *
* - NOTES_SHOW_HEADER: add a 'Notes (refname):' header * - NOTES_SHOW_HEADER: add a 'Notes (refname):' header
* *
* - NOTES_INDENT: indent the notes by 4 places * - 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, void format_display_notes(const struct object_id *object_oid,
struct strbuf *sb, const char *output_encoding, int raw); struct strbuf *sb, const char *output_encoding, int raw);