Code

git notes merge: --commit should fail if underlying notes ref has moved
[git.git] / builtin / notes.c
1 /*
2  * Builtin "git notes"
3  *
4  * Copyright (c) 2010 Johan Herland <johan@herland.net>
5  *
6  * Based on git-notes.sh by Johannes Schindelin,
7  * and builtin-tag.c by Kristian Høgsberg and Carlos Rica.
8  */
10 #include "cache.h"
11 #include "builtin.h"
12 #include "notes.h"
13 #include "blob.h"
14 #include "commit.h"
15 #include "refs.h"
16 #include "exec_cmd.h"
17 #include "run-command.h"
18 #include "parse-options.h"
19 #include "string-list.h"
20 #include "notes-merge.h"
22 static const char * const git_notes_usage[] = {
23         "git notes [--ref <notes_ref>] [list [<object>]]",
24         "git notes [--ref <notes_ref>] add [-f] [-m <msg> | -F <file> | (-c | -C) <object>] [<object>]",
25         "git notes [--ref <notes_ref>] copy [-f] <from-object> <to-object>",
26         "git notes [--ref <notes_ref>] append [-m <msg> | -F <file> | (-c | -C) <object>] [<object>]",
27         "git notes [--ref <notes_ref>] edit [<object>]",
28         "git notes [--ref <notes_ref>] show [<object>]",
29         "git notes [--ref <notes_ref>] merge [-v | -q] [-s <strategy> ] <notes_ref>",
30         "git notes merge --commit [-v | -q]",
31         "git notes merge --abort [-v | -q]",
32         "git notes [--ref <notes_ref>] remove [<object>]",
33         "git notes [--ref <notes_ref>] prune [-n | -v]",
34         NULL
35 };
37 static const char * const git_notes_list_usage[] = {
38         "git notes [list [<object>]]",
39         NULL
40 };
42 static const char * const git_notes_add_usage[] = {
43         "git notes add [<options>] [<object>]",
44         NULL
45 };
47 static const char * const git_notes_copy_usage[] = {
48         "git notes copy [<options>] <from-object> <to-object>",
49         "git notes copy --stdin [<from-object> <to-object>]...",
50         NULL
51 };
53 static const char * const git_notes_append_usage[] = {
54         "git notes append [<options>] [<object>]",
55         NULL
56 };
58 static const char * const git_notes_edit_usage[] = {
59         "git notes edit [<object>]",
60         NULL
61 };
63 static const char * const git_notes_show_usage[] = {
64         "git notes show [<object>]",
65         NULL
66 };
68 static const char * const git_notes_merge_usage[] = {
69         "git notes merge [<options>] <notes_ref>",
70         "git notes merge --commit [<options>]",
71         "git notes merge --abort [<options>]",
72         NULL
73 };
75 static const char * const git_notes_remove_usage[] = {
76         "git notes remove [<object>]",
77         NULL
78 };
80 static const char * const git_notes_prune_usage[] = {
81         "git notes prune [<options>]",
82         NULL
83 };
85 static const char note_template[] =
86         "\n"
87         "#\n"
88         "# Write/edit the notes for the following object:\n"
89         "#\n";
91 struct msg_arg {
92         int given;
93         int use_editor;
94         struct strbuf buf;
95 };
97 static void expand_notes_ref(struct strbuf *sb)
98 {
99         if (!prefixcmp(sb->buf, "refs/notes/"))
100                 return; /* we're happy */
101         else if (!prefixcmp(sb->buf, "notes/"))
102                 strbuf_insert(sb, 0, "refs/", 5);
103         else
104                 strbuf_insert(sb, 0, "refs/notes/", 11);
107 static int list_each_note(const unsigned char *object_sha1,
108                 const unsigned char *note_sha1, char *note_path,
109                 void *cb_data)
111         printf("%s %s\n", sha1_to_hex(note_sha1), sha1_to_hex(object_sha1));
112         return 0;
115 static void write_note_data(int fd, const unsigned char *sha1)
117         unsigned long size;
118         enum object_type type;
119         char *buf = read_sha1_file(sha1, &type, &size);
120         if (buf) {
121                 if (size)
122                         write_or_die(fd, buf, size);
123                 free(buf);
124         }
127 static void write_commented_object(int fd, const unsigned char *object)
129         const char *show_args[5] =
130                 {"show", "--stat", "--no-notes", sha1_to_hex(object), NULL};
131         struct child_process show;
132         struct strbuf buf = STRBUF_INIT;
133         FILE *show_out;
135         /* Invoke "git show --stat --no-notes $object" */
136         memset(&show, 0, sizeof(show));
137         show.argv = show_args;
138         show.no_stdin = 1;
139         show.out = -1;
140         show.err = 0;
141         show.git_cmd = 1;
142         if (start_command(&show))
143                 die("unable to start 'show' for object '%s'",
144                     sha1_to_hex(object));
146         /* Open the output as FILE* so strbuf_getline() can be used. */
147         show_out = xfdopen(show.out, "r");
148         if (show_out == NULL)
149                 die_errno("can't fdopen 'show' output fd");
151         /* Prepend "# " to each output line and write result to 'fd' */
152         while (strbuf_getline(&buf, show_out, '\n') != EOF) {
153                 write_or_die(fd, "# ", 2);
154                 write_or_die(fd, buf.buf, buf.len);
155                 write_or_die(fd, "\n", 1);
156         }
157         strbuf_release(&buf);
158         if (fclose(show_out))
159                 die_errno("failed to close pipe to 'show' for object '%s'",
160                           sha1_to_hex(object));
161         if (finish_command(&show))
162                 die("failed to finish 'show' for object '%s'",
163                     sha1_to_hex(object));
166 static void create_note(const unsigned char *object, struct msg_arg *msg,
167                         int append_only, const unsigned char *prev,
168                         unsigned char *result)
170         char *path = NULL;
172         if (msg->use_editor || !msg->given) {
173                 int fd;
175                 /* write the template message before editing: */
176                 path = git_pathdup("NOTES_EDITMSG");
177                 fd = open(path, O_CREAT | O_TRUNC | O_WRONLY, 0600);
178                 if (fd < 0)
179                         die_errno("could not create file '%s'", path);
181                 if (msg->given)
182                         write_or_die(fd, msg->buf.buf, msg->buf.len);
183                 else if (prev && !append_only)
184                         write_note_data(fd, prev);
185                 write_or_die(fd, note_template, strlen(note_template));
187                 write_commented_object(fd, object);
189                 close(fd);
190                 strbuf_reset(&(msg->buf));
192                 if (launch_editor(path, &(msg->buf), NULL)) {
193                         die("Please supply the note contents using either -m" \
194                             " or -F option");
195                 }
196                 stripspace(&(msg->buf), 1);
197         }
199         if (prev && append_only) {
200                 /* Append buf to previous note contents */
201                 unsigned long size;
202                 enum object_type type;
203                 char *prev_buf = read_sha1_file(prev, &type, &size);
205                 strbuf_grow(&(msg->buf), size + 1);
206                 if (msg->buf.len && prev_buf && size)
207                         strbuf_insert(&(msg->buf), 0, "\n", 1);
208                 if (prev_buf && size)
209                         strbuf_insert(&(msg->buf), 0, prev_buf, size);
210                 free(prev_buf);
211         }
213         if (!msg->buf.len) {
214                 fprintf(stderr, "Removing note for object %s\n",
215                         sha1_to_hex(object));
216                 hashclr(result);
217         } else {
218                 if (write_sha1_file(msg->buf.buf, msg->buf.len, blob_type, result)) {
219                         error("unable to write note object");
220                         if (path)
221                                 error("The note contents has been left in %s",
222                                       path);
223                         exit(128);
224                 }
225         }
227         if (path) {
228                 unlink_or_warn(path);
229                 free(path);
230         }
233 static int parse_msg_arg(const struct option *opt, const char *arg, int unset)
235         struct msg_arg *msg = opt->value;
237         strbuf_grow(&(msg->buf), strlen(arg) + 2);
238         if (msg->buf.len)
239                 strbuf_addch(&(msg->buf), '\n');
240         strbuf_addstr(&(msg->buf), arg);
241         stripspace(&(msg->buf), 0);
243         msg->given = 1;
244         return 0;
247 static int parse_file_arg(const struct option *opt, const char *arg, int unset)
249         struct msg_arg *msg = opt->value;
251         if (msg->buf.len)
252                 strbuf_addch(&(msg->buf), '\n');
253         if (!strcmp(arg, "-")) {
254                 if (strbuf_read(&(msg->buf), 0, 1024) < 0)
255                         die_errno("cannot read '%s'", arg);
256         } else if (strbuf_read_file(&(msg->buf), arg, 1024) < 0)
257                 die_errno("could not open or read '%s'", arg);
258         stripspace(&(msg->buf), 0);
260         msg->given = 1;
261         return 0;
264 static int parse_reuse_arg(const struct option *opt, const char *arg, int unset)
266         struct msg_arg *msg = opt->value;
267         char *buf;
268         unsigned char object[20];
269         enum object_type type;
270         unsigned long len;
272         if (msg->buf.len)
273                 strbuf_addch(&(msg->buf), '\n');
275         if (get_sha1(arg, object))
276                 die("Failed to resolve '%s' as a valid ref.", arg);
277         if (!(buf = read_sha1_file(object, &type, &len)) || !len) {
278                 free(buf);
279                 die("Failed to read object '%s'.", arg);;
280         }
281         strbuf_add(&(msg->buf), buf, len);
282         free(buf);
284         msg->given = 1;
285         return 0;
288 static int parse_reedit_arg(const struct option *opt, const char *arg, int unset)
290         struct msg_arg *msg = opt->value;
291         msg->use_editor = 1;
292         return parse_reuse_arg(opt, arg, unset);
295 void commit_notes(struct notes_tree *t, const char *msg)
297         struct strbuf buf = STRBUF_INIT;
298         unsigned char commit_sha1[20];
300         if (!t)
301                 t = &default_notes_tree;
302         if (!t->initialized || !t->ref || !*t->ref)
303                 die("Cannot commit uninitialized/unreferenced notes tree");
304         if (!t->dirty)
305                 return; /* don't have to commit an unchanged tree */
307         /* Prepare commit message and reflog message */
308         strbuf_addstr(&buf, "notes: "); /* commit message starts at index 7 */
309         strbuf_addstr(&buf, msg);
310         if (buf.buf[buf.len - 1] != '\n')
311                 strbuf_addch(&buf, '\n'); /* Make sure msg ends with newline */
313         create_notes_commit(t, NULL, buf.buf + 7, commit_sha1);
314         update_ref(buf.buf, t->ref, commit_sha1, NULL, 0, DIE_ON_ERR);
316         strbuf_release(&buf);
319 combine_notes_fn parse_combine_notes_fn(const char *v)
321         if (!strcasecmp(v, "overwrite"))
322                 return combine_notes_overwrite;
323         else if (!strcasecmp(v, "ignore"))
324                 return combine_notes_ignore;
325         else if (!strcasecmp(v, "concatenate"))
326                 return combine_notes_concatenate;
327         else
328                 return NULL;
331 static int notes_rewrite_config(const char *k, const char *v, void *cb)
333         struct notes_rewrite_cfg *c = cb;
334         if (!prefixcmp(k, "notes.rewrite.") && !strcmp(k+14, c->cmd)) {
335                 c->enabled = git_config_bool(k, v);
336                 return 0;
337         } else if (!c->mode_from_env && !strcmp(k, "notes.rewritemode")) {
338                 if (!v)
339                         config_error_nonbool(k);
340                 c->combine = parse_combine_notes_fn(v);
341                 if (!c->combine) {
342                         error("Bad notes.rewriteMode value: '%s'", v);
343                         return 1;
344                 }
345                 return 0;
346         } else if (!c->refs_from_env && !strcmp(k, "notes.rewriteref")) {
347                 /* note that a refs/ prefix is implied in the
348                  * underlying for_each_glob_ref */
349                 if (!prefixcmp(v, "refs/notes/"))
350                         string_list_add_refs_by_glob(c->refs, v);
351                 else
352                         warning("Refusing to rewrite notes in %s"
353                                 " (outside of refs/notes/)", v);
354                 return 0;
355         }
357         return 0;
361 struct notes_rewrite_cfg *init_copy_notes_for_rewrite(const char *cmd)
363         struct notes_rewrite_cfg *c = xmalloc(sizeof(struct notes_rewrite_cfg));
364         const char *rewrite_mode_env = getenv(GIT_NOTES_REWRITE_MODE_ENVIRONMENT);
365         const char *rewrite_refs_env = getenv(GIT_NOTES_REWRITE_REF_ENVIRONMENT);
366         c->cmd = cmd;
367         c->enabled = 1;
368         c->combine = combine_notes_concatenate;
369         c->refs = xcalloc(1, sizeof(struct string_list));
370         c->refs->strdup_strings = 1;
371         c->refs_from_env = 0;
372         c->mode_from_env = 0;
373         if (rewrite_mode_env) {
374                 c->mode_from_env = 1;
375                 c->combine = parse_combine_notes_fn(rewrite_mode_env);
376                 if (!c->combine)
377                         error("Bad " GIT_NOTES_REWRITE_MODE_ENVIRONMENT
378                               " value: '%s'", rewrite_mode_env);
379         }
380         if (rewrite_refs_env) {
381                 c->refs_from_env = 1;
382                 string_list_add_refs_from_colon_sep(c->refs, rewrite_refs_env);
383         }
384         git_config(notes_rewrite_config, c);
385         if (!c->enabled || !c->refs->nr) {
386                 string_list_clear(c->refs, 0);
387                 free(c->refs);
388                 free(c);
389                 return NULL;
390         }
391         c->trees = load_notes_trees(c->refs);
392         string_list_clear(c->refs, 0);
393         free(c->refs);
394         return c;
397 int copy_note_for_rewrite(struct notes_rewrite_cfg *c,
398                           const unsigned char *from_obj, const unsigned char *to_obj)
400         int ret = 0;
401         int i;
402         for (i = 0; c->trees[i]; i++)
403                 ret = copy_note(c->trees[i], from_obj, to_obj, 1, c->combine) || ret;
404         return ret;
407 void finish_copy_notes_for_rewrite(struct notes_rewrite_cfg *c)
409         int i;
410         for (i = 0; c->trees[i]; i++) {
411                 commit_notes(c->trees[i], "Notes added by 'git notes copy'");
412                 free_notes(c->trees[i]);
413         }
414         free(c->trees);
415         free(c);
418 int notes_copy_from_stdin(int force, const char *rewrite_cmd)
420         struct strbuf buf = STRBUF_INIT;
421         struct notes_rewrite_cfg *c = NULL;
422         struct notes_tree *t = NULL;
423         int ret = 0;
425         if (rewrite_cmd) {
426                 c = init_copy_notes_for_rewrite(rewrite_cmd);
427                 if (!c)
428                         return 0;
429         } else {
430                 init_notes(NULL, NULL, NULL, 0);
431                 t = &default_notes_tree;
432         }
434         while (strbuf_getline(&buf, stdin, '\n') != EOF) {
435                 unsigned char from_obj[20], to_obj[20];
436                 struct strbuf **split;
437                 int err;
439                 split = strbuf_split(&buf, ' ');
440                 if (!split[0] || !split[1])
441                         die("Malformed input line: '%s'.", buf.buf);
442                 strbuf_rtrim(split[0]);
443                 strbuf_rtrim(split[1]);
444                 if (get_sha1(split[0]->buf, from_obj))
445                         die("Failed to resolve '%s' as a valid ref.", split[0]->buf);
446                 if (get_sha1(split[1]->buf, to_obj))
447                         die("Failed to resolve '%s' as a valid ref.", split[1]->buf);
449                 if (rewrite_cmd)
450                         err = copy_note_for_rewrite(c, from_obj, to_obj);
451                 else
452                         err = copy_note(t, from_obj, to_obj, force,
453                                         combine_notes_overwrite);
455                 if (err) {
456                         error("Failed to copy notes from '%s' to '%s'",
457                               split[0]->buf, split[1]->buf);
458                         ret = 1;
459                 }
461                 strbuf_list_free(split);
462         }
464         if (!rewrite_cmd) {
465                 commit_notes(t, "Notes added by 'git notes copy'");
466                 free_notes(t);
467         } else {
468                 finish_copy_notes_for_rewrite(c);
469         }
470         return ret;
473 static struct notes_tree *init_notes_check(const char *subcommand)
475         struct notes_tree *t;
476         init_notes(NULL, NULL, NULL, 0);
477         t = &default_notes_tree;
479         if (prefixcmp(t->ref, "refs/notes/"))
480                 die("Refusing to %s notes in %s (outside of refs/notes/)",
481                     subcommand, t->ref);
482         return t;
485 static int list(int argc, const char **argv, const char *prefix)
487         struct notes_tree *t;
488         unsigned char object[20];
489         const unsigned char *note;
490         int retval = -1;
491         struct option options[] = {
492                 OPT_END()
493         };
495         if (argc)
496                 argc = parse_options(argc, argv, prefix, options,
497                                      git_notes_list_usage, 0);
499         if (1 < argc) {
500                 error("too many parameters");
501                 usage_with_options(git_notes_list_usage, options);
502         }
504         t = init_notes_check("list");
505         if (argc) {
506                 if (get_sha1(argv[0], object))
507                         die("Failed to resolve '%s' as a valid ref.", argv[0]);
508                 note = get_note(t, object);
509                 if (note) {
510                         puts(sha1_to_hex(note));
511                         retval = 0;
512                 } else
513                         retval = error("No note found for object %s.",
514                                        sha1_to_hex(object));
515         } else
516                 retval = for_each_note(t, 0, list_each_note, NULL);
518         free_notes(t);
519         return retval;
522 static int add(int argc, const char **argv, const char *prefix)
524         int retval = 0, force = 0;
525         const char *object_ref;
526         struct notes_tree *t;
527         unsigned char object[20], new_note[20];
528         char logmsg[100];
529         const unsigned char *note;
530         struct msg_arg msg = { 0, 0, STRBUF_INIT };
531         struct option options[] = {
532                 { OPTION_CALLBACK, 'm', "message", &msg, "MSG",
533                         "note contents as a string", PARSE_OPT_NONEG,
534                         parse_msg_arg},
535                 { OPTION_CALLBACK, 'F', "file", &msg, "FILE",
536                         "note contents in a file", PARSE_OPT_NONEG,
537                         parse_file_arg},
538                 { OPTION_CALLBACK, 'c', "reedit-message", &msg, "OBJECT",
539                         "reuse and edit specified note object", PARSE_OPT_NONEG,
540                         parse_reedit_arg},
541                 { OPTION_CALLBACK, 'C', "reuse-message", &msg, "OBJECT",
542                         "reuse specified note object", PARSE_OPT_NONEG,
543                         parse_reuse_arg},
544                 OPT_BOOLEAN('f', "force", &force, "replace existing notes"),
545                 OPT_END()
546         };
548         argc = parse_options(argc, argv, prefix, options, git_notes_add_usage,
549                              0);
551         if (1 < argc) {
552                 error("too many parameters");
553                 usage_with_options(git_notes_add_usage, options);
554         }
556         object_ref = argc ? argv[0] : "HEAD";
558         if (get_sha1(object_ref, object))
559                 die("Failed to resolve '%s' as a valid ref.", object_ref);
561         t = init_notes_check("add");
562         note = get_note(t, object);
564         if (note) {
565                 if (!force) {
566                         retval = error("Cannot add notes. Found existing notes "
567                                        "for object %s. Use '-f' to overwrite "
568                                        "existing notes", sha1_to_hex(object));
569                         goto out;
570                 }
571                 fprintf(stderr, "Overwriting existing notes for object %s\n",
572                         sha1_to_hex(object));
573         }
575         create_note(object, &msg, 0, note, new_note);
577         if (is_null_sha1(new_note))
578                 remove_note(t, object);
579         else if (add_note(t, object, new_note, combine_notes_overwrite))
580                 die("BUG: combine_notes_overwrite failed");
582         snprintf(logmsg, sizeof(logmsg), "Notes %s by 'git notes %s'",
583                  is_null_sha1(new_note) ? "removed" : "added", "add");
584         commit_notes(t, logmsg);
585 out:
586         free_notes(t);
587         strbuf_release(&(msg.buf));
588         return retval;
591 static int copy(int argc, const char **argv, const char *prefix)
593         int retval = 0, force = 0, from_stdin = 0;
594         const unsigned char *from_note, *note;
595         const char *object_ref;
596         unsigned char object[20], from_obj[20];
597         struct notes_tree *t;
598         const char *rewrite_cmd = NULL;
599         struct option options[] = {
600                 OPT_BOOLEAN('f', "force", &force, "replace existing notes"),
601                 OPT_BOOLEAN(0, "stdin", &from_stdin, "read objects from stdin"),
602                 OPT_STRING(0, "for-rewrite", &rewrite_cmd, "command",
603                            "load rewriting config for <command> (implies "
604                            "--stdin)"),
605                 OPT_END()
606         };
608         argc = parse_options(argc, argv, prefix, options, git_notes_copy_usage,
609                              0);
611         if (from_stdin || rewrite_cmd) {
612                 if (argc) {
613                         error("too many parameters");
614                         usage_with_options(git_notes_copy_usage, options);
615                 } else {
616                         return notes_copy_from_stdin(force, rewrite_cmd);
617                 }
618         }
620         if (argc < 2) {
621                 error("too few parameters");
622                 usage_with_options(git_notes_copy_usage, options);
623         }
624         if (2 < argc) {
625                 error("too many parameters");
626                 usage_with_options(git_notes_copy_usage, options);
627         }
629         if (get_sha1(argv[0], from_obj))
630                 die("Failed to resolve '%s' as a valid ref.", argv[0]);
632         object_ref = 1 < argc ? argv[1] : "HEAD";
634         if (get_sha1(object_ref, object))
635                 die("Failed to resolve '%s' as a valid ref.", object_ref);
637         t = init_notes_check("copy");
638         note = get_note(t, object);
640         if (note) {
641                 if (!force) {
642                         retval = error("Cannot copy notes. Found existing "
643                                        "notes for object %s. Use '-f' to "
644                                        "overwrite existing notes",
645                                        sha1_to_hex(object));
646                         goto out;
647                 }
648                 fprintf(stderr, "Overwriting existing notes for object %s\n",
649                         sha1_to_hex(object));
650         }
652         from_note = get_note(t, from_obj);
653         if (!from_note) {
654                 retval = error("Missing notes on source object %s. Cannot "
655                                "copy.", sha1_to_hex(from_obj));
656                 goto out;
657         }
659         if (add_note(t, object, from_note, combine_notes_overwrite))
660                 die("BUG: combine_notes_overwrite failed");
661         commit_notes(t, "Notes added by 'git notes copy'");
662 out:
663         free_notes(t);
664         return retval;
667 static int append_edit(int argc, const char **argv, const char *prefix)
669         const char *object_ref;
670         struct notes_tree *t;
671         unsigned char object[20], new_note[20];
672         const unsigned char *note;
673         char logmsg[100];
674         const char * const *usage;
675         struct msg_arg msg = { 0, 0, STRBUF_INIT };
676         struct option options[] = {
677                 { OPTION_CALLBACK, 'm', "message", &msg, "MSG",
678                         "note contents as a string", PARSE_OPT_NONEG,
679                         parse_msg_arg},
680                 { OPTION_CALLBACK, 'F', "file", &msg, "FILE",
681                         "note contents in a file", PARSE_OPT_NONEG,
682                         parse_file_arg},
683                 { OPTION_CALLBACK, 'c', "reedit-message", &msg, "OBJECT",
684                         "reuse and edit specified note object", PARSE_OPT_NONEG,
685                         parse_reedit_arg},
686                 { OPTION_CALLBACK, 'C', "reuse-message", &msg, "OBJECT",
687                         "reuse specified note object", PARSE_OPT_NONEG,
688                         parse_reuse_arg},
689                 OPT_END()
690         };
691         int edit = !strcmp(argv[0], "edit");
693         usage = edit ? git_notes_edit_usage : git_notes_append_usage;
694         argc = parse_options(argc, argv, prefix, options, usage,
695                              PARSE_OPT_KEEP_ARGV0);
697         if (2 < argc) {
698                 error("too many parameters");
699                 usage_with_options(usage, options);
700         }
702         if (msg.given && edit)
703                 fprintf(stderr, "The -m/-F/-c/-C options have been deprecated "
704                         "for the 'edit' subcommand.\n"
705                         "Please use 'git notes add -f -m/-F/-c/-C' instead.\n");
707         object_ref = 1 < argc ? argv[1] : "HEAD";
709         if (get_sha1(object_ref, object))
710                 die("Failed to resolve '%s' as a valid ref.", object_ref);
712         t = init_notes_check(argv[0]);
713         note = get_note(t, object);
715         create_note(object, &msg, !edit, note, new_note);
717         if (is_null_sha1(new_note))
718                 remove_note(t, object);
719         else if (add_note(t, object, new_note, combine_notes_overwrite))
720                 die("BUG: combine_notes_overwrite failed");
722         snprintf(logmsg, sizeof(logmsg), "Notes %s by 'git notes %s'",
723                  is_null_sha1(new_note) ? "removed" : "added", argv[0]);
724         commit_notes(t, logmsg);
725         free_notes(t);
726         strbuf_release(&(msg.buf));
727         return 0;
730 static int show(int argc, const char **argv, const char *prefix)
732         const char *object_ref;
733         struct notes_tree *t;
734         unsigned char object[20];
735         const unsigned char *note;
736         int retval;
737         struct option options[] = {
738                 OPT_END()
739         };
741         argc = parse_options(argc, argv, prefix, options, git_notes_show_usage,
742                              0);
744         if (1 < argc) {
745                 error("too many parameters");
746                 usage_with_options(git_notes_show_usage, options);
747         }
749         object_ref = argc ? argv[0] : "HEAD";
751         if (get_sha1(object_ref, object))
752                 die("Failed to resolve '%s' as a valid ref.", object_ref);
754         t = init_notes_check("show");
755         note = get_note(t, object);
757         if (!note)
758                 retval = error("No note found for object %s.",
759                                sha1_to_hex(object));
760         else {
761                 const char *show_args[3] = {"show", sha1_to_hex(note), NULL};
762                 retval = execv_git_cmd(show_args);
763         }
764         free_notes(t);
765         return retval;
768 static int merge_abort(struct notes_merge_options *o)
770         int ret = 0;
772         /*
773          * Remove .git/NOTES_MERGE_PARTIAL and .git/NOTES_MERGE_REF, and call
774          * notes_merge_abort() to remove .git/NOTES_MERGE_WORKTREE.
775          */
777         if (delete_ref("NOTES_MERGE_PARTIAL", NULL, 0))
778                 ret += error("Failed to delete ref NOTES_MERGE_PARTIAL");
779         if (delete_ref("NOTES_MERGE_REF", NULL, REF_NODEREF))
780                 ret += error("Failed to delete ref NOTES_MERGE_REF");
781         if (notes_merge_abort(o))
782                 ret += error("Failed to remove 'git notes merge' worktree");
783         return ret;
786 static int merge_commit(struct notes_merge_options *o)
788         struct strbuf msg = STRBUF_INIT;
789         unsigned char sha1[20], parent_sha1[20];
790         struct notes_tree *t;
791         struct commit *partial;
792         struct pretty_print_context pretty_ctx;
794         /*
795          * Read partial merge result from .git/NOTES_MERGE_PARTIAL,
796          * and target notes ref from .git/NOTES_MERGE_REF.
797          */
799         if (get_sha1("NOTES_MERGE_PARTIAL", sha1))
800                 die("Failed to read ref NOTES_MERGE_PARTIAL");
801         else if (!(partial = lookup_commit_reference(sha1)))
802                 die("Could not find commit from NOTES_MERGE_PARTIAL.");
803         else if (parse_commit(partial))
804                 die("Could not parse commit from NOTES_MERGE_PARTIAL.");
806         if (partial->parents)
807                 hashcpy(parent_sha1, partial->parents->item->object.sha1);
808         else
809                 hashclr(parent_sha1);
811         t = xcalloc(1, sizeof(struct notes_tree));
812         init_notes(t, "NOTES_MERGE_PARTIAL", combine_notes_overwrite, 0);
814         o->local_ref = resolve_ref("NOTES_MERGE_REF", sha1, 0, 0);
815         if (!o->local_ref)
816                 die("Failed to resolve NOTES_MERGE_REF");
818         if (notes_merge_commit(o, t, partial, sha1))
819                 die("Failed to finalize notes merge");
821         /* Reuse existing commit message in reflog message */
822         memset(&pretty_ctx, 0, sizeof(pretty_ctx));
823         format_commit_message(partial, "%s", &msg, &pretty_ctx);
824         strbuf_trim(&msg);
825         strbuf_insert(&msg, 0, "notes: ", 7);
826         update_ref(msg.buf, o->local_ref, sha1,
827                    is_null_sha1(parent_sha1) ? NULL : parent_sha1,
828                    0, DIE_ON_ERR);
830         free_notes(t);
831         strbuf_release(&msg);
832         return merge_abort(o);
835 static int merge(int argc, const char **argv, const char *prefix)
837         struct strbuf remote_ref = STRBUF_INIT, msg = STRBUF_INIT;
838         unsigned char result_sha1[20];
839         struct notes_tree *t;
840         struct notes_merge_options o;
841         int do_merge = 0, do_commit = 0, do_abort = 0;
842         int verbosity = 0, result;
843         const char *strategy = NULL;
844         struct option options[] = {
845                 OPT_GROUP("General options"),
846                 OPT__VERBOSITY(&verbosity),
847                 OPT_GROUP("Merge options"),
848                 OPT_STRING('s', "strategy", &strategy, "strategy",
849                            "resolve notes conflicts using the given "
850                            "strategy (manual/ours/theirs/union)"),
851                 OPT_GROUP("Committing unmerged notes"),
852                 { OPTION_BOOLEAN, 0, "commit", &do_commit, NULL,
853                         "finalize notes merge by committing unmerged notes",
854                         PARSE_OPT_NOARG | PARSE_OPT_NONEG },
855                 OPT_GROUP("Aborting notes merge resolution"),
856                 { OPTION_BOOLEAN, 0, "abort", &do_abort, NULL,
857                         "abort notes merge",
858                         PARSE_OPT_NOARG | PARSE_OPT_NONEG },
859                 OPT_END()
860         };
862         argc = parse_options(argc, argv, prefix, options,
863                              git_notes_merge_usage, 0);
865         if (strategy || do_commit + do_abort == 0)
866                 do_merge = 1;
867         if (do_merge + do_commit + do_abort != 1) {
868                 error("cannot mix --commit, --abort or -s/--strategy");
869                 usage_with_options(git_notes_merge_usage, options);
870         }
872         if (do_merge && argc != 1) {
873                 error("Must specify a notes ref to merge");
874                 usage_with_options(git_notes_merge_usage, options);
875         } else if (!do_merge && argc) {
876                 error("too many parameters");
877                 usage_with_options(git_notes_merge_usage, options);
878         }
880         init_notes_merge_options(&o);
881         o.verbosity = verbosity + NOTES_MERGE_VERBOSITY_DEFAULT;
883         if (do_abort)
884                 return merge_abort(&o);
885         if (do_commit)
886                 return merge_commit(&o);
888         o.local_ref = default_notes_ref();
889         strbuf_addstr(&remote_ref, argv[0]);
890         expand_notes_ref(&remote_ref);
891         o.remote_ref = remote_ref.buf;
893         if (strategy) {
894                 if (!strcmp(strategy, "manual"))
895                         o.strategy = NOTES_MERGE_RESOLVE_MANUAL;
896                 else if (!strcmp(strategy, "ours"))
897                         o.strategy = NOTES_MERGE_RESOLVE_OURS;
898                 else if (!strcmp(strategy, "theirs"))
899                         o.strategy = NOTES_MERGE_RESOLVE_THEIRS;
900                 else if (!strcmp(strategy, "union"))
901                         o.strategy = NOTES_MERGE_RESOLVE_UNION;
902                 else {
903                         error("Unknown -s/--strategy: %s", strategy);
904                         usage_with_options(git_notes_merge_usage, options);
905                 }
906         }
908         t = init_notes_check("merge");
910         strbuf_addf(&msg, "notes: Merged notes from %s into %s",
911                     remote_ref.buf, default_notes_ref());
912         strbuf_add(&(o.commit_msg), msg.buf + 7, msg.len - 7); /* skip "notes: " */
914         result = notes_merge(&o, t, result_sha1);
916         if (result >= 0) /* Merge resulted (trivially) in result_sha1 */
917                 /* Update default notes ref with new commit */
918                 update_ref(msg.buf, default_notes_ref(), result_sha1, NULL,
919                            0, DIE_ON_ERR);
920         else { /* Merge has unresolved conflicts */
921                 /* Update .git/NOTES_MERGE_PARTIAL with partial merge result */
922                 update_ref(msg.buf, "NOTES_MERGE_PARTIAL", result_sha1, NULL,
923                            0, DIE_ON_ERR);
924                 /* Store ref-to-be-updated into .git/NOTES_MERGE_REF */
925                 if (create_symref("NOTES_MERGE_REF", default_notes_ref(), NULL))
926                         die("Failed to store link to current notes ref (%s)",
927                             default_notes_ref());
928                 printf("Automatic notes merge failed. Fix conflicts in %s and "
929                        "commit the result with 'git notes merge --commit', or "
930                        "abort the merge with 'git notes merge --abort'.\n",
931                        git_path(NOTES_MERGE_WORKTREE));
932         }
934         free_notes(t);
935         strbuf_release(&remote_ref);
936         strbuf_release(&msg);
937         return result < 0; /* return non-zero on conflicts */
940 static int remove_cmd(int argc, const char **argv, const char *prefix)
942         struct option options[] = {
943                 OPT_END()
944         };
945         const char *object_ref;
946         struct notes_tree *t;
947         unsigned char object[20];
949         argc = parse_options(argc, argv, prefix, options,
950                              git_notes_remove_usage, 0);
952         if (1 < argc) {
953                 error("too many parameters");
954                 usage_with_options(git_notes_remove_usage, options);
955         }
957         object_ref = argc ? argv[0] : "HEAD";
959         if (get_sha1(object_ref, object))
960                 die("Failed to resolve '%s' as a valid ref.", object_ref);
962         t = init_notes_check("remove");
964         fprintf(stderr, "Removing note for object %s\n", sha1_to_hex(object));
965         remove_note(t, object);
967         commit_notes(t, "Notes removed by 'git notes remove'");
968         free_notes(t);
969         return 0;
972 static int prune(int argc, const char **argv, const char *prefix)
974         struct notes_tree *t;
975         int show_only = 0, verbose = 0;
976         struct option options[] = {
977                 OPT_BOOLEAN('n', "dry-run", &show_only,
978                             "do not remove, show only"),
979                 OPT_BOOLEAN('v', "verbose", &verbose, "report pruned notes"),
980                 OPT_END()
981         };
983         argc = parse_options(argc, argv, prefix, options, git_notes_prune_usage,
984                              0);
986         if (argc) {
987                 error("too many parameters");
988                 usage_with_options(git_notes_prune_usage, options);
989         }
991         t = init_notes_check("prune");
993         prune_notes(t, (verbose ? NOTES_PRUNE_VERBOSE : 0) |
994                 (show_only ? NOTES_PRUNE_VERBOSE|NOTES_PRUNE_DRYRUN : 0) );
995         if (!show_only)
996                 commit_notes(t, "Notes removed by 'git notes prune'");
997         free_notes(t);
998         return 0;
1001 int cmd_notes(int argc, const char **argv, const char *prefix)
1003         int result;
1004         const char *override_notes_ref = NULL;
1005         struct option options[] = {
1006                 OPT_STRING(0, "ref", &override_notes_ref, "notes_ref",
1007                            "use notes from <notes_ref>"),
1008                 OPT_END()
1009         };
1011         git_config(git_default_config, NULL);
1012         argc = parse_options(argc, argv, prefix, options, git_notes_usage,
1013                              PARSE_OPT_STOP_AT_NON_OPTION);
1015         if (override_notes_ref) {
1016                 struct strbuf sb = STRBUF_INIT;
1017                 strbuf_addstr(&sb, override_notes_ref);
1018                 expand_notes_ref(&sb);
1019                 setenv("GIT_NOTES_REF", sb.buf, 1);
1020                 strbuf_release(&sb);
1021         }
1023         if (argc < 1 || !strcmp(argv[0], "list"))
1024                 result = list(argc, argv, prefix);
1025         else if (!strcmp(argv[0], "add"))
1026                 result = add(argc, argv, prefix);
1027         else if (!strcmp(argv[0], "copy"))
1028                 result = copy(argc, argv, prefix);
1029         else if (!strcmp(argv[0], "append") || !strcmp(argv[0], "edit"))
1030                 result = append_edit(argc, argv, prefix);
1031         else if (!strcmp(argv[0], "show"))
1032                 result = show(argc, argv, prefix);
1033         else if (!strcmp(argv[0], "merge"))
1034                 result = merge(argc, argv, prefix);
1035         else if (!strcmp(argv[0], "remove"))
1036                 result = remove_cmd(argc, argv, prefix);
1037         else if (!strcmp(argv[0], "prune"))
1038                 result = prune(argc, argv, prefix);
1039         else {
1040                 result = error("Unknown subcommand: %s", argv[0]);
1041                 usage_with_options(git_notes_usage, options);
1042         }
1044         return result ? 1 : 0;