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"
20 static const char * const git_notes_usage[] = {
21 "git notes [list [<object>]]",
22 "git notes add [-f] [-m <msg> | -F <file> | (-c | -C) <object>] [<object>]",
23 "git notes copy [-f] <from-object> <to-object>",
24 "git notes append [-m <msg> | -F <file> | (-c | -C) <object>] [<object>]",
25 "git notes edit [<object>]",
26 "git notes show [<object>]",
27 "git notes remove [<object>]",
32 static const char note_template[] =
35 "# Write/edit the notes for the following object:\n"
44 static int list_each_note(const unsigned char *object_sha1,
45 const unsigned char *note_sha1, char *note_path,
48 printf("%s %s\n", sha1_to_hex(note_sha1), sha1_to_hex(object_sha1));
52 static void write_note_data(int fd, const unsigned char *sha1)
55 enum object_type type;
56 char *buf = read_sha1_file(sha1, &type, &size);
59 write_or_die(fd, buf, size);
64 static void write_commented_object(int fd, const unsigned char *object)
66 const char *show_args[5] =
67 {"show", "--stat", "--no-notes", sha1_to_hex(object), NULL};
68 struct child_process show;
69 struct strbuf buf = STRBUF_INIT;
72 /* Invoke "git show --stat --no-notes $object" */
73 memset(&show, 0, sizeof(show));
74 show.argv = show_args;
79 if (start_command(&show))
80 die("unable to start 'show' for object '%s'",
83 /* Open the output as FILE* so strbuf_getline() can be used. */
84 show_out = xfdopen(show.out, "r");
86 die_errno("can't fdopen 'show' output fd");
88 /* Prepend "# " to each output line and write result to 'fd' */
89 while (strbuf_getline(&buf, show_out, '\n') != EOF) {
90 write_or_die(fd, "# ", 2);
91 write_or_die(fd, buf.buf, buf.len);
92 write_or_die(fd, "\n", 1);
96 die_errno("failed to close pipe to 'show' for object '%s'",
98 if (finish_command(&show))
99 die("failed to finish 'show' for object '%s'",
100 sha1_to_hex(object));
103 static void create_note(const unsigned char *object, struct msg_arg *msg,
104 int append_only, const unsigned char *prev,
105 unsigned char *result)
109 if (msg->use_editor || !msg->given) {
112 /* write the template message before editing: */
113 path = git_pathdup("NOTES_EDITMSG");
114 fd = open(path, O_CREAT | O_TRUNC | O_WRONLY, 0600);
116 die_errno("could not create file '%s'", path);
119 write_or_die(fd, msg->buf.buf, msg->buf.len);
120 else if (prev && !append_only)
121 write_note_data(fd, prev);
122 write_or_die(fd, note_template, strlen(note_template));
124 write_commented_object(fd, object);
127 strbuf_reset(&(msg->buf));
129 if (launch_editor(path, &(msg->buf), NULL)) {
130 die("Please supply the note contents using either -m" \
133 stripspace(&(msg->buf), 1);
136 if (prev && append_only) {
137 /* Append buf to previous note contents */
139 enum object_type type;
140 char *prev_buf = read_sha1_file(prev, &type, &size);
142 strbuf_grow(&(msg->buf), size + 1);
143 if (msg->buf.len && prev_buf && size)
144 strbuf_insert(&(msg->buf), 0, "\n", 1);
145 if (prev_buf && size)
146 strbuf_insert(&(msg->buf), 0, prev_buf, size);
151 fprintf(stderr, "Removing note for object %s\n",
152 sha1_to_hex(object));
155 if (write_sha1_file(msg->buf.buf, msg->buf.len, blob_type, result)) {
156 error("unable to write note object");
158 error("The note contents has been left in %s",
165 unlink_or_warn(path);
170 static int parse_msg_arg(const struct option *opt, const char *arg, int unset)
172 struct msg_arg *msg = opt->value;
177 strbuf_grow(&(msg->buf), strlen(arg) + 2);
179 strbuf_addstr(&(msg->buf), "\n");
180 strbuf_addstr(&(msg->buf), arg);
181 stripspace(&(msg->buf), 0);
187 static int parse_file_arg(const struct option *opt, const char *arg, int unset)
189 struct msg_arg *msg = opt->value;
195 strbuf_addstr(&(msg->buf), "\n");
196 if (!strcmp(arg, "-")) {
197 if (strbuf_read(&(msg->buf), 0, 1024) < 0)
198 die_errno("cannot read '%s'", arg);
199 } else if (strbuf_read_file(&(msg->buf), arg, 1024) < 0)
200 die_errno("could not open or read '%s'", arg);
201 stripspace(&(msg->buf), 0);
207 static int parse_reuse_arg(const struct option *opt, const char *arg, int unset)
209 struct msg_arg *msg = opt->value;
211 unsigned char object[20];
212 enum object_type type;
219 strbuf_addstr(&(msg->buf), "\n");
221 if (get_sha1(arg, object))
222 die("Failed to resolve '%s' as a valid ref.", arg);
223 if (!(buf = read_sha1_file(object, &type, &len)) || !len) {
225 die("Failed to read object '%s'.", arg);;
227 strbuf_add(&(msg->buf), buf, len);
234 static int parse_reedit_arg(const struct option *opt, const char *arg, int unset)
236 struct msg_arg *msg = opt->value;
238 return parse_reuse_arg(opt, arg, unset);
241 int commit_notes(struct notes_tree *t, const char *msg)
243 struct commit_list *parent;
244 unsigned char tree_sha1[20], prev_commit[20], new_commit[20];
245 struct strbuf buf = STRBUF_INIT;
248 t = &default_notes_tree;
249 if (!t->initialized || !t->ref || !*t->ref)
250 die("Cannot commit uninitialized/unreferenced notes tree");
252 /* Prepare commit message and reflog message */
253 strbuf_addstr(&buf, "notes: "); /* commit message starts at index 7 */
254 strbuf_addstr(&buf, msg);
255 if (buf.buf[buf.len - 1] != '\n')
256 strbuf_addch(&buf, '\n'); /* Make sure msg ends with newline */
258 /* Convert notes tree to tree object */
259 if (write_notes_tree(t, tree_sha1))
260 die("Failed to write current notes tree to database");
262 /* Create new commit for the tree object */
263 if (!read_ref(t->ref, prev_commit)) { /* retrieve parent commit */
264 parent = xmalloc(sizeof(*parent));
265 parent->item = lookup_commit(prev_commit);
268 hashclr(prev_commit);
271 if (commit_tree(buf.buf + 7, tree_sha1, parent, new_commit, NULL))
272 die("Failed to commit notes tree to database");
274 /* Update notes ref with new commit */
275 update_ref(buf.buf, t->ref, new_commit, prev_commit, 0, DIE_ON_ERR);
277 strbuf_release(&buf);
281 int cmd_notes(int argc, const char **argv, const char *prefix)
283 struct notes_tree *t;
284 unsigned char object[20], from_obj[20], new_note[20];
285 const unsigned char *note;
286 const char *object_ref;
289 int list = 0, add = 0, copy = 0, append = 0, edit = 0, show = 0,
290 remove = 0, prune = 0, force = 0;
291 int given_object = 0, i = 1, retval = 0;
292 struct msg_arg msg = { 0, 0, STRBUF_INIT };
293 struct option options[] = {
294 OPT_GROUP("Notes options"),
295 OPT_CALLBACK('m', "message", &msg, "MSG",
296 "note contents as a string", parse_msg_arg),
297 OPT_CALLBACK('F', "file", &msg, "FILE",
298 "note contents in a file", parse_file_arg),
299 OPT_CALLBACK('c', "reedit-message", &msg, "OBJECT",
300 "reuse and edit specified note object", parse_reedit_arg),
301 OPT_CALLBACK('C', "reuse-message", &msg, "OBJECT",
302 "reuse specified note object", parse_reuse_arg),
303 OPT_BOOLEAN('f', "force", &force, "replace existing notes"),
307 git_config(git_default_config, NULL);
309 argc = parse_options(argc, argv, prefix, options, git_notes_usage, 0);
311 if (argc && !strcmp(argv[0], "list"))
313 else if (argc && !strcmp(argv[0], "add"))
315 else if (argc && !strcmp(argv[0], "copy"))
317 else if (argc && !strcmp(argv[0], "append"))
319 else if (argc && !strcmp(argv[0], "edit"))
321 else if (argc && !strcmp(argv[0], "show"))
323 else if (argc && !strcmp(argv[0], "remove"))
325 else if (argc && !strcmp(argv[0], "prune"))
328 list = 1; /* Default to 'list' if no other subcommand given */
332 if (list + add + copy + append + edit + show + remove + prune != 1)
333 usage_with_options(git_notes_usage, options);
335 if (msg.given && !(add || append || edit)) {
336 error("cannot use -m/-F/-c/-C options with %s subcommand.",
338 usage_with_options(git_notes_usage, options);
341 if (msg.given && edit) {
342 fprintf(stderr, "The -m/-F/-c/-C options have been deprecated "
343 "for the 'edit' subcommand.\n"
344 "Please use 'git notes add -f -m/-F/-c/-C' instead.\n");
347 if (force && !(add || copy)) {
348 error("cannot use -f option with %s subcommand.", argv[0]);
349 usage_with_options(git_notes_usage, options);
353 const char *from_ref;
355 error("too few parameters");
356 usage_with_options(git_notes_usage, options);
358 from_ref = argv[i++];
359 if (get_sha1(from_ref, from_obj))
360 die("Failed to resolve '%s' as a valid ref.", from_ref);
363 given_object = argc > i;
364 object_ref = given_object ? argv[i++] : "HEAD";
366 if (argc > i || (prune && given_object)) {
367 error("too many parameters");
368 usage_with_options(git_notes_usage, options);
371 if (get_sha1(object_ref, object))
372 die("Failed to resolve '%s' as a valid ref.", object_ref);
374 init_notes(NULL, NULL, NULL, 0);
375 t = &default_notes_tree;
377 if (prefixcmp(t->ref, "refs/notes/"))
378 die("Refusing to %s notes in %s (outside of refs/notes/)",
381 note = get_note(t, object);
388 puts(sha1_to_hex(note));
392 retval = for_each_note(t, 0, list_each_note, NULL);
399 if ((list || show) && !note) {
400 error("No note found for object %s.", sha1_to_hex(object));
404 const char *show_args[3] = {"show", sha1_to_hex(note), NULL};
405 retval = execv_git_cmd(show_args);
409 /* add/append/edit/remove/prune command */
411 if ((add || copy) && note) {
413 error("Cannot %s notes. Found existing notes for object"
414 " %s. Use '-f' to overwrite existing notes",
415 argv[0], sha1_to_hex(object));
419 fprintf(stderr, "Overwriting existing notes for object %s\n",
420 sha1_to_hex(object));
426 strbuf_reset(&(msg.buf));
434 const unsigned char *from_note = get_note(t, from_obj);
436 error("Missing notes on source object %s. Cannot copy.",
437 sha1_to_hex(from_obj));
441 hashcpy(new_note, from_note);
443 create_note(object, &msg, append, note, new_note);
445 if (is_null_sha1(new_note))
446 remove_note(t, object);
448 add_note(t, object, new_note, combine_notes_overwrite);
451 snprintf(logmsg, sizeof(logmsg), "Notes %s by 'git notes %s'",
452 is_null_sha1(new_note) ? "removed" : "added", argv[0]);
453 commit_notes(t, logmsg);
457 strbuf_release(&(msg.buf));