mirror of
https://github.com/git/git.git
synced 2024-11-15 14:53:12 +01:00
4d03dd18f0
A future patch will extract parsing of the --strategy string into a helper function in notes.c and will require the enumeration definition. Signed-off-by: Jacob Keller <jacob.keller@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
81 lines
2.8 KiB
C
81 lines
2.8 KiB
C
#ifndef NOTES_MERGE_H
|
|
#define NOTES_MERGE_H
|
|
|
|
#include "notes-utils.h"
|
|
|
|
#define NOTES_MERGE_WORKTREE "NOTES_MERGE_WORKTREE"
|
|
|
|
enum notes_merge_verbosity {
|
|
NOTES_MERGE_VERBOSITY_DEFAULT = 2,
|
|
NOTES_MERGE_VERBOSITY_MAX = 5
|
|
};
|
|
|
|
struct notes_merge_options {
|
|
const char *local_ref;
|
|
const char *remote_ref;
|
|
struct strbuf commit_msg;
|
|
int verbosity;
|
|
enum notes_merge_strategy strategy;
|
|
unsigned has_worktree:1;
|
|
};
|
|
|
|
void init_notes_merge_options(struct notes_merge_options *o);
|
|
|
|
/*
|
|
* Merge notes from o->remote_ref into o->local_ref
|
|
*
|
|
* The given notes_tree 'local_tree' must be the notes_tree referenced by the
|
|
* o->local_ref. This is the notes_tree in which the object-level merge is
|
|
* performed.
|
|
*
|
|
* The commits given by the two refs are merged, producing one of the following
|
|
* outcomes:
|
|
*
|
|
* 1. The merge trivially results in an existing commit (e.g. fast-forward or
|
|
* already-up-to-date). 'local_tree' is untouched, the SHA1 of the result
|
|
* is written into 'result_sha1' and 0 is returned.
|
|
* 2. The merge successfully completes, producing a merge commit. local_tree
|
|
* contains the updated notes tree, the SHA1 of the resulting commit is
|
|
* written into 'result_sha1', and 1 is returned.
|
|
* 3. The merge results in conflicts. This is similar to #2 in that the
|
|
* partial merge result (i.e. merge result minus the unmerged entries)
|
|
* are stored in 'local_tree', and the SHA1 or the resulting commit
|
|
* (to be amended when the conflicts have been resolved) is written into
|
|
* 'result_sha1'. The unmerged entries are written into the
|
|
* .git/NOTES_MERGE_WORKTREE directory with conflict markers.
|
|
* -1 is returned.
|
|
*
|
|
* Both o->local_ref and o->remote_ref must be given (non-NULL), but either ref
|
|
* (although not both) may refer to a non-existing notes ref, in which case
|
|
* that notes ref is interpreted as an empty notes tree, and the merge
|
|
* trivially results in what the other ref points to.
|
|
*/
|
|
int notes_merge(struct notes_merge_options *o,
|
|
struct notes_tree *local_tree,
|
|
unsigned char *result_sha1);
|
|
|
|
/*
|
|
* Finalize conflict resolution from an earlier notes_merge()
|
|
*
|
|
* The given notes tree 'partial_tree' must be the notes_tree corresponding to
|
|
* the given 'partial_commit', the partial result commit created by a previous
|
|
* call to notes_merge().
|
|
*
|
|
* This function will add the (now resolved) notes in .git/NOTES_MERGE_WORKTREE
|
|
* to 'partial_tree', and create a final notes merge commit, the SHA1 of which
|
|
* will be stored in 'result_sha1'.
|
|
*/
|
|
int notes_merge_commit(struct notes_merge_options *o,
|
|
struct notes_tree *partial_tree,
|
|
struct commit *partial_commit,
|
|
unsigned char *result_sha1);
|
|
|
|
/*
|
|
* Abort conflict resolution from an earlier notes_merge()
|
|
*
|
|
* Removes the notes merge worktree in .git/NOTES_MERGE_WORKTREE.
|
|
*/
|
|
int notes_merge_abort(struct notes_merge_options *o);
|
|
|
|
#endif
|