4 * Copyright (c) 2010 Johan Herland <johan@herland.net>
6 * Based on git-notes.sh by Johannes Schindelin,
7 * and builtin-tag.c by Kristian Høgsberg and Carlos Rica.
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 "git notes [--ref <notes_ref>] get-ref",
38 static const char * const git_notes_list_usage
[] = {
39 "git notes [list [<object>]]",
43 static const char * const git_notes_add_usage
[] = {
44 "git notes add [<options>] [<object>]",
48 static const char * const git_notes_copy_usage
[] = {
49 "git notes copy [<options>] <from-object> <to-object>",
50 "git notes copy --stdin [<from-object> <to-object>]...",
54 static const char * const git_notes_append_usage
[] = {
55 "git notes append [<options>] [<object>]",
59 static const char * const git_notes_edit_usage
[] = {
60 "git notes edit [<object>]",
64 static const char * const git_notes_show_usage
[] = {
65 "git notes show [<object>]",
69 static const char * const git_notes_merge_usage
[] = {
70 "git notes merge [<options>] <notes_ref>",
71 "git notes merge --commit [<options>]",
72 "git notes merge --abort [<options>]",
76 static const char * const git_notes_remove_usage
[] = {
77 "git notes remove [<object>]",
81 static const char * const git_notes_prune_usage
[] = {
82 "git notes prune [<options>]",
86 static const char * const git_notes_get_ref_usage
[] = {
91 static const char note_template
[] =
94 "# Write/edit the notes for the following object:\n"
103 static void expand_notes_ref(struct strbuf
*sb
)
105 if (!prefixcmp(sb
->buf
, "refs/notes/"))
106 return; /* we're happy */
107 else if (!prefixcmp(sb
->buf
, "notes/"))
108 strbuf_insert(sb
, 0, "refs/", 5);
110 strbuf_insert(sb
, 0, "refs/notes/", 11);
113 static int list_each_note(const unsigned char *object_sha1
,
114 const unsigned char *note_sha1
, char *note_path
,
117 printf("%s %s\n", sha1_to_hex(note_sha1
), sha1_to_hex(object_sha1
));
121 static void write_note_data(int fd
, const unsigned char *sha1
)
124 enum object_type type
;
125 char *buf
= read_sha1_file(sha1
, &type
, &size
);
128 write_or_die(fd
, buf
, size
);
133 static void write_commented_object(int fd
, const unsigned char *object
)
135 const char *show_args
[5] =
136 {"show", "--stat", "--no-notes", sha1_to_hex(object
), NULL
};
137 struct child_process show
;
138 struct strbuf buf
= STRBUF_INIT
;
141 /* Invoke "git show --stat --no-notes $object" */
142 memset(&show
, 0, sizeof(show
));
143 show
.argv
= show_args
;
148 if (start_command(&show
))
149 die("unable to start 'show' for object '%s'",
150 sha1_to_hex(object
));
152 /* Open the output as FILE* so strbuf_getline() can be used. */
153 show_out
= xfdopen(show
.out
, "r");
154 if (show_out
== NULL
)
155 die_errno("can't fdopen 'show' output fd");
157 /* Prepend "# " to each output line and write result to 'fd' */
158 while (strbuf_getline(&buf
, show_out
, '\n') != EOF
) {
159 write_or_die(fd
, "# ", 2);
160 write_or_die(fd
, buf
.buf
, buf
.len
);
161 write_or_die(fd
, "\n", 1);
163 strbuf_release(&buf
);
164 if (fclose(show_out
))
165 die_errno("failed to close pipe to 'show' for object '%s'",
166 sha1_to_hex(object
));
167 if (finish_command(&show
))
168 die("failed to finish 'show' for object '%s'",
169 sha1_to_hex(object
));
172 static void create_note(const unsigned char *object
, struct msg_arg
*msg
,
173 int append_only
, const unsigned char *prev
,
174 unsigned char *result
)
178 if (msg
->use_editor
|| !msg
->given
) {
181 /* write the template message before editing: */
182 path
= git_pathdup("NOTES_EDITMSG");
183 fd
= open(path
, O_CREAT
| O_TRUNC
| O_WRONLY
, 0600);
185 die_errno("could not create file '%s'", path
);
188 write_or_die(fd
, msg
->buf
.buf
, msg
->buf
.len
);
189 else if (prev
&& !append_only
)
190 write_note_data(fd
, prev
);
191 write_or_die(fd
, note_template
, strlen(note_template
));
193 write_commented_object(fd
, object
);
196 strbuf_reset(&(msg
->buf
));
198 if (launch_editor(path
, &(msg
->buf
), NULL
)) {
199 die("Please supply the note contents using either -m" \
202 stripspace(&(msg
->buf
), 1);
205 if (prev
&& append_only
) {
206 /* Append buf to previous note contents */
208 enum object_type type
;
209 char *prev_buf
= read_sha1_file(prev
, &type
, &size
);
211 strbuf_grow(&(msg
->buf
), size
+ 1);
212 if (msg
->buf
.len
&& prev_buf
&& size
)
213 strbuf_insert(&(msg
->buf
), 0, "\n", 1);
214 if (prev_buf
&& size
)
215 strbuf_insert(&(msg
->buf
), 0, prev_buf
, size
);
220 fprintf(stderr
, "Removing note for object %s\n",
221 sha1_to_hex(object
));
224 if (write_sha1_file(msg
->buf
.buf
, msg
->buf
.len
, blob_type
, result
)) {
225 error("unable to write note object");
227 error("The note contents has been left in %s",
234 unlink_or_warn(path
);
239 static int parse_msg_arg(const struct option
*opt
, const char *arg
, int unset
)
241 struct msg_arg
*msg
= opt
->value
;
243 strbuf_grow(&(msg
->buf
), strlen(arg
) + 2);
245 strbuf_addch(&(msg
->buf
), '\n');
246 strbuf_addstr(&(msg
->buf
), arg
);
247 stripspace(&(msg
->buf
), 0);
253 static int parse_file_arg(const struct option
*opt
, const char *arg
, int unset
)
255 struct msg_arg
*msg
= opt
->value
;
258 strbuf_addch(&(msg
->buf
), '\n');
259 if (!strcmp(arg
, "-")) {
260 if (strbuf_read(&(msg
->buf
), 0, 1024) < 0)
261 die_errno("cannot read '%s'", arg
);
262 } else if (strbuf_read_file(&(msg
->buf
), arg
, 1024) < 0)
263 die_errno("could not open or read '%s'", arg
);
264 stripspace(&(msg
->buf
), 0);
270 static int parse_reuse_arg(const struct option
*opt
, const char *arg
, int unset
)
272 struct msg_arg
*msg
= opt
->value
;
274 unsigned char object
[20];
275 enum object_type type
;
279 strbuf_addch(&(msg
->buf
), '\n');
281 if (get_sha1(arg
, object
))
282 die("Failed to resolve '%s' as a valid ref.", arg
);
283 if (!(buf
= read_sha1_file(object
, &type
, &len
)) || !len
) {
285 die("Failed to read object '%s'.", arg
);;
287 strbuf_add(&(msg
->buf
), buf
, len
);
294 static int parse_reedit_arg(const struct option
*opt
, const char *arg
, int unset
)
296 struct msg_arg
*msg
= opt
->value
;
298 return parse_reuse_arg(opt
, arg
, unset
);
301 void commit_notes(struct notes_tree
*t
, const char *msg
)
303 struct strbuf buf
= STRBUF_INIT
;
304 unsigned char commit_sha1
[20];
307 t
= &default_notes_tree
;
308 if (!t
->initialized
|| !t
->ref
|| !*t
->ref
)
309 die("Cannot commit uninitialized/unreferenced notes tree");
311 return; /* don't have to commit an unchanged tree */
313 /* Prepare commit message and reflog message */
314 strbuf_addstr(&buf
, "notes: "); /* commit message starts at index 7 */
315 strbuf_addstr(&buf
, msg
);
316 if (buf
.buf
[buf
.len
- 1] != '\n')
317 strbuf_addch(&buf
, '\n'); /* Make sure msg ends with newline */
319 create_notes_commit(t
, NULL
, buf
.buf
+ 7, commit_sha1
);
320 update_ref(buf
.buf
, t
->ref
, commit_sha1
, NULL
, 0, DIE_ON_ERR
);
322 strbuf_release(&buf
);
325 combine_notes_fn
parse_combine_notes_fn(const char *v
)
327 if (!strcasecmp(v
, "overwrite"))
328 return combine_notes_overwrite
;
329 else if (!strcasecmp(v
, "ignore"))
330 return combine_notes_ignore
;
331 else if (!strcasecmp(v
, "concatenate"))
332 return combine_notes_concatenate
;
333 else if (!strcasecmp(v
, "cat_sort_uniq"))
334 return combine_notes_cat_sort_uniq
;
339 static int notes_rewrite_config(const char *k
, const char *v
, void *cb
)
341 struct notes_rewrite_cfg
*c
= cb
;
342 if (!prefixcmp(k
, "notes.rewrite.") && !strcmp(k
+14, c
->cmd
)) {
343 c
->enabled
= git_config_bool(k
, v
);
345 } else if (!c
->mode_from_env
&& !strcmp(k
, "notes.rewritemode")) {
347 config_error_nonbool(k
);
348 c
->combine
= parse_combine_notes_fn(v
);
350 error("Bad notes.rewriteMode value: '%s'", v
);
354 } else if (!c
->refs_from_env
&& !strcmp(k
, "notes.rewriteref")) {
355 /* note that a refs/ prefix is implied in the
356 * underlying for_each_glob_ref */
357 if (!prefixcmp(v
, "refs/notes/"))
358 string_list_add_refs_by_glob(c
->refs
, v
);
360 warning("Refusing to rewrite notes in %s"
361 " (outside of refs/notes/)", v
);
369 struct notes_rewrite_cfg
*init_copy_notes_for_rewrite(const char *cmd
)
371 struct notes_rewrite_cfg
*c
= xmalloc(sizeof(struct notes_rewrite_cfg
));
372 const char *rewrite_mode_env
= getenv(GIT_NOTES_REWRITE_MODE_ENVIRONMENT
);
373 const char *rewrite_refs_env
= getenv(GIT_NOTES_REWRITE_REF_ENVIRONMENT
);
376 c
->combine
= combine_notes_concatenate
;
377 c
->refs
= xcalloc(1, sizeof(struct string_list
));
378 c
->refs
->strdup_strings
= 1;
379 c
->refs_from_env
= 0;
380 c
->mode_from_env
= 0;
381 if (rewrite_mode_env
) {
382 c
->mode_from_env
= 1;
383 c
->combine
= parse_combine_notes_fn(rewrite_mode_env
);
385 error("Bad " GIT_NOTES_REWRITE_MODE_ENVIRONMENT
386 " value: '%s'", rewrite_mode_env
);
388 if (rewrite_refs_env
) {
389 c
->refs_from_env
= 1;
390 string_list_add_refs_from_colon_sep(c
->refs
, rewrite_refs_env
);
392 git_config(notes_rewrite_config
, c
);
393 if (!c
->enabled
|| !c
->refs
->nr
) {
394 string_list_clear(c
->refs
, 0);
399 c
->trees
= load_notes_trees(c
->refs
);
400 string_list_clear(c
->refs
, 0);
405 int copy_note_for_rewrite(struct notes_rewrite_cfg
*c
,
406 const unsigned char *from_obj
, const unsigned char *to_obj
)
410 for (i
= 0; c
->trees
[i
]; i
++)
411 ret
= copy_note(c
->trees
[i
], from_obj
, to_obj
, 1, c
->combine
) || ret
;
415 void finish_copy_notes_for_rewrite(struct notes_rewrite_cfg
*c
)
418 for (i
= 0; c
->trees
[i
]; i
++) {
419 commit_notes(c
->trees
[i
], "Notes added by 'git notes copy'");
420 free_notes(c
->trees
[i
]);
426 static int notes_copy_from_stdin(int force
, const char *rewrite_cmd
)
428 struct strbuf buf
= STRBUF_INIT
;
429 struct notes_rewrite_cfg
*c
= NULL
;
430 struct notes_tree
*t
= NULL
;
434 c
= init_copy_notes_for_rewrite(rewrite_cmd
);
438 init_notes(NULL
, NULL
, NULL
, 0);
439 t
= &default_notes_tree
;
442 while (strbuf_getline(&buf
, stdin
, '\n') != EOF
) {
443 unsigned char from_obj
[20], to_obj
[20];
444 struct strbuf
**split
;
447 split
= strbuf_split(&buf
, ' ');
448 if (!split
[0] || !split
[1])
449 die("Malformed input line: '%s'.", buf
.buf
);
450 strbuf_rtrim(split
[0]);
451 strbuf_rtrim(split
[1]);
452 if (get_sha1(split
[0]->buf
, from_obj
))
453 die("Failed to resolve '%s' as a valid ref.", split
[0]->buf
);
454 if (get_sha1(split
[1]->buf
, to_obj
))
455 die("Failed to resolve '%s' as a valid ref.", split
[1]->buf
);
458 err
= copy_note_for_rewrite(c
, from_obj
, to_obj
);
460 err
= copy_note(t
, from_obj
, to_obj
, force
,
461 combine_notes_overwrite
);
464 error("Failed to copy notes from '%s' to '%s'",
465 split
[0]->buf
, split
[1]->buf
);
469 strbuf_list_free(split
);
473 commit_notes(t
, "Notes added by 'git notes copy'");
476 finish_copy_notes_for_rewrite(c
);
481 static struct notes_tree
*init_notes_check(const char *subcommand
)
483 struct notes_tree
*t
;
484 init_notes(NULL
, NULL
, NULL
, 0);
485 t
= &default_notes_tree
;
487 if (prefixcmp(t
->ref
, "refs/notes/"))
488 die("Refusing to %s notes in %s (outside of refs/notes/)",
493 static int list(int argc
, const char **argv
, const char *prefix
)
495 struct notes_tree
*t
;
496 unsigned char object
[20];
497 const unsigned char *note
;
499 struct option options
[] = {
504 argc
= parse_options(argc
, argv
, prefix
, options
,
505 git_notes_list_usage
, 0);
508 error("too many parameters");
509 usage_with_options(git_notes_list_usage
, options
);
512 t
= init_notes_check("list");
514 if (get_sha1(argv
[0], object
))
515 die("Failed to resolve '%s' as a valid ref.", argv
[0]);
516 note
= get_note(t
, object
);
518 puts(sha1_to_hex(note
));
521 retval
= error("No note found for object %s.",
522 sha1_to_hex(object
));
524 retval
= for_each_note(t
, 0, list_each_note
, NULL
);
530 static int append_edit(int argc
, const char **argv
, const char *prefix
);
532 static int add(int argc
, const char **argv
, const char *prefix
)
534 int retval
= 0, force
= 0;
535 const char *object_ref
;
536 struct notes_tree
*t
;
537 unsigned char object
[20], new_note
[20];
539 const unsigned char *note
;
540 struct msg_arg msg
= { 0, 0, STRBUF_INIT
};
541 struct option options
[] = {
542 { OPTION_CALLBACK
, 'm', "message", &msg
, "msg",
543 "note contents as a string", PARSE_OPT_NONEG
,
545 { OPTION_CALLBACK
, 'F', "file", &msg
, "file",
546 "note contents in a file", PARSE_OPT_NONEG
,
548 { OPTION_CALLBACK
, 'c', "reedit-message", &msg
, "object",
549 "reuse and edit specified note object", PARSE_OPT_NONEG
,
551 { OPTION_CALLBACK
, 'C', "reuse-message", &msg
, "object",
552 "reuse specified note object", PARSE_OPT_NONEG
,
554 OPT__FORCE(&force
, "replace existing notes"),
558 argc
= parse_options(argc
, argv
, prefix
, options
, git_notes_add_usage
,
559 PARSE_OPT_KEEP_ARGV0
);
562 error("too many parameters");
563 usage_with_options(git_notes_add_usage
, options
);
566 object_ref
= argc
> 1 ? argv
[1] : "HEAD";
568 if (get_sha1(object_ref
, object
))
569 die("Failed to resolve '%s' as a valid ref.", object_ref
);
571 t
= init_notes_check("add");
572 note
= get_note(t
, object
);
578 * Redirect to "edit" subcommand.
580 * We only end up here if none of -m/-F/-c/-C
581 * or -f are given. The original args are
582 * therefore still in argv[0-1].
586 return append_edit(argc
, argv
, prefix
);
588 retval
= error("Cannot add notes. Found existing notes "
589 "for object %s. Use '-f' to overwrite "
590 "existing notes", sha1_to_hex(object
));
593 fprintf(stderr
, "Overwriting existing notes for object %s\n",
594 sha1_to_hex(object
));
597 create_note(object
, &msg
, 0, note
, new_note
);
599 if (is_null_sha1(new_note
))
600 remove_note(t
, object
);
601 else if (add_note(t
, object
, new_note
, combine_notes_overwrite
))
602 die("BUG: combine_notes_overwrite failed");
604 snprintf(logmsg
, sizeof(logmsg
), "Notes %s by 'git notes %s'",
605 is_null_sha1(new_note
) ? "removed" : "added", "add");
606 commit_notes(t
, logmsg
);
609 strbuf_release(&(msg
.buf
));
613 static int copy(int argc
, const char **argv
, const char *prefix
)
615 int retval
= 0, force
= 0, from_stdin
= 0;
616 const unsigned char *from_note
, *note
;
617 const char *object_ref
;
618 unsigned char object
[20], from_obj
[20];
619 struct notes_tree
*t
;
620 const char *rewrite_cmd
= NULL
;
621 struct option options
[] = {
622 OPT__FORCE(&force
, "replace existing notes"),
623 OPT_BOOLEAN(0, "stdin", &from_stdin
, "read objects from stdin"),
624 OPT_STRING(0, "for-rewrite", &rewrite_cmd
, "command",
625 "load rewriting config for <command> (implies "
630 argc
= parse_options(argc
, argv
, prefix
, options
, git_notes_copy_usage
,
633 if (from_stdin
|| rewrite_cmd
) {
635 error("too many parameters");
636 usage_with_options(git_notes_copy_usage
, options
);
638 return notes_copy_from_stdin(force
, rewrite_cmd
);
643 error("too few parameters");
644 usage_with_options(git_notes_copy_usage
, options
);
647 error("too many parameters");
648 usage_with_options(git_notes_copy_usage
, options
);
651 if (get_sha1(argv
[0], from_obj
))
652 die("Failed to resolve '%s' as a valid ref.", argv
[0]);
654 object_ref
= 1 < argc
? argv
[1] : "HEAD";
656 if (get_sha1(object_ref
, object
))
657 die("Failed to resolve '%s' as a valid ref.", object_ref
);
659 t
= init_notes_check("copy");
660 note
= get_note(t
, object
);
664 retval
= error("Cannot copy notes. Found existing "
665 "notes for object %s. Use '-f' to "
666 "overwrite existing notes",
667 sha1_to_hex(object
));
670 fprintf(stderr
, "Overwriting existing notes for object %s\n",
671 sha1_to_hex(object
));
674 from_note
= get_note(t
, from_obj
);
676 retval
= error("Missing notes on source object %s. Cannot "
677 "copy.", sha1_to_hex(from_obj
));
681 if (add_note(t
, object
, from_note
, combine_notes_overwrite
))
682 die("BUG: combine_notes_overwrite failed");
683 commit_notes(t
, "Notes added by 'git notes copy'");
689 static int append_edit(int argc
, const char **argv
, const char *prefix
)
691 const char *object_ref
;
692 struct notes_tree
*t
;
693 unsigned char object
[20], new_note
[20];
694 const unsigned char *note
;
696 const char * const *usage
;
697 struct msg_arg msg
= { 0, 0, STRBUF_INIT
};
698 struct option options
[] = {
699 { OPTION_CALLBACK
, 'm', "message", &msg
, "msg",
700 "note contents as a string", PARSE_OPT_NONEG
,
702 { OPTION_CALLBACK
, 'F', "file", &msg
, "file",
703 "note contents in a file", PARSE_OPT_NONEG
,
705 { OPTION_CALLBACK
, 'c', "reedit-message", &msg
, "object",
706 "reuse and edit specified note object", PARSE_OPT_NONEG
,
708 { OPTION_CALLBACK
, 'C', "reuse-message", &msg
, "object",
709 "reuse specified note object", PARSE_OPT_NONEG
,
713 int edit
= !strcmp(argv
[0], "edit");
715 usage
= edit
? git_notes_edit_usage
: git_notes_append_usage
;
716 argc
= parse_options(argc
, argv
, prefix
, options
, usage
,
717 PARSE_OPT_KEEP_ARGV0
);
720 error("too many parameters");
721 usage_with_options(usage
, options
);
724 if (msg
.given
&& edit
)
725 fprintf(stderr
, "The -m/-F/-c/-C options have been deprecated "
726 "for the 'edit' subcommand.\n"
727 "Please use 'git notes add -f -m/-F/-c/-C' instead.\n");
729 object_ref
= 1 < argc
? argv
[1] : "HEAD";
731 if (get_sha1(object_ref
, object
))
732 die("Failed to resolve '%s' as a valid ref.", object_ref
);
734 t
= init_notes_check(argv
[0]);
735 note
= get_note(t
, object
);
737 create_note(object
, &msg
, !edit
, note
, new_note
);
739 if (is_null_sha1(new_note
))
740 remove_note(t
, object
);
741 else if (add_note(t
, object
, new_note
, combine_notes_overwrite
))
742 die("BUG: combine_notes_overwrite failed");
744 snprintf(logmsg
, sizeof(logmsg
), "Notes %s by 'git notes %s'",
745 is_null_sha1(new_note
) ? "removed" : "added", argv
[0]);
746 commit_notes(t
, logmsg
);
748 strbuf_release(&(msg
.buf
));
752 static int show(int argc
, const char **argv
, const char *prefix
)
754 const char *object_ref
;
755 struct notes_tree
*t
;
756 unsigned char object
[20];
757 const unsigned char *note
;
759 struct option options
[] = {
763 argc
= parse_options(argc
, argv
, prefix
, options
, git_notes_show_usage
,
767 error("too many parameters");
768 usage_with_options(git_notes_show_usage
, options
);
771 object_ref
= argc
? argv
[0] : "HEAD";
773 if (get_sha1(object_ref
, object
))
774 die("Failed to resolve '%s' as a valid ref.", object_ref
);
776 t
= init_notes_check("show");
777 note
= get_note(t
, object
);
780 retval
= error("No note found for object %s.",
781 sha1_to_hex(object
));
783 const char *show_args
[3] = {"show", sha1_to_hex(note
), NULL
};
784 retval
= execv_git_cmd(show_args
);
790 static int merge_abort(struct notes_merge_options
*o
)
795 * Remove .git/NOTES_MERGE_PARTIAL and .git/NOTES_MERGE_REF, and call
796 * notes_merge_abort() to remove .git/NOTES_MERGE_WORKTREE.
799 if (delete_ref("NOTES_MERGE_PARTIAL", NULL
, 0))
800 ret
+= error("Failed to delete ref NOTES_MERGE_PARTIAL");
801 if (delete_ref("NOTES_MERGE_REF", NULL
, REF_NODEREF
))
802 ret
+= error("Failed to delete ref NOTES_MERGE_REF");
803 if (notes_merge_abort(o
))
804 ret
+= error("Failed to remove 'git notes merge' worktree");
808 static int merge_commit(struct notes_merge_options
*o
)
810 struct strbuf msg
= STRBUF_INIT
;
811 unsigned char sha1
[20], parent_sha1
[20];
812 struct notes_tree
*t
;
813 struct commit
*partial
;
814 struct pretty_print_context pretty_ctx
;
817 * Read partial merge result from .git/NOTES_MERGE_PARTIAL,
818 * and target notes ref from .git/NOTES_MERGE_REF.
821 if (get_sha1("NOTES_MERGE_PARTIAL", sha1
))
822 die("Failed to read ref NOTES_MERGE_PARTIAL");
823 else if (!(partial
= lookup_commit_reference(sha1
)))
824 die("Could not find commit from NOTES_MERGE_PARTIAL.");
825 else if (parse_commit(partial
))
826 die("Could not parse commit from NOTES_MERGE_PARTIAL.");
828 if (partial
->parents
)
829 hashcpy(parent_sha1
, partial
->parents
->item
->object
.sha1
);
831 hashclr(parent_sha1
);
833 t
= xcalloc(1, sizeof(struct notes_tree
));
834 init_notes(t
, "NOTES_MERGE_PARTIAL", combine_notes_overwrite
, 0);
836 o
->local_ref
= resolve_ref("NOTES_MERGE_REF", sha1
, 0, NULL
);
838 die("Failed to resolve NOTES_MERGE_REF");
840 if (notes_merge_commit(o
, t
, partial
, sha1
))
841 die("Failed to finalize notes merge");
843 /* Reuse existing commit message in reflog message */
844 memset(&pretty_ctx
, 0, sizeof(pretty_ctx
));
845 format_commit_message(partial
, "%s", &msg
, &pretty_ctx
);
847 strbuf_insert(&msg
, 0, "notes: ", 7);
848 update_ref(msg
.buf
, o
->local_ref
, sha1
,
849 is_null_sha1(parent_sha1
) ? NULL
: parent_sha1
,
853 strbuf_release(&msg
);
854 return merge_abort(o
);
857 static int merge(int argc
, const char **argv
, const char *prefix
)
859 struct strbuf remote_ref
= STRBUF_INIT
, msg
= STRBUF_INIT
;
860 unsigned char result_sha1
[20];
861 struct notes_tree
*t
;
862 struct notes_merge_options o
;
863 int do_merge
= 0, do_commit
= 0, do_abort
= 0;
864 int verbosity
= 0, result
;
865 const char *strategy
= NULL
;
866 struct option options
[] = {
867 OPT_GROUP("General options"),
868 OPT__VERBOSITY(&verbosity
),
869 OPT_GROUP("Merge options"),
870 OPT_STRING('s', "strategy", &strategy
, "strategy",
871 "resolve notes conflicts using the given strategy "
872 "(manual/ours/theirs/union/cat_sort_uniq)"),
873 OPT_GROUP("Committing unmerged notes"),
874 { OPTION_BOOLEAN
, 0, "commit", &do_commit
, NULL
,
875 "finalize notes merge by committing unmerged notes",
876 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
},
877 OPT_GROUP("Aborting notes merge resolution"),
878 { OPTION_BOOLEAN
, 0, "abort", &do_abort
, NULL
,
880 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
},
884 argc
= parse_options(argc
, argv
, prefix
, options
,
885 git_notes_merge_usage
, 0);
887 if (strategy
|| do_commit
+ do_abort
== 0)
889 if (do_merge
+ do_commit
+ do_abort
!= 1) {
890 error("cannot mix --commit, --abort or -s/--strategy");
891 usage_with_options(git_notes_merge_usage
, options
);
894 if (do_merge
&& argc
!= 1) {
895 error("Must specify a notes ref to merge");
896 usage_with_options(git_notes_merge_usage
, options
);
897 } else if (!do_merge
&& argc
) {
898 error("too many parameters");
899 usage_with_options(git_notes_merge_usage
, options
);
902 init_notes_merge_options(&o
);
903 o
.verbosity
= verbosity
+ NOTES_MERGE_VERBOSITY_DEFAULT
;
906 return merge_abort(&o
);
908 return merge_commit(&o
);
910 o
.local_ref
= default_notes_ref();
911 strbuf_addstr(&remote_ref
, argv
[0]);
912 expand_notes_ref(&remote_ref
);
913 o
.remote_ref
= remote_ref
.buf
;
916 if (!strcmp(strategy
, "manual"))
917 o
.strategy
= NOTES_MERGE_RESOLVE_MANUAL
;
918 else if (!strcmp(strategy
, "ours"))
919 o
.strategy
= NOTES_MERGE_RESOLVE_OURS
;
920 else if (!strcmp(strategy
, "theirs"))
921 o
.strategy
= NOTES_MERGE_RESOLVE_THEIRS
;
922 else if (!strcmp(strategy
, "union"))
923 o
.strategy
= NOTES_MERGE_RESOLVE_UNION
;
924 else if (!strcmp(strategy
, "cat_sort_uniq"))
925 o
.strategy
= NOTES_MERGE_RESOLVE_CAT_SORT_UNIQ
;
927 error("Unknown -s/--strategy: %s", strategy
);
928 usage_with_options(git_notes_merge_usage
, options
);
932 t
= init_notes_check("merge");
934 strbuf_addf(&msg
, "notes: Merged notes from %s into %s",
935 remote_ref
.buf
, default_notes_ref());
936 strbuf_add(&(o
.commit_msg
), msg
.buf
+ 7, msg
.len
- 7); /* skip "notes: " */
938 result
= notes_merge(&o
, t
, result_sha1
);
940 if (result
>= 0) /* Merge resulted (trivially) in result_sha1 */
941 /* Update default notes ref with new commit */
942 update_ref(msg
.buf
, default_notes_ref(), result_sha1
, NULL
,
944 else { /* Merge has unresolved conflicts */
945 /* Update .git/NOTES_MERGE_PARTIAL with partial merge result */
946 update_ref(msg
.buf
, "NOTES_MERGE_PARTIAL", result_sha1
, NULL
,
948 /* Store ref-to-be-updated into .git/NOTES_MERGE_REF */
949 if (create_symref("NOTES_MERGE_REF", default_notes_ref(), NULL
))
950 die("Failed to store link to current notes ref (%s)",
951 default_notes_ref());
952 printf("Automatic notes merge failed. Fix conflicts in %s and "
953 "commit the result with 'git notes merge --commit', or "
954 "abort the merge with 'git notes merge --abort'.\n",
955 git_path(NOTES_MERGE_WORKTREE
));
959 strbuf_release(&remote_ref
);
960 strbuf_release(&msg
);
961 return result
< 0; /* return non-zero on conflicts */
964 static int remove_cmd(int argc
, const char **argv
, const char *prefix
)
966 struct option options
[] = {
969 const char *object_ref
;
970 struct notes_tree
*t
;
971 unsigned char object
[20];
974 argc
= parse_options(argc
, argv
, prefix
, options
,
975 git_notes_remove_usage
, 0);
978 error("too many parameters");
979 usage_with_options(git_notes_remove_usage
, options
);
982 object_ref
= argc
? argv
[0] : "HEAD";
984 if (get_sha1(object_ref
, object
))
985 die("Failed to resolve '%s' as a valid ref.", object_ref
);
987 t
= init_notes_check("remove");
989 retval
= remove_note(t
, object
);
991 fprintf(stderr
, "Object %s has no note\n", sha1_to_hex(object
));
993 fprintf(stderr
, "Removing note for object %s\n",
994 sha1_to_hex(object
));
996 commit_notes(t
, "Notes removed by 'git notes remove'");
1002 static int prune(int argc
, const char **argv
, const char *prefix
)
1004 struct notes_tree
*t
;
1005 int show_only
= 0, verbose
= 0;
1006 struct option options
[] = {
1007 OPT__DRY_RUN(&show_only
, "do not remove, show only"),
1008 OPT__VERBOSE(&verbose
, "report pruned notes"),
1012 argc
= parse_options(argc
, argv
, prefix
, options
, git_notes_prune_usage
,
1016 error("too many parameters");
1017 usage_with_options(git_notes_prune_usage
, options
);
1020 t
= init_notes_check("prune");
1022 prune_notes(t
, (verbose
? NOTES_PRUNE_VERBOSE
: 0) |
1023 (show_only
? NOTES_PRUNE_VERBOSE
|NOTES_PRUNE_DRYRUN
: 0) );
1025 commit_notes(t
, "Notes removed by 'git notes prune'");
1030 static int get_ref(int argc
, const char **argv
, const char *prefix
)
1032 struct option options
[] = { OPT_END() };
1033 argc
= parse_options(argc
, argv
, prefix
, options
,
1034 git_notes_get_ref_usage
, 0);
1037 error("too many parameters");
1038 usage_with_options(git_notes_get_ref_usage
, options
);
1041 puts(default_notes_ref());
1045 int cmd_notes(int argc
, const char **argv
, const char *prefix
)
1048 const char *override_notes_ref
= NULL
;
1049 struct option options
[] = {
1050 OPT_STRING(0, "ref", &override_notes_ref
, "notes_ref",
1051 "use notes from <notes_ref>"),
1055 git_config(git_default_config
, NULL
);
1056 argc
= parse_options(argc
, argv
, prefix
, options
, git_notes_usage
,
1057 PARSE_OPT_STOP_AT_NON_OPTION
);
1059 if (override_notes_ref
) {
1060 struct strbuf sb
= STRBUF_INIT
;
1061 strbuf_addstr(&sb
, override_notes_ref
);
1062 expand_notes_ref(&sb
);
1063 setenv("GIT_NOTES_REF", sb
.buf
, 1);
1064 strbuf_release(&sb
);
1067 if (argc
< 1 || !strcmp(argv
[0], "list"))
1068 result
= list(argc
, argv
, prefix
);
1069 else if (!strcmp(argv
[0], "add"))
1070 result
= add(argc
, argv
, prefix
);
1071 else if (!strcmp(argv
[0], "copy"))
1072 result
= copy(argc
, argv
, prefix
);
1073 else if (!strcmp(argv
[0], "append") || !strcmp(argv
[0], "edit"))
1074 result
= append_edit(argc
, argv
, prefix
);
1075 else if (!strcmp(argv
[0], "show"))
1076 result
= show(argc
, argv
, prefix
);
1077 else if (!strcmp(argv
[0], "merge"))
1078 result
= merge(argc
, argv
, prefix
);
1079 else if (!strcmp(argv
[0], "remove"))
1080 result
= remove_cmd(argc
, argv
, prefix
);
1081 else if (!strcmp(argv
[0], "prune"))
1082 result
= prune(argc
, argv
, prefix
);
1083 else if (!strcmp(argv
[0], "get-ref"))
1084 result
= get_ref(argc
, argv
, prefix
);
1086 result
= error("Unknown subcommand: %s", argv
[0]);
1087 usage_with_options(git_notes_usage
, options
);
1090 return result
? 1 : 0;