Merge branch 'mh/for-each-string-list-item-empty-fix'
[git] / notes-utils.h
1 #ifndef NOTES_UTILS_H
2 #define NOTES_UTILS_H
3
4 #include "notes.h"
5
6 /*
7  * Create new notes commit from the given notes tree
8  *
9  * Properties of the created commit:
10  * - tree: the result of converting t to a tree object with write_notes_tree().
11  * - parents: the given parents OR (if NULL) the commit referenced by t->ref.
12  * - author/committer: the default determined by commit_tree().
13  * - commit message: msg
14  *
15  * The resulting commit SHA1 is stored in result_sha1.
16  */
17 void create_notes_commit(struct notes_tree *t, struct commit_list *parents,
18                          const char *msg, size_t msg_len, unsigned char *result_sha1);
19
20 void commit_notes(struct notes_tree *t, const char *msg);
21
22 enum notes_merge_strategy {
23                 NOTES_MERGE_RESOLVE_MANUAL = 0,
24                 NOTES_MERGE_RESOLVE_OURS,
25                 NOTES_MERGE_RESOLVE_THEIRS,
26                 NOTES_MERGE_RESOLVE_UNION,
27                 NOTES_MERGE_RESOLVE_CAT_SORT_UNIQ
28 };
29
30 struct notes_rewrite_cfg {
31         struct notes_tree **trees;
32         const char *cmd;
33         int enabled;
34         combine_notes_fn combine;
35         struct string_list *refs;
36         int refs_from_env;
37         int mode_from_env;
38 };
39
40 int parse_notes_merge_strategy(const char *v, enum notes_merge_strategy *s);
41 struct notes_rewrite_cfg *init_copy_notes_for_rewrite(const char *cmd);
42 int copy_note_for_rewrite(struct notes_rewrite_cfg *c,
43                           const struct object_id *from_obj, const struct object_id *to_obj);
44 void finish_copy_notes_for_rewrite(struct notes_rewrite_cfg *c, const char *msg);
45
46 #endif