User Manual: Write "Git" instead of "GIT"
[git/dscho.git] / builtin-commit.c
blobd525b894ec1211476707acb06bdebe25d5828dbb
1 /*
2 * Builtin "git commit"
4 * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>
5 * Based on git-commit.sh by Junio C Hamano and Linus Torvalds
6 */
8 #include "cache.h"
9 #include "cache-tree.h"
10 #include "color.h"
11 #include "dir.h"
12 #include "builtin.h"
13 #include "diff.h"
14 #include "diffcore.h"
15 #include "commit.h"
16 #include "revision.h"
17 #include "wt-status.h"
18 #include "run-command.h"
19 #include "refs.h"
20 #include "log-tree.h"
21 #include "strbuf.h"
22 #include "utf8.h"
23 #include "parse-options.h"
24 #include "string-list.h"
25 #include "rerere.h"
26 #include "unpack-trees.h"
28 static const char * const builtin_commit_usage[] = {
29 "git commit [options] [--] <filepattern>...",
30 NULL
33 static const char * const builtin_status_usage[] = {
34 "git status [options] [--] <filepattern>...",
35 NULL
38 static unsigned char head_sha1[20], merge_head_sha1[20];
39 static char *use_message_buffer;
40 static const char commit_editmsg[] = "COMMIT_EDITMSG";
41 static struct lock_file index_lock; /* real index */
42 static struct lock_file false_lock; /* used only for partial commits */
43 static enum {
44 COMMIT_AS_IS = 1,
45 COMMIT_NORMAL,
46 COMMIT_PARTIAL,
47 } commit_style;
49 static const char *logfile, *force_author;
50 static const char *template_file;
51 static char *edit_message, *use_message;
52 static char *author_name, *author_email, *author_date;
53 static int all, edit_flag, also, interactive, only, amend, signoff;
54 static int quiet, verbose, no_verify, allow_empty, dry_run;
55 static char *untracked_files_arg;
57 * The default commit message cleanup mode will remove the lines
58 * beginning with # (shell comments) and leading and trailing
59 * whitespaces (empty lines or containing only whitespaces)
60 * if editor is used, and only the whitespaces if the message
61 * is specified explicitly.
63 static enum {
64 CLEANUP_SPACE,
65 CLEANUP_NONE,
66 CLEANUP_ALL,
67 } cleanup_mode;
68 static char *cleanup_arg;
70 static int use_editor = 1, initial_commit, in_merge;
71 static const char *only_include_assumed;
72 static struct strbuf message;
74 static int opt_parse_m(const struct option *opt, const char *arg, int unset)
76 struct strbuf *buf = opt->value;
77 if (unset)
78 strbuf_setlen(buf, 0);
79 else {
80 strbuf_addstr(buf, arg);
81 strbuf_addstr(buf, "\n\n");
83 return 0;
86 static struct option builtin_commit_options[] = {
87 OPT__QUIET(&quiet),
88 OPT__VERBOSE(&verbose),
89 OPT_GROUP("Commit message options"),
91 OPT_FILENAME('F', "file", &logfile, "read log from file"),
92 OPT_STRING(0, "author", &force_author, "AUTHOR", "override author for commit"),
93 OPT_CALLBACK('m', "message", &message, "MESSAGE", "specify commit message", opt_parse_m),
94 OPT_STRING('c', "reedit-message", &edit_message, "COMMIT", "reuse and edit message from specified commit "),
95 OPT_STRING('C', "reuse-message", &use_message, "COMMIT", "reuse message from specified commit"),
96 OPT_BOOLEAN('s', "signoff", &signoff, "add Signed-off-by:"),
97 OPT_FILENAME('t', "template", &template_file, "use specified template file"),
98 OPT_BOOLEAN('e', "edit", &edit_flag, "force edit of commit"),
100 OPT_GROUP("Commit contents options"),
101 OPT_BOOLEAN('a', "all", &all, "commit all changed files"),
102 OPT_BOOLEAN('i', "include", &also, "add specified files to index for commit"),
103 OPT_BOOLEAN(0, "interactive", &interactive, "interactively add files"),
104 OPT_BOOLEAN('o', "only", &only, "commit only specified files"),
105 OPT_BOOLEAN('n', "no-verify", &no_verify, "bypass pre-commit hook"),
106 OPT_BOOLEAN(0, "dry-run", &dry_run, "show what would be committed"),
107 OPT_BOOLEAN(0, "amend", &amend, "amend previous commit"),
108 { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg, "mode", "show untracked files, optional modes: all, normal, no. (Default: all)", PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
109 OPT_BOOLEAN(0, "allow-empty", &allow_empty, "ok to record an empty change"),
110 OPT_STRING(0, "cleanup", &cleanup_arg, "default", "how to strip spaces and #comments from message"),
112 OPT_END()
115 static void rollback_index_files(void)
117 switch (commit_style) {
118 case COMMIT_AS_IS:
119 break; /* nothing to do */
120 case COMMIT_NORMAL:
121 rollback_lock_file(&index_lock);
122 break;
123 case COMMIT_PARTIAL:
124 rollback_lock_file(&index_lock);
125 rollback_lock_file(&false_lock);
126 break;
130 static int commit_index_files(void)
132 int err = 0;
134 switch (commit_style) {
135 case COMMIT_AS_IS:
136 break; /* nothing to do */
137 case COMMIT_NORMAL:
138 err = commit_lock_file(&index_lock);
139 break;
140 case COMMIT_PARTIAL:
141 err = commit_lock_file(&index_lock);
142 rollback_lock_file(&false_lock);
143 break;
146 return err;
150 * Take a union of paths in the index and the named tree (typically, "HEAD"),
151 * and return the paths that match the given pattern in list.
153 static int list_paths(struct string_list *list, const char *with_tree,
154 const char *prefix, const char **pattern)
156 int i;
157 char *m;
159 for (i = 0; pattern[i]; i++)
161 m = xcalloc(1, i);
163 if (with_tree)
164 overlay_tree_on_cache(with_tree, prefix);
166 for (i = 0; i < active_nr; i++) {
167 struct cache_entry *ce = active_cache[i];
168 if (ce->ce_flags & CE_UPDATE)
169 continue;
170 if (!match_pathspec(pattern, ce->name, ce_namelen(ce), 0, m))
171 continue;
172 string_list_insert(ce->name, list);
175 return report_path_error(m, pattern, prefix ? strlen(prefix) : 0);
178 static void add_remove_files(struct string_list *list)
180 int i;
181 for (i = 0; i < list->nr; i++) {
182 struct stat st;
183 struct string_list_item *p = &(list->items[i]);
185 if (!lstat(p->string, &st)) {
186 if (add_to_cache(p->string, &st, 0))
187 die("updating files failed");
188 } else
189 remove_file_from_cache(p->string);
193 static void create_base_index(void)
195 struct tree *tree;
196 struct unpack_trees_options opts;
197 struct tree_desc t;
199 if (initial_commit) {
200 discard_cache();
201 return;
204 memset(&opts, 0, sizeof(opts));
205 opts.head_idx = 1;
206 opts.index_only = 1;
207 opts.merge = 1;
208 opts.src_index = &the_index;
209 opts.dst_index = &the_index;
211 opts.fn = oneway_merge;
212 tree = parse_tree_indirect(head_sha1);
213 if (!tree)
214 die("failed to unpack HEAD tree object");
215 parse_tree(tree);
216 init_tree_desc(&t, tree->buffer, tree->size);
217 if (unpack_trees(1, &t, &opts))
218 exit(128); /* We've already reported the error, finish dying */
221 static char *prepare_index(int argc, const char **argv, const char *prefix, int is_status)
223 int fd;
224 struct string_list partial;
225 const char **pathspec = NULL;
226 int refresh_flags = REFRESH_QUIET;
228 if (is_status)
229 refresh_flags |= REFRESH_UNMERGED;
230 if (interactive) {
231 if (interactive_add(argc, argv, prefix) != 0)
232 die("interactive add failed");
233 if (read_cache_preload(NULL) < 0)
234 die("index file corrupt");
235 commit_style = COMMIT_AS_IS;
236 return get_index_file();
239 if (*argv)
240 pathspec = get_pathspec(prefix, argv);
242 if (read_cache_preload(pathspec) < 0)
243 die("index file corrupt");
246 * Non partial, non as-is commit.
248 * (1) get the real index;
249 * (2) update the_index as necessary;
250 * (3) write the_index out to the real index (still locked);
251 * (4) return the name of the locked index file.
253 * The caller should run hooks on the locked real index, and
254 * (A) if all goes well, commit the real index;
255 * (B) on failure, rollback the real index.
257 if (all || (also && pathspec && *pathspec)) {
258 int fd = hold_locked_index(&index_lock, 1);
259 add_files_to_cache(also ? prefix : NULL, pathspec, 0);
260 refresh_cache(refresh_flags);
261 if (write_cache(fd, active_cache, active_nr) ||
262 close_lock_file(&index_lock))
263 die("unable to write new_index file");
264 commit_style = COMMIT_NORMAL;
265 return index_lock.filename;
269 * As-is commit.
271 * (1) return the name of the real index file.
273 * The caller should run hooks on the real index, and run
274 * hooks on the real index, and create commit from the_index.
275 * We still need to refresh the index here.
277 if (!pathspec || !*pathspec) {
278 fd = hold_locked_index(&index_lock, 1);
279 refresh_cache(refresh_flags);
280 if (write_cache(fd, active_cache, active_nr) ||
281 commit_locked_index(&index_lock))
282 die("unable to write new_index file");
283 commit_style = COMMIT_AS_IS;
284 return get_index_file();
288 * A partial commit.
290 * (0) find the set of affected paths;
291 * (1) get lock on the real index file;
292 * (2) update the_index with the given paths;
293 * (3) write the_index out to the real index (still locked);
294 * (4) get lock on the false index file;
295 * (5) reset the_index from HEAD;
296 * (6) update the_index the same way as (2);
297 * (7) write the_index out to the false index file;
298 * (8) return the name of the false index file (still locked);
300 * The caller should run hooks on the locked false index, and
301 * create commit from it. Then
302 * (A) if all goes well, commit the real index;
303 * (B) on failure, rollback the real index;
304 * In either case, rollback the false index.
306 commit_style = COMMIT_PARTIAL;
308 if (file_exists(git_path("MERGE_HEAD")))
309 die("cannot do a partial commit during a merge.");
311 memset(&partial, 0, sizeof(partial));
312 partial.strdup_strings = 1;
313 if (list_paths(&partial, initial_commit ? NULL : "HEAD", prefix, pathspec))
314 exit(1);
316 discard_cache();
317 if (read_cache() < 0)
318 die("cannot read the index");
320 fd = hold_locked_index(&index_lock, 1);
321 add_remove_files(&partial);
322 refresh_cache(REFRESH_QUIET);
323 if (write_cache(fd, active_cache, active_nr) ||
324 close_lock_file(&index_lock))
325 die("unable to write new_index file");
327 fd = hold_lock_file_for_update(&false_lock,
328 git_path("next-index-%"PRIuMAX,
329 (uintmax_t) getpid()),
330 LOCK_DIE_ON_ERROR);
332 create_base_index();
333 add_remove_files(&partial);
334 refresh_cache(REFRESH_QUIET);
336 if (write_cache(fd, active_cache, active_nr) ||
337 close_lock_file(&false_lock))
338 die("unable to write temporary index file");
340 discard_cache();
341 read_cache_from(false_lock.filename);
343 return false_lock.filename;
346 static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn,
347 struct wt_status *s)
349 if (s->relative_paths)
350 s->prefix = prefix;
352 if (amend) {
353 s->amend = 1;
354 s->reference = "HEAD^1";
356 s->verbose = verbose;
357 s->index_file = index_file;
358 s->fp = fp;
359 s->nowarn = nowarn;
361 wt_status_print(s);
363 return s->commitable;
366 static int is_a_merge(const unsigned char *sha1)
368 struct commit *commit = lookup_commit(sha1);
369 if (!commit || parse_commit(commit))
370 die("could not parse HEAD commit");
371 return !!(commit->parents && commit->parents->next);
374 static const char sign_off_header[] = "Signed-off-by: ";
376 static void determine_author_info(void)
378 char *name, *email, *date;
380 name = getenv("GIT_AUTHOR_NAME");
381 email = getenv("GIT_AUTHOR_EMAIL");
382 date = getenv("GIT_AUTHOR_DATE");
384 if (use_message) {
385 const char *a, *lb, *rb, *eol;
387 a = strstr(use_message_buffer, "\nauthor ");
388 if (!a)
389 die("invalid commit: %s", use_message);
391 lb = strstr(a + 8, " <");
392 rb = strstr(a + 8, "> ");
393 eol = strchr(a + 8, '\n');
394 if (!lb || !rb || !eol)
395 die("invalid commit: %s", use_message);
397 name = xstrndup(a + 8, lb - (a + 8));
398 email = xstrndup(lb + 2, rb - (lb + 2));
399 date = xstrndup(rb + 2, eol - (rb + 2));
402 if (force_author) {
403 const char *lb = strstr(force_author, " <");
404 const char *rb = strchr(force_author, '>');
406 if (!lb || !rb)
407 die("malformed --author parameter");
408 name = xstrndup(force_author, lb - force_author);
409 email = xstrndup(lb + 2, rb - (lb + 2));
412 author_name = name;
413 author_email = email;
414 author_date = date;
417 static int ends_rfc2822_footer(struct strbuf *sb)
419 int ch;
420 int hit = 0;
421 int i, j, k;
422 int len = sb->len;
423 int first = 1;
424 const char *buf = sb->buf;
426 for (i = len - 1; i > 0; i--) {
427 if (hit && buf[i] == '\n')
428 break;
429 hit = (buf[i] == '\n');
432 while (i < len - 1 && buf[i] == '\n')
433 i++;
435 for (; i < len; i = k) {
436 for (k = i; k < len && buf[k] != '\n'; k++)
437 ; /* do nothing */
438 k++;
440 if ((buf[k] == ' ' || buf[k] == '\t') && !first)
441 continue;
443 first = 0;
445 for (j = 0; i + j < len; j++) {
446 ch = buf[i + j];
447 if (ch == ':')
448 break;
449 if (isalnum(ch) ||
450 (ch == '-'))
451 continue;
452 return 0;
455 return 1;
458 static int prepare_to_commit(const char *index_file, const char *prefix,
459 struct wt_status *s)
461 struct stat statbuf;
462 int commitable, saved_color_setting;
463 struct strbuf sb = STRBUF_INIT;
464 char *buffer;
465 FILE *fp;
466 const char *hook_arg1 = NULL;
467 const char *hook_arg2 = NULL;
468 int ident_shown = 0;
470 if (!no_verify && run_hook(index_file, "pre-commit", NULL))
471 return 0;
473 if (message.len) {
474 strbuf_addbuf(&sb, &message);
475 hook_arg1 = "message";
476 } else if (logfile && !strcmp(logfile, "-")) {
477 if (isatty(0))
478 fprintf(stderr, "(reading log message from standard input)\n");
479 if (strbuf_read(&sb, 0, 0) < 0)
480 die_errno("could not read log from standard input");
481 hook_arg1 = "message";
482 } else if (logfile) {
483 if (strbuf_read_file(&sb, logfile, 0) < 0)
484 die_errno("could not read log file '%s'",
485 logfile);
486 hook_arg1 = "message";
487 } else if (use_message) {
488 buffer = strstr(use_message_buffer, "\n\n");
489 if (!buffer || buffer[2] == '\0')
490 die("commit has empty message");
491 strbuf_add(&sb, buffer + 2, strlen(buffer + 2));
492 hook_arg1 = "commit";
493 hook_arg2 = use_message;
494 } else if (!stat(git_path("MERGE_MSG"), &statbuf)) {
495 if (strbuf_read_file(&sb, git_path("MERGE_MSG"), 0) < 0)
496 die_errno("could not read MERGE_MSG");
497 hook_arg1 = "merge";
498 } else if (!stat(git_path("SQUASH_MSG"), &statbuf)) {
499 if (strbuf_read_file(&sb, git_path("SQUASH_MSG"), 0) < 0)
500 die_errno("could not read SQUASH_MSG");
501 hook_arg1 = "squash";
502 } else if (template_file && !stat(template_file, &statbuf)) {
503 if (strbuf_read_file(&sb, template_file, 0) < 0)
504 die_errno("could not read '%s'", template_file);
505 hook_arg1 = "template";
509 * This final case does not modify the template message,
510 * it just sets the argument to the prepare-commit-msg hook.
512 else if (in_merge)
513 hook_arg1 = "merge";
515 fp = fopen(git_path(commit_editmsg), "w");
516 if (fp == NULL)
517 die_errno("could not open '%s'", git_path(commit_editmsg));
519 if (cleanup_mode != CLEANUP_NONE)
520 stripspace(&sb, 0);
522 if (signoff) {
523 struct strbuf sob = STRBUF_INIT;
524 int i;
526 strbuf_addstr(&sob, sign_off_header);
527 strbuf_addstr(&sob, fmt_name(getenv("GIT_COMMITTER_NAME"),
528 getenv("GIT_COMMITTER_EMAIL")));
529 strbuf_addch(&sob, '\n');
530 for (i = sb.len - 1; i > 0 && sb.buf[i - 1] != '\n'; i--)
531 ; /* do nothing */
532 if (prefixcmp(sb.buf + i, sob.buf)) {
533 if (!i || !ends_rfc2822_footer(&sb))
534 strbuf_addch(&sb, '\n');
535 strbuf_addbuf(&sb, &sob);
537 strbuf_release(&sob);
540 if (fwrite(sb.buf, 1, sb.len, fp) < sb.len)
541 die_errno("could not write commit template");
543 strbuf_release(&sb);
545 determine_author_info();
547 /* This checks if committer ident is explicitly given */
548 git_committer_info(0);
549 if (use_editor) {
550 char *author_ident;
551 const char *committer_ident;
553 if (in_merge)
554 fprintf(fp,
555 "#\n"
556 "# It looks like you may be committing a MERGE.\n"
557 "# If this is not correct, please remove the file\n"
558 "# %s\n"
559 "# and try again.\n"
560 "#\n",
561 git_path("MERGE_HEAD"));
563 fprintf(fp,
564 "\n"
565 "# Please enter the commit message for your changes.");
566 if (cleanup_mode == CLEANUP_ALL)
567 fprintf(fp,
568 " Lines starting\n"
569 "# with '#' will be ignored, and an empty"
570 " message aborts the commit.\n");
571 else /* CLEANUP_SPACE, that is. */
572 fprintf(fp,
573 " Lines starting\n"
574 "# with '#' will be kept; you may remove them"
575 " yourself if you want to.\n"
576 "# An empty message aborts the commit.\n");
577 if (only_include_assumed)
578 fprintf(fp, "# %s\n", only_include_assumed);
580 author_ident = xstrdup(fmt_name(author_name, author_email));
581 committer_ident = fmt_name(getenv("GIT_COMMITTER_NAME"),
582 getenv("GIT_COMMITTER_EMAIL"));
583 if (strcmp(author_ident, committer_ident))
584 fprintf(fp,
585 "%s"
586 "# Author: %s\n",
587 ident_shown++ ? "" : "#\n",
588 author_ident);
589 free(author_ident);
591 if (!user_ident_explicitly_given)
592 fprintf(fp,
593 "%s"
594 "# Committer: %s\n",
595 ident_shown++ ? "" : "#\n",
596 committer_ident);
598 if (ident_shown)
599 fprintf(fp, "#\n");
601 saved_color_setting = s->use_color;
602 s->use_color = 0;
603 commitable = run_status(fp, index_file, prefix, 1, s);
604 s->use_color = saved_color_setting;
605 } else {
606 unsigned char sha1[20];
607 const char *parent = "HEAD";
609 if (!active_nr && read_cache() < 0)
610 die("Cannot read index");
612 if (amend)
613 parent = "HEAD^1";
615 if (get_sha1(parent, sha1))
616 commitable = !!active_nr;
617 else
618 commitable = index_differs_from(parent, 0);
621 fclose(fp);
623 if (!commitable && !in_merge && !allow_empty &&
624 !(amend && is_a_merge(head_sha1))) {
625 run_status(stdout, index_file, prefix, 0, s);
626 return 0;
630 * Re-read the index as pre-commit hook could have updated it,
631 * and write it out as a tree. We must do this before we invoke
632 * the editor and after we invoke run_status above.
634 discard_cache();
635 read_cache_from(index_file);
636 if (!active_cache_tree)
637 active_cache_tree = cache_tree();
638 if (cache_tree_update(active_cache_tree,
639 active_cache, active_nr, 0, 0) < 0) {
640 error("Error building trees");
641 return 0;
644 if (run_hook(index_file, "prepare-commit-msg",
645 git_path(commit_editmsg), hook_arg1, hook_arg2, NULL))
646 return 0;
648 if (use_editor) {
649 char index[PATH_MAX];
650 const char *env[2] = { index, NULL };
651 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
652 if (launch_editor(git_path(commit_editmsg), NULL, env)) {
653 fprintf(stderr,
654 "Please supply the message using either -m or -F option.\n");
655 exit(1);
659 if (!no_verify &&
660 run_hook(index_file, "commit-msg", git_path(commit_editmsg), NULL)) {
661 return 0;
664 return 1;
668 * Find out if the message in the strbuf contains only whitespace and
669 * Signed-off-by lines.
671 static int message_is_empty(struct strbuf *sb)
673 struct strbuf tmpl = STRBUF_INIT;
674 const char *nl;
675 int eol, i, start = 0;
677 if (cleanup_mode == CLEANUP_NONE && sb->len)
678 return 0;
680 /* See if the template is just a prefix of the message. */
681 if (template_file && strbuf_read_file(&tmpl, template_file, 0) > 0) {
682 stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
683 if (start + tmpl.len <= sb->len &&
684 memcmp(tmpl.buf, sb->buf + start, tmpl.len) == 0)
685 start += tmpl.len;
687 strbuf_release(&tmpl);
689 /* Check if the rest is just whitespace and Signed-of-by's. */
690 for (i = start; i < sb->len; i++) {
691 nl = memchr(sb->buf + i, '\n', sb->len - i);
692 if (nl)
693 eol = nl - sb->buf;
694 else
695 eol = sb->len;
697 if (strlen(sign_off_header) <= eol - i &&
698 !prefixcmp(sb->buf + i, sign_off_header)) {
699 i = eol;
700 continue;
702 while (i < eol)
703 if (!isspace(sb->buf[i++]))
704 return 0;
707 return 1;
710 static const char *find_author_by_nickname(const char *name)
712 struct rev_info revs;
713 struct commit *commit;
714 struct strbuf buf = STRBUF_INIT;
715 const char *av[20];
716 int ac = 0;
718 init_revisions(&revs, NULL);
719 strbuf_addf(&buf, "--author=%s", name);
720 av[++ac] = "--all";
721 av[++ac] = "-i";
722 av[++ac] = buf.buf;
723 av[++ac] = NULL;
724 setup_revisions(ac, av, &revs, NULL);
725 prepare_revision_walk(&revs);
726 commit = get_revision(&revs);
727 if (commit) {
728 struct pretty_print_context ctx = {0};
729 ctx.date_mode = DATE_NORMAL;
730 strbuf_release(&buf);
731 format_commit_message(commit, "%an <%ae>", &buf, &ctx);
732 return strbuf_detach(&buf, NULL);
734 die("No existing author found with '%s'", name);
737 static int parse_and_validate_options(int argc, const char *argv[],
738 const char * const usage[],
739 const char *prefix,
740 struct wt_status *s)
742 int f = 0;
744 argc = parse_options(argc, argv, prefix, builtin_commit_options, usage,
747 if (force_author && !strchr(force_author, '>'))
748 force_author = find_author_by_nickname(force_author);
750 if (logfile || message.len || use_message)
751 use_editor = 0;
752 if (edit_flag)
753 use_editor = 1;
754 if (!use_editor)
755 setenv("GIT_EDITOR", ":", 1);
757 if (get_sha1("HEAD", head_sha1))
758 initial_commit = 1;
760 if (!get_sha1("MERGE_HEAD", merge_head_sha1))
761 in_merge = 1;
763 /* Sanity check options */
764 if (amend && initial_commit)
765 die("You have nothing to amend.");
766 if (amend && in_merge)
767 die("You are in the middle of a merge -- cannot amend.");
769 if (use_message)
770 f++;
771 if (edit_message)
772 f++;
773 if (logfile)
774 f++;
775 if (f > 1)
776 die("Only one of -c/-C/-F can be used.");
777 if (message.len && f > 0)
778 die("Option -m cannot be combined with -c/-C/-F.");
779 if (edit_message)
780 use_message = edit_message;
781 if (amend && !use_message)
782 use_message = "HEAD";
783 if (use_message) {
784 unsigned char sha1[20];
785 static char utf8[] = "UTF-8";
786 const char *out_enc;
787 char *enc, *end;
788 struct commit *commit;
790 if (get_sha1(use_message, sha1))
791 die("could not lookup commit %s", use_message);
792 commit = lookup_commit_reference(sha1);
793 if (!commit || parse_commit(commit))
794 die("could not parse commit %s", use_message);
796 enc = strstr(commit->buffer, "\nencoding");
797 if (enc) {
798 end = strchr(enc + 10, '\n');
799 enc = xstrndup(enc + 10, end - (enc + 10));
800 } else {
801 enc = utf8;
803 out_enc = git_commit_encoding ? git_commit_encoding : utf8;
805 if (strcmp(out_enc, enc))
806 use_message_buffer =
807 reencode_string(commit->buffer, out_enc, enc);
810 * If we failed to reencode the buffer, just copy it
811 * byte for byte so the user can try to fix it up.
812 * This also handles the case where input and output
813 * encodings are identical.
815 if (use_message_buffer == NULL)
816 use_message_buffer = xstrdup(commit->buffer);
817 if (enc != utf8)
818 free(enc);
821 if (!!also + !!only + !!all + !!interactive > 1)
822 die("Only one of --include/--only/--all/--interactive can be used.");
823 if (argc == 0 && (also || (only && !amend)))
824 die("No paths with --include/--only does not make sense.");
825 if (argc == 0 && only && amend)
826 only_include_assumed = "Clever... amending the last one with dirty index.";
827 if (argc > 0 && !also && !only)
828 only_include_assumed = "Explicit paths specified without -i nor -o; assuming --only paths...";
829 if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
830 cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
831 else if (!strcmp(cleanup_arg, "verbatim"))
832 cleanup_mode = CLEANUP_NONE;
833 else if (!strcmp(cleanup_arg, "whitespace"))
834 cleanup_mode = CLEANUP_SPACE;
835 else if (!strcmp(cleanup_arg, "strip"))
836 cleanup_mode = CLEANUP_ALL;
837 else
838 die("Invalid cleanup mode %s", cleanup_arg);
840 if (!untracked_files_arg)
841 ; /* default already initialized */
842 else if (!strcmp(untracked_files_arg, "no"))
843 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
844 else if (!strcmp(untracked_files_arg, "normal"))
845 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
846 else if (!strcmp(untracked_files_arg, "all"))
847 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
848 else
849 die("Invalid untracked files mode '%s'", untracked_files_arg);
851 if (all && argc > 0)
852 die("Paths with -a does not make sense.");
853 else if (interactive && argc > 0)
854 die("Paths with --interactive does not make sense.");
856 return argc;
859 static int dry_run_commit(int argc, const char **argv, const char *prefix,
860 struct wt_status *s)
862 int commitable;
863 const char *index_file;
865 index_file = prepare_index(argc, argv, prefix, 1);
866 commitable = run_status(stdout, index_file, prefix, 0, s);
867 rollback_index_files();
869 return commitable ? 0 : 1;
872 static int parse_status_slot(const char *var, int offset)
874 if (!strcasecmp(var+offset, "header"))
875 return WT_STATUS_HEADER;
876 if (!strcasecmp(var+offset, "updated")
877 || !strcasecmp(var+offset, "added"))
878 return WT_STATUS_UPDATED;
879 if (!strcasecmp(var+offset, "changed"))
880 return WT_STATUS_CHANGED;
881 if (!strcasecmp(var+offset, "untracked"))
882 return WT_STATUS_UNTRACKED;
883 if (!strcasecmp(var+offset, "nobranch"))
884 return WT_STATUS_NOBRANCH;
885 if (!strcasecmp(var+offset, "unmerged"))
886 return WT_STATUS_UNMERGED;
887 die("bad config variable '%s'", var);
890 static int git_status_config(const char *k, const char *v, void *cb)
892 struct wt_status *s = cb;
894 if (!strcmp(k, "status.submodulesummary")) {
895 int is_bool;
896 s->submodule_summary = git_config_bool_or_int(k, v, &is_bool);
897 if (is_bool && s->submodule_summary)
898 s->submodule_summary = -1;
899 return 0;
901 if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
902 s->use_color = git_config_colorbool(k, v, -1);
903 return 0;
905 if (!prefixcmp(k, "status.color.") || !prefixcmp(k, "color.status.")) {
906 int slot = parse_status_slot(k, 13);
907 if (!v)
908 return config_error_nonbool(k);
909 color_parse(v, k, s->color_palette[slot]);
910 return 0;
912 if (!strcmp(k, "status.relativepaths")) {
913 s->relative_paths = git_config_bool(k, v);
914 return 0;
916 if (!strcmp(k, "status.showuntrackedfiles")) {
917 if (!v)
918 return config_error_nonbool(k);
919 else if (!strcmp(v, "no"))
920 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
921 else if (!strcmp(v, "normal"))
922 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
923 else if (!strcmp(v, "all"))
924 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
925 else
926 return error("Invalid untracked files mode '%s'", v);
927 return 0;
929 return git_diff_ui_config(k, v, NULL);
932 int cmd_status(int argc, const char **argv, const char *prefix)
934 struct wt_status s;
936 wt_status_prepare(&s);
937 git_config(git_status_config, &s);
938 if (s.use_color == -1)
939 s.use_color = git_use_color_default;
940 if (diff_use_color_default == -1)
941 diff_use_color_default = git_use_color_default;
943 argc = parse_and_validate_options(argc, argv, builtin_status_usage,
944 prefix, &s);
945 return dry_run_commit(argc, argv, prefix, &s);
948 static void print_summary(const char *prefix, const unsigned char *sha1)
950 struct rev_info rev;
951 struct commit *commit;
952 static const char *format = "format:%h] %s";
953 unsigned char junk_sha1[20];
954 const char *head = resolve_ref("HEAD", junk_sha1, 0, NULL);
956 commit = lookup_commit(sha1);
957 if (!commit)
958 die("couldn't look up newly created commit");
959 if (!commit || parse_commit(commit))
960 die("could not parse newly created commit");
962 init_revisions(&rev, prefix);
963 setup_revisions(0, NULL, &rev, NULL);
965 rev.abbrev = 0;
966 rev.diff = 1;
967 rev.diffopt.output_format =
968 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
970 rev.verbose_header = 1;
971 rev.show_root_diff = 1;
972 get_commit_format(format, &rev);
973 rev.always_show_header = 0;
974 rev.diffopt.detect_rename = 1;
975 rev.diffopt.rename_limit = 100;
976 rev.diffopt.break_opt = 0;
977 diff_setup_done(&rev.diffopt);
979 printf("[%s%s ",
980 !prefixcmp(head, "refs/heads/") ?
981 head + 11 :
982 !strcmp(head, "HEAD") ?
983 "detached HEAD" :
984 head,
985 initial_commit ? " (root-commit)" : "");
987 if (!log_tree_commit(&rev, commit)) {
988 struct pretty_print_context ctx = {0};
989 struct strbuf buf = STRBUF_INIT;
990 ctx.date_mode = DATE_NORMAL;
991 format_commit_message(commit, format + 7, &buf, &ctx);
992 printf("%s\n", buf.buf);
993 strbuf_release(&buf);
997 static int git_commit_config(const char *k, const char *v, void *cb)
999 struct wt_status *s = cb;
1001 if (!strcmp(k, "commit.template"))
1002 return git_config_string(&template_file, k, v);
1004 return git_status_config(k, v, s);
1007 int cmd_commit(int argc, const char **argv, const char *prefix)
1009 struct strbuf sb = STRBUF_INIT;
1010 const char *index_file, *reflog_msg;
1011 char *nl, *p;
1012 unsigned char commit_sha1[20];
1013 struct ref_lock *ref_lock;
1014 struct commit_list *parents = NULL, **pptr = &parents;
1015 struct stat statbuf;
1016 int allow_fast_forward = 1;
1017 struct wt_status s;
1019 wt_status_prepare(&s);
1020 git_config(git_commit_config, &s);
1022 if (s.use_color == -1)
1023 s.use_color = git_use_color_default;
1025 argc = parse_and_validate_options(argc, argv, builtin_commit_usage,
1026 prefix, &s);
1027 if (dry_run) {
1028 if (diff_use_color_default == -1)
1029 diff_use_color_default = git_use_color_default;
1030 return dry_run_commit(argc, argv, prefix, &s);
1032 index_file = prepare_index(argc, argv, prefix, 0);
1034 /* Set up everything for writing the commit object. This includes
1035 running hooks, writing the trees, and interacting with the user. */
1036 if (!prepare_to_commit(index_file, prefix, &s)) {
1037 rollback_index_files();
1038 return 1;
1041 /* Determine parents */
1042 if (initial_commit) {
1043 reflog_msg = "commit (initial)";
1044 } else if (amend) {
1045 struct commit_list *c;
1046 struct commit *commit;
1048 reflog_msg = "commit (amend)";
1049 commit = lookup_commit(head_sha1);
1050 if (!commit || parse_commit(commit))
1051 die("could not parse HEAD commit");
1053 for (c = commit->parents; c; c = c->next)
1054 pptr = &commit_list_insert(c->item, pptr)->next;
1055 } else if (in_merge) {
1056 struct strbuf m = STRBUF_INIT;
1057 FILE *fp;
1059 reflog_msg = "commit (merge)";
1060 pptr = &commit_list_insert(lookup_commit(head_sha1), pptr)->next;
1061 fp = fopen(git_path("MERGE_HEAD"), "r");
1062 if (fp == NULL)
1063 die_errno("could not open '%s' for reading",
1064 git_path("MERGE_HEAD"));
1065 while (strbuf_getline(&m, fp, '\n') != EOF) {
1066 unsigned char sha1[20];
1067 if (get_sha1_hex(m.buf, sha1) < 0)
1068 die("Corrupt MERGE_HEAD file (%s)", m.buf);
1069 pptr = &commit_list_insert(lookup_commit(sha1), pptr)->next;
1071 fclose(fp);
1072 strbuf_release(&m);
1073 if (!stat(git_path("MERGE_MODE"), &statbuf)) {
1074 if (strbuf_read_file(&sb, git_path("MERGE_MODE"), 0) < 0)
1075 die_errno("could not read MERGE_MODE");
1076 if (!strcmp(sb.buf, "no-ff"))
1077 allow_fast_forward = 0;
1079 if (allow_fast_forward)
1080 parents = reduce_heads(parents);
1081 } else {
1082 reflog_msg = "commit";
1083 pptr = &commit_list_insert(lookup_commit(head_sha1), pptr)->next;
1086 /* Finally, get the commit message */
1087 strbuf_reset(&sb);
1088 if (strbuf_read_file(&sb, git_path(commit_editmsg), 0) < 0) {
1089 int saved_errno = errno;
1090 rollback_index_files();
1091 die("could not read commit message: %s", strerror(saved_errno));
1094 /* Truncate the message just before the diff, if any. */
1095 if (verbose) {
1096 p = strstr(sb.buf, "\ndiff --git ");
1097 if (p != NULL)
1098 strbuf_setlen(&sb, p - sb.buf + 1);
1101 if (cleanup_mode != CLEANUP_NONE)
1102 stripspace(&sb, cleanup_mode == CLEANUP_ALL);
1103 if (message_is_empty(&sb)) {
1104 rollback_index_files();
1105 fprintf(stderr, "Aborting commit due to empty commit message.\n");
1106 exit(1);
1109 if (commit_tree(sb.buf, active_cache_tree->sha1, parents, commit_sha1,
1110 fmt_ident(author_name, author_email, author_date,
1111 IDENT_ERROR_ON_NO_NAME))) {
1112 rollback_index_files();
1113 die("failed to write commit object");
1116 ref_lock = lock_any_ref_for_update("HEAD",
1117 initial_commit ? NULL : head_sha1,
1120 nl = strchr(sb.buf, '\n');
1121 if (nl)
1122 strbuf_setlen(&sb, nl + 1 - sb.buf);
1123 else
1124 strbuf_addch(&sb, '\n');
1125 strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
1126 strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
1128 if (!ref_lock) {
1129 rollback_index_files();
1130 die("cannot lock HEAD ref");
1132 if (write_ref_sha1(ref_lock, commit_sha1, sb.buf) < 0) {
1133 rollback_index_files();
1134 die("cannot update HEAD ref");
1137 unlink(git_path("MERGE_HEAD"));
1138 unlink(git_path("MERGE_MSG"));
1139 unlink(git_path("MERGE_MODE"));
1140 unlink(git_path("SQUASH_MSG"));
1142 if (commit_index_files())
1143 die ("Repository has been updated, but unable to write\n"
1144 "new_index file. Check that disk is not full or quota is\n"
1145 "not exceeded, and then \"git reset HEAD\" to recover.");
1147 rerere();
1148 run_hook(get_index_file(), "post-commit", NULL);
1149 if (!quiet)
1150 print_summary(prefix, commit_sha1);
1152 return 0;