4 #define NOTES_MERGE_WORKTREE "NOTES_MERGE_WORKTREE"
6 enum notes_merge_verbosity
{
7 NOTES_MERGE_VERBOSITY_DEFAULT
= 2,
8 NOTES_MERGE_VERBOSITY_MAX
= 5
11 struct notes_merge_options
{
12 const char *local_ref
;
13 const char *remote_ref
;
14 const char *commit_msg
;
17 NOTES_MERGE_RESOLVE_MANUAL
= 0,
18 NOTES_MERGE_RESOLVE_OURS
,
19 NOTES_MERGE_RESOLVE_THEIRS
,
20 NOTES_MERGE_RESOLVE_UNION
22 unsigned has_worktree
:1;
25 void init_notes_merge_options(struct notes_merge_options
*o
);
28 * Create new notes commit from the given notes tree
30 * Properties of the created commit:
31 * - tree: the result of converting t to a tree object with write_notes_tree().
32 * - parents: the given parents OR (if NULL) the commit referenced by t->ref.
33 * - author/committer: the default determined by commmit_tree().
34 * - commit message: msg
36 * The resulting commit SHA1 is stored in result_sha1.
38 void create_notes_commit(struct notes_tree
*t
, struct commit_list
*parents
,
39 const char *msg
, unsigned char *result_sha1
);
42 * Merge notes from o->remote_ref into o->local_ref
44 * The given notes_tree 'local_tree' must be the notes_tree referenced by the
45 * o->local_ref. This is the notes_tree in which the object-level merge is
48 * The commits given by the two refs are merged, producing one of the following
51 * 1. The merge trivially results in an existing commit (e.g. fast-forward or
52 * already-up-to-date). 'local_tree' is untouched, the SHA1 of the result
53 * is written into 'result_sha1' and 0 is returned.
54 * 2. The merge successfully completes, producing a merge commit. local_tree
55 * contains the updated notes tree, the SHA1 of the resulting commit is
56 * written into 'result_sha1', and 1 is returned.
57 * 3. The merge results in conflicts. This is similar to #2 in that the
58 * partial merge result (i.e. merge result minus the unmerged entries)
59 * are stored in 'local_tree', and the SHA1 or the resulting commit
60 * (to be amended when the conflicts have been resolved) is written into
61 * 'result_sha1'. The unmerged entries are written into the
62 * .git/NOTES_MERGE_WORKTREE directory with conflict markers.
65 * Both o->local_ref and o->remote_ref must be given (non-NULL), but either ref
66 * (although not both) may refer to a non-existing notes ref, in which case
67 * that notes ref is interpreted as an empty notes tree, and the merge
68 * trivially results in what the other ref points to.
70 int notes_merge(struct notes_merge_options
*o
,
71 struct notes_tree
*local_tree
,
72 unsigned char *result_sha1
);
75 * Finalize conflict resolution from an earlier notes_merge()
77 * The given notes tree 'partial_tree' must be the notes_tree corresponding to
78 * the given 'partial_commit', the partial result commit created by a previous
79 * call to notes_merge().
81 * This function will add the (now resolved) notes in .git/NOTES_MERGE_WORKTREE
82 * to 'partial_tree', and create a final notes merge commit, the SHA1 of which
83 * will be stored in 'result_sha1'.
85 int notes_merge_commit(struct notes_merge_options
*o
,
86 struct notes_tree
*partial_tree
,
87 struct commit
*partial_commit
,
88 unsigned char *result_sha1
);
91 * Abort conflict resolution from an earlier notes_merge()
93 * Removes the notes merge worktree in .git/NOTES_MERGE_WORKTREE.
95 int notes_merge_abort(struct notes_merge_options
*o
);