Git 2.24-rc0
[git.git] / notes-utils.c
bloba8194106987388a590b10e246327f49fd550f448
1 #include "cache.h"
2 #include "config.h"
3 #include "commit.h"
4 #include "refs.h"
5 #include "notes-utils.h"
6 #include "repository.h"
8 void create_notes_commit(struct repository *r,
9 struct notes_tree *t,
10 struct commit_list *parents,
11 const char *msg, size_t msg_len,
12 struct object_id *result_oid)
14 struct object_id tree_oid;
16 assert(t->initialized);
18 if (write_notes_tree(t, &tree_oid))
19 die("Failed to write notes tree to database");
21 if (!parents) {
22 /* Deduce parent commit from t->ref */
23 struct object_id parent_oid;
24 if (!read_ref(t->ref, &parent_oid)) {
25 struct commit *parent = lookup_commit(r, &parent_oid);
26 if (parse_commit(parent))
27 die("Failed to find/parse commit %s", t->ref);
28 commit_list_insert(parent, &parents);
30 /* else: t->ref points to nothing, assume root/orphan commit */
33 if (commit_tree(msg, msg_len, &tree_oid, parents, result_oid, NULL,
34 NULL))
35 die("Failed to commit notes tree to database");
38 void commit_notes(struct repository *r, struct notes_tree *t, const char *msg)
40 struct strbuf buf = STRBUF_INIT;
41 struct object_id commit_oid;
43 if (!t)
44 t = &default_notes_tree;
45 if (!t->initialized || !t->update_ref || !*t->update_ref)
46 die(_("Cannot commit uninitialized/unreferenced notes tree"));
47 if (!t->dirty)
48 return; /* don't have to commit an unchanged tree */
50 /* Prepare commit message and reflog message */
51 strbuf_addstr(&buf, msg);
52 strbuf_complete_line(&buf);
54 create_notes_commit(r, t, NULL, buf.buf, buf.len, &commit_oid);
55 strbuf_insert(&buf, 0, "notes: ", 7); /* commit message starts at index 7 */
56 update_ref(buf.buf, t->update_ref, &commit_oid, NULL, 0,
57 UPDATE_REFS_DIE_ON_ERR);
59 strbuf_release(&buf);
62 int parse_notes_merge_strategy(const char *v, enum notes_merge_strategy *s)
64 if (!strcmp(v, "manual"))
65 *s = NOTES_MERGE_RESOLVE_MANUAL;
66 else if (!strcmp(v, "ours"))
67 *s = NOTES_MERGE_RESOLVE_OURS;
68 else if (!strcmp(v, "theirs"))
69 *s = NOTES_MERGE_RESOLVE_THEIRS;
70 else if (!strcmp(v, "union"))
71 *s = NOTES_MERGE_RESOLVE_UNION;
72 else if (!strcmp(v, "cat_sort_uniq"))
73 *s = NOTES_MERGE_RESOLVE_CAT_SORT_UNIQ;
74 else
75 return -1;
77 return 0;
80 static combine_notes_fn parse_combine_notes_fn(const char *v)
82 if (!strcasecmp(v, "overwrite"))
83 return combine_notes_overwrite;
84 else if (!strcasecmp(v, "ignore"))
85 return combine_notes_ignore;
86 else if (!strcasecmp(v, "concatenate"))
87 return combine_notes_concatenate;
88 else if (!strcasecmp(v, "cat_sort_uniq"))
89 return combine_notes_cat_sort_uniq;
90 else
91 return NULL;
94 static int notes_rewrite_config(const char *k, const char *v, void *cb)
96 struct notes_rewrite_cfg *c = cb;
97 if (starts_with(k, "notes.rewrite.") && !strcmp(k+14, c->cmd)) {
98 c->enabled = git_config_bool(k, v);
99 return 0;
100 } else if (!c->mode_from_env && !strcmp(k, "notes.rewritemode")) {
101 if (!v)
102 return config_error_nonbool(k);
103 c->combine = parse_combine_notes_fn(v);
104 if (!c->combine) {
105 error(_("Bad notes.rewriteMode value: '%s'"), v);
106 return 1;
108 return 0;
109 } else if (!c->refs_from_env && !strcmp(k, "notes.rewriteref")) {
110 /* note that a refs/ prefix is implied in the
111 * underlying for_each_glob_ref */
112 if (starts_with(v, "refs/notes/"))
113 string_list_add_refs_by_glob(c->refs, v);
114 else
115 warning(_("Refusing to rewrite notes in %s"
116 " (outside of refs/notes/)"), v);
117 return 0;
120 return 0;
124 struct notes_rewrite_cfg *init_copy_notes_for_rewrite(const char *cmd)
126 struct notes_rewrite_cfg *c = xmalloc(sizeof(struct notes_rewrite_cfg));
127 const char *rewrite_mode_env = getenv(GIT_NOTES_REWRITE_MODE_ENVIRONMENT);
128 const char *rewrite_refs_env = getenv(GIT_NOTES_REWRITE_REF_ENVIRONMENT);
129 c->cmd = cmd;
130 c->enabled = 1;
131 c->combine = combine_notes_concatenate;
132 c->refs = xcalloc(1, sizeof(struct string_list));
133 c->refs->strdup_strings = 1;
134 c->refs_from_env = 0;
135 c->mode_from_env = 0;
136 if (rewrite_mode_env) {
137 c->mode_from_env = 1;
138 c->combine = parse_combine_notes_fn(rewrite_mode_env);
139 if (!c->combine)
141 * TRANSLATORS: The first %s is the name of
142 * the environment variable, the second %s is
143 * its value.
145 error(_("Bad %s value: '%s'"), GIT_NOTES_REWRITE_MODE_ENVIRONMENT,
146 rewrite_mode_env);
148 if (rewrite_refs_env) {
149 c->refs_from_env = 1;
150 string_list_add_refs_from_colon_sep(c->refs, rewrite_refs_env);
152 git_config(notes_rewrite_config, c);
153 if (!c->enabled || !c->refs->nr) {
154 string_list_clear(c->refs, 0);
155 free(c->refs);
156 free(c);
157 return NULL;
159 c->trees = load_notes_trees(c->refs, NOTES_INIT_WRITABLE);
160 string_list_clear(c->refs, 0);
161 free(c->refs);
162 return c;
165 int copy_note_for_rewrite(struct notes_rewrite_cfg *c,
166 const struct object_id *from_obj, const struct object_id *to_obj)
168 int ret = 0;
169 int i;
170 for (i = 0; c->trees[i]; i++)
171 ret = copy_note(c->trees[i], from_obj, to_obj, 1, c->combine) || ret;
172 return ret;
175 void finish_copy_notes_for_rewrite(struct repository *r,
176 struct notes_rewrite_cfg *c,
177 const char *msg)
179 int i;
180 for (i = 0; c->trees[i]; i++) {
181 commit_notes(r, c->trees[i], msg);
182 free_notes(c->trees[i]);
184 free(c->trees);
185 free(c);