THIS IS A TEST INSTANCE ONLY! REPOSITORIES CAN BE DELETED AT ANY TIME!

Git Source Code Mirror - This is a publish-only repository and all pull requests are ignored. Please follow Documentation/SubmittingPatches procedure for any of your improvements.
git
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

88 lines
2.9KB

  1. #ifndef NOTES_MERGE_H
  2. #define NOTES_MERGE_H
  3. #include "notes-utils.h"
  4. #include "strbuf.h"
  5. struct commit;
  6. struct object_id;
  7. struct repository;
  8. #define NOTES_MERGE_WORKTREE "NOTES_MERGE_WORKTREE"
  9. enum notes_merge_verbosity {
  10. NOTES_MERGE_VERBOSITY_DEFAULT = 2,
  11. NOTES_MERGE_VERBOSITY_MAX = 5
  12. };
  13. struct notes_merge_options {
  14. struct repository *repo;
  15. const char *local_ref;
  16. const char *remote_ref;
  17. struct strbuf commit_msg;
  18. int verbosity;
  19. enum notes_merge_strategy strategy;
  20. unsigned has_worktree:1;
  21. };
  22. void init_notes_merge_options(struct repository *r,
  23. struct notes_merge_options *o);
  24. /*
  25. * Merge notes from o->remote_ref into o->local_ref
  26. *
  27. * The given notes_tree 'local_tree' must be the notes_tree referenced by the
  28. * o->local_ref. This is the notes_tree in which the object-level merge is
  29. * performed.
  30. *
  31. * The commits given by the two refs are merged, producing one of the following
  32. * outcomes:
  33. *
  34. * 1. The merge trivially results in an existing commit (e.g. fast-forward or
  35. * already-up-to-date). 'local_tree' is untouched, the OID of the result
  36. * is written into 'result_oid' and 0 is returned.
  37. * 2. The merge successfully completes, producing a merge commit. local_tree
  38. * contains the updated notes tree, the OID of the resulting commit is
  39. * written into 'result_oid', and 1 is returned.
  40. * 3. The merge results in conflicts. This is similar to #2 in that the
  41. * partial merge result (i.e. merge result minus the unmerged entries)
  42. * are stored in 'local_tree', and the OID or the resulting commit
  43. * (to be amended when the conflicts have been resolved) is written into
  44. * 'result_oid'. The unmerged entries are written into the
  45. * .git/NOTES_MERGE_WORKTREE directory with conflict markers.
  46. * -1 is returned.
  47. *
  48. * Both o->local_ref and o->remote_ref must be given (non-NULL), but either ref
  49. * (although not both) may refer to a non-existing notes ref, in which case
  50. * that notes ref is interpreted as an empty notes tree, and the merge
  51. * trivially results in what the other ref points to.
  52. */
  53. int notes_merge(struct notes_merge_options *o,
  54. struct notes_tree *local_tree,
  55. struct object_id *result_oid);
  56. /*
  57. * Finalize conflict resolution from an earlier notes_merge()
  58. *
  59. * The given notes tree 'partial_tree' must be the notes_tree corresponding to
  60. * the given 'partial_commit', the partial result commit created by a previous
  61. * call to notes_merge().
  62. *
  63. * This function will add the (now resolved) notes in .git/NOTES_MERGE_WORKTREE
  64. * to 'partial_tree', and create a final notes merge commit, the OID of which
  65. * will be stored in 'result_oid'.
  66. */
  67. int notes_merge_commit(struct notes_merge_options *o,
  68. struct notes_tree *partial_tree,
  69. struct commit *partial_commit,
  70. struct object_id *result_oid);
  71. /*
  72. * Abort conflict resolution from an earlier notes_merge()
  73. *
  74. * Removes the notes merge worktree in .git/NOTES_MERGE_WORKTREE.
  75. */
  76. int notes_merge_abort(struct notes_merge_options *o);
  77. #endif