Documentation: refer to gitworkflows(7) from tutorial and git(1)
[git/dscho.git] / builtin-commit.c
blobbaaa75cf908d57e6d8540b6483684400c0b2494b
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;
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_STRING('F', "file", &logfile, "FILE", "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_STRING('t', "template", &template_file, "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, "amend", &amend, "amend previous commit"),
107 { 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" },
108 OPT_BOOLEAN(0, "allow-empty", &allow_empty, "ok to record an empty change"),
109 OPT_STRING(0, "cleanup", &cleanup_arg, "default", "how to strip spaces and #comments from message"),
111 OPT_END()
114 static void rollback_index_files(void)
116 switch (commit_style) {
117 case COMMIT_AS_IS:
118 break; /* nothing to do */
119 case COMMIT_NORMAL:
120 rollback_lock_file(&index_lock);
121 break;
122 case COMMIT_PARTIAL:
123 rollback_lock_file(&index_lock);
124 rollback_lock_file(&false_lock);
125 break;
129 static int commit_index_files(void)
131 int err = 0;
133 switch (commit_style) {
134 case COMMIT_AS_IS:
135 break; /* nothing to do */
136 case COMMIT_NORMAL:
137 err = commit_lock_file(&index_lock);
138 break;
139 case COMMIT_PARTIAL:
140 err = commit_lock_file(&index_lock);
141 rollback_lock_file(&false_lock);
142 break;
145 return err;
149 * Take a union of paths in the index and the named tree (typically, "HEAD"),
150 * and return the paths that match the given pattern in list.
152 static int list_paths(struct string_list *list, const char *with_tree,
153 const char *prefix, const char **pattern)
155 int i;
156 char *m;
158 for (i = 0; pattern[i]; i++)
160 m = xcalloc(1, i);
162 if (with_tree)
163 overlay_tree_on_cache(with_tree, prefix);
165 for (i = 0; i < active_nr; i++) {
166 struct cache_entry *ce = active_cache[i];
167 if (ce->ce_flags & CE_UPDATE)
168 continue;
169 if (!match_pathspec(pattern, ce->name, ce_namelen(ce), 0, m))
170 continue;
171 string_list_insert(ce->name, list);
174 return report_path_error(m, pattern, prefix ? strlen(prefix) : 0);
177 static void add_remove_files(struct string_list *list)
179 int i;
180 for (i = 0; i < list->nr; i++) {
181 struct stat st;
182 struct string_list_item *p = &(list->items[i]);
184 if (!lstat(p->string, &st)) {
185 if (add_to_cache(p->string, &st, 0))
186 die("updating files failed");
187 } else
188 remove_file_from_cache(p->string);
192 static void create_base_index(void)
194 struct tree *tree;
195 struct unpack_trees_options opts;
196 struct tree_desc t;
198 if (initial_commit) {
199 discard_cache();
200 return;
203 memset(&opts, 0, sizeof(opts));
204 opts.head_idx = 1;
205 opts.index_only = 1;
206 opts.merge = 1;
207 opts.src_index = &the_index;
208 opts.dst_index = &the_index;
210 opts.fn = oneway_merge;
211 tree = parse_tree_indirect(head_sha1);
212 if (!tree)
213 die("failed to unpack HEAD tree object");
214 parse_tree(tree);
215 init_tree_desc(&t, tree->buffer, tree->size);
216 if (unpack_trees(1, &t, &opts))
217 exit(128); /* We've already reported the error, finish dying */
220 static char *prepare_index(int argc, const char **argv, const char *prefix)
222 int fd;
223 struct string_list partial;
224 const char **pathspec = NULL;
226 if (interactive) {
227 if (interactive_add(argc, argv, prefix) != 0)
228 die("interactive add failed");
229 if (read_cache_preload(NULL) < 0)
230 die("index file corrupt");
231 commit_style = COMMIT_AS_IS;
232 return get_index_file();
235 if (*argv)
236 pathspec = get_pathspec(prefix, argv);
238 if (read_cache_preload(pathspec) < 0)
239 die("index file corrupt");
242 * Non partial, non as-is commit.
244 * (1) get the real index;
245 * (2) update the_index as necessary;
246 * (3) write the_index out to the real index (still locked);
247 * (4) return the name of the locked index file.
249 * The caller should run hooks on the locked real index, and
250 * (A) if all goes well, commit the real index;
251 * (B) on failure, rollback the real index.
253 if (all || (also && pathspec && *pathspec)) {
254 int fd = hold_locked_index(&index_lock, 1);
255 add_files_to_cache(also ? prefix : NULL, pathspec, 0);
256 refresh_cache(REFRESH_QUIET);
257 if (write_cache(fd, active_cache, active_nr) ||
258 close_lock_file(&index_lock))
259 die("unable to write new_index file");
260 commit_style = COMMIT_NORMAL;
261 return index_lock.filename;
265 * As-is commit.
267 * (1) return the name of the real index file.
269 * The caller should run hooks on the real index, and run
270 * hooks on the real index, and create commit from the_index.
271 * We still need to refresh the index here.
273 if (!pathspec || !*pathspec) {
274 fd = hold_locked_index(&index_lock, 1);
275 refresh_cache(REFRESH_QUIET);
276 if (write_cache(fd, active_cache, active_nr) ||
277 commit_locked_index(&index_lock))
278 die("unable to write new_index file");
279 commit_style = COMMIT_AS_IS;
280 return get_index_file();
284 * A partial commit.
286 * (0) find the set of affected paths;
287 * (1) get lock on the real index file;
288 * (2) update the_index with the given paths;
289 * (3) write the_index out to the real index (still locked);
290 * (4) get lock on the false index file;
291 * (5) reset the_index from HEAD;
292 * (6) update the_index the same way as (2);
293 * (7) write the_index out to the false index file;
294 * (8) return the name of the false index file (still locked);
296 * The caller should run hooks on the locked false index, and
297 * create commit from it. Then
298 * (A) if all goes well, commit the real index;
299 * (B) on failure, rollback the real index;
300 * In either case, rollback the false index.
302 commit_style = COMMIT_PARTIAL;
304 if (file_exists(git_path("MERGE_HEAD")))
305 die("cannot do a partial commit during a merge.");
307 memset(&partial, 0, sizeof(partial));
308 partial.strdup_strings = 1;
309 if (list_paths(&partial, initial_commit ? NULL : "HEAD", prefix, pathspec))
310 exit(1);
312 discard_cache();
313 if (read_cache() < 0)
314 die("cannot read the index");
316 fd = hold_locked_index(&index_lock, 1);
317 add_remove_files(&partial);
318 refresh_cache(REFRESH_QUIET);
319 if (write_cache(fd, active_cache, active_nr) ||
320 close_lock_file(&index_lock))
321 die("unable to write new_index file");
323 fd = hold_lock_file_for_update(&false_lock,
324 git_path("next-index-%"PRIuMAX,
325 (uintmax_t) getpid()),
326 LOCK_DIE_ON_ERROR);
328 create_base_index();
329 add_remove_files(&partial);
330 refresh_cache(REFRESH_QUIET);
332 if (write_cache(fd, active_cache, active_nr) ||
333 close_lock_file(&false_lock))
334 die("unable to write temporary index file");
336 discard_cache();
337 read_cache_from(false_lock.filename);
339 return false_lock.filename;
342 static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn)
344 struct wt_status s;
346 wt_status_prepare(&s);
347 if (wt_status_relative_paths)
348 s.prefix = prefix;
350 if (amend) {
351 s.amend = 1;
352 s.reference = "HEAD^1";
354 s.verbose = verbose;
355 s.untracked = (show_untracked_files == SHOW_ALL_UNTRACKED_FILES);
356 s.index_file = index_file;
357 s.fp = fp;
358 s.nowarn = nowarn;
360 wt_status_print(&s);
362 return s.commitable;
365 static int is_a_merge(const unsigned char *sha1)
367 struct commit *commit = lookup_commit(sha1);
368 if (!commit || parse_commit(commit))
369 die("could not parse HEAD commit");
370 return !!(commit->parents && commit->parents->next);
373 static const char sign_off_header[] = "Signed-off-by: ";
375 static void determine_author_info(void)
377 char *name, *email, *date;
379 name = getenv("GIT_AUTHOR_NAME");
380 email = getenv("GIT_AUTHOR_EMAIL");
381 date = getenv("GIT_AUTHOR_DATE");
383 if (use_message) {
384 const char *a, *lb, *rb, *eol;
386 a = strstr(use_message_buffer, "\nauthor ");
387 if (!a)
388 die("invalid commit: %s", use_message);
390 lb = strstr(a + 8, " <");
391 rb = strstr(a + 8, "> ");
392 eol = strchr(a + 8, '\n');
393 if (!lb || !rb || !eol)
394 die("invalid commit: %s", use_message);
396 name = xstrndup(a + 8, lb - (a + 8));
397 email = xstrndup(lb + 2, rb - (lb + 2));
398 date = xstrndup(rb + 2, eol - (rb + 2));
401 if (force_author) {
402 const char *lb = strstr(force_author, " <");
403 const char *rb = strchr(force_author, '>');
405 if (!lb || !rb)
406 die("malformed --author parameter");
407 name = xstrndup(force_author, lb - force_author);
408 email = xstrndup(lb + 2, rb - (lb + 2));
411 author_name = name;
412 author_email = email;
413 author_date = date;
416 static int prepare_to_commit(const char *index_file, const char *prefix)
418 struct stat statbuf;
419 int commitable, saved_color_setting;
420 struct strbuf sb = STRBUF_INIT;
421 char *buffer;
422 FILE *fp;
423 const char *hook_arg1 = NULL;
424 const char *hook_arg2 = NULL;
425 int ident_shown = 0;
427 if (!no_verify && run_hook(index_file, "pre-commit", NULL))
428 return 0;
430 if (message.len) {
431 strbuf_addbuf(&sb, &message);
432 hook_arg1 = "message";
433 } else if (logfile && !strcmp(logfile, "-")) {
434 if (isatty(0))
435 fprintf(stderr, "(reading log message from standard input)\n");
436 if (strbuf_read(&sb, 0, 0) < 0)
437 die("could not read log from standard input");
438 hook_arg1 = "message";
439 } else if (logfile) {
440 if (strbuf_read_file(&sb, logfile, 0) < 0)
441 die("could not read log file '%s': %s",
442 logfile, strerror(errno));
443 hook_arg1 = "message";
444 } else if (use_message) {
445 buffer = strstr(use_message_buffer, "\n\n");
446 if (!buffer || buffer[2] == '\0')
447 die("commit has empty message");
448 strbuf_add(&sb, buffer + 2, strlen(buffer + 2));
449 hook_arg1 = "commit";
450 hook_arg2 = use_message;
451 } else if (!stat(git_path("MERGE_MSG"), &statbuf)) {
452 if (strbuf_read_file(&sb, git_path("MERGE_MSG"), 0) < 0)
453 die("could not read MERGE_MSG: %s", strerror(errno));
454 hook_arg1 = "merge";
455 } else if (!stat(git_path("SQUASH_MSG"), &statbuf)) {
456 if (strbuf_read_file(&sb, git_path("SQUASH_MSG"), 0) < 0)
457 die("could not read SQUASH_MSG: %s", strerror(errno));
458 hook_arg1 = "squash";
459 } else if (template_file && !stat(template_file, &statbuf)) {
460 if (strbuf_read_file(&sb, template_file, 0) < 0)
461 die("could not read %s: %s",
462 template_file, strerror(errno));
463 hook_arg1 = "template";
467 * This final case does not modify the template message,
468 * it just sets the argument to the prepare-commit-msg hook.
470 else if (in_merge)
471 hook_arg1 = "merge";
473 fp = fopen(git_path(commit_editmsg), "w");
474 if (fp == NULL)
475 die("could not open %s: %s",
476 git_path(commit_editmsg), strerror(errno));
478 if (cleanup_mode != CLEANUP_NONE)
479 stripspace(&sb, 0);
481 if (signoff) {
482 struct strbuf sob = STRBUF_INIT;
483 int i;
485 strbuf_addstr(&sob, sign_off_header);
486 strbuf_addstr(&sob, fmt_name(getenv("GIT_COMMITTER_NAME"),
487 getenv("GIT_COMMITTER_EMAIL")));
488 strbuf_addch(&sob, '\n');
489 for (i = sb.len - 1; i > 0 && sb.buf[i - 1] != '\n'; i--)
490 ; /* do nothing */
491 if (prefixcmp(sb.buf + i, sob.buf)) {
492 if (prefixcmp(sb.buf + i, sign_off_header))
493 strbuf_addch(&sb, '\n');
494 strbuf_addbuf(&sb, &sob);
496 strbuf_release(&sob);
499 if (fwrite(sb.buf, 1, sb.len, fp) < sb.len)
500 die("could not write commit template: %s", strerror(errno));
502 strbuf_release(&sb);
504 determine_author_info();
506 /* This checks if committer ident is explicitly given */
507 git_committer_info(0);
508 if (use_editor) {
509 char *author_ident;
510 const char *committer_ident;
512 if (in_merge)
513 fprintf(fp,
514 "#\n"
515 "# It looks like you may be committing a MERGE.\n"
516 "# If this is not correct, please remove the file\n"
517 "# %s\n"
518 "# and try again.\n"
519 "#\n",
520 git_path("MERGE_HEAD"));
522 fprintf(fp,
523 "\n"
524 "# Please enter the commit message for your changes.");
525 if (cleanup_mode == CLEANUP_ALL)
526 fprintf(fp,
527 " Lines starting\n"
528 "# with '#' will be ignored, and an empty"
529 " message aborts the commit.\n");
530 else /* CLEANUP_SPACE, that is. */
531 fprintf(fp,
532 " Lines starting\n"
533 "# with '#' will be kept; you may remove them"
534 " yourself if you want to.\n"
535 "# An empty message aborts the commit.\n");
536 if (only_include_assumed)
537 fprintf(fp, "# %s\n", only_include_assumed);
539 author_ident = xstrdup(fmt_name(author_name, author_email));
540 committer_ident = fmt_name(getenv("GIT_COMMITTER_NAME"),
541 getenv("GIT_COMMITTER_EMAIL"));
542 if (strcmp(author_ident, committer_ident))
543 fprintf(fp,
544 "%s"
545 "# Author: %s\n",
546 ident_shown++ ? "" : "#\n",
547 author_ident);
548 free(author_ident);
550 if (!user_ident_explicitly_given)
551 fprintf(fp,
552 "%s"
553 "# Committer: %s\n",
554 ident_shown++ ? "" : "#\n",
555 committer_ident);
557 if (ident_shown)
558 fprintf(fp, "#\n");
560 saved_color_setting = wt_status_use_color;
561 wt_status_use_color = 0;
562 commitable = run_status(fp, index_file, prefix, 1);
563 wt_status_use_color = saved_color_setting;
564 } else {
565 unsigned char sha1[20];
566 const char *parent = "HEAD";
568 if (!active_nr && read_cache() < 0)
569 die("Cannot read index");
571 if (amend)
572 parent = "HEAD^1";
574 if (get_sha1(parent, sha1))
575 commitable = !!active_nr;
576 else
577 commitable = index_differs_from(parent, 0);
580 fclose(fp);
582 if (!commitable && !in_merge && !allow_empty &&
583 !(amend && is_a_merge(head_sha1))) {
584 run_status(stdout, index_file, prefix, 0);
585 return 0;
589 * Re-read the index as pre-commit hook could have updated it,
590 * and write it out as a tree. We must do this before we invoke
591 * the editor and after we invoke run_status above.
593 discard_cache();
594 read_cache_from(index_file);
595 if (!active_cache_tree)
596 active_cache_tree = cache_tree();
597 if (cache_tree_update(active_cache_tree,
598 active_cache, active_nr, 0, 0) < 0) {
599 error("Error building trees");
600 return 0;
603 if (run_hook(index_file, "prepare-commit-msg",
604 git_path(commit_editmsg), hook_arg1, hook_arg2, NULL))
605 return 0;
607 if (use_editor) {
608 char index[PATH_MAX];
609 const char *env[2] = { index, NULL };
610 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
611 if (launch_editor(git_path(commit_editmsg), NULL, env)) {
612 fprintf(stderr,
613 "Please supply the message using either -m or -F option.\n");
614 exit(1);
618 if (!no_verify &&
619 run_hook(index_file, "commit-msg", git_path(commit_editmsg), NULL)) {
620 return 0;
623 return 1;
627 * Find out if the message in the strbuf contains only whitespace and
628 * Signed-off-by lines.
630 static int message_is_empty(struct strbuf *sb)
632 struct strbuf tmpl = STRBUF_INIT;
633 const char *nl;
634 int eol, i, start = 0;
636 if (cleanup_mode == CLEANUP_NONE && sb->len)
637 return 0;
639 /* See if the template is just a prefix of the message. */
640 if (template_file && strbuf_read_file(&tmpl, template_file, 0) > 0) {
641 stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
642 if (start + tmpl.len <= sb->len &&
643 memcmp(tmpl.buf, sb->buf + start, tmpl.len) == 0)
644 start += tmpl.len;
646 strbuf_release(&tmpl);
648 /* Check if the rest is just whitespace and Signed-of-by's. */
649 for (i = start; i < sb->len; i++) {
650 nl = memchr(sb->buf + i, '\n', sb->len - i);
651 if (nl)
652 eol = nl - sb->buf;
653 else
654 eol = sb->len;
656 if (strlen(sign_off_header) <= eol - i &&
657 !prefixcmp(sb->buf + i, sign_off_header)) {
658 i = eol;
659 continue;
661 while (i < eol)
662 if (!isspace(sb->buf[i++]))
663 return 0;
666 return 1;
669 static const char *find_author_by_nickname(const char *name)
671 struct rev_info revs;
672 struct commit *commit;
673 struct strbuf buf = STRBUF_INIT;
674 const char *av[20];
675 int ac = 0;
677 init_revisions(&revs, NULL);
678 strbuf_addf(&buf, "--author=%s", name);
679 av[++ac] = "--all";
680 av[++ac] = "-i";
681 av[++ac] = buf.buf;
682 av[++ac] = NULL;
683 setup_revisions(ac, av, &revs, NULL);
684 prepare_revision_walk(&revs);
685 commit = get_revision(&revs);
686 if (commit) {
687 strbuf_release(&buf);
688 format_commit_message(commit, "%an <%ae>", &buf, DATE_NORMAL);
689 return strbuf_detach(&buf, NULL);
691 die("No existing author found with '%s'", name);
694 static int parse_and_validate_options(int argc, const char *argv[],
695 const char * const usage[],
696 const char *prefix)
698 int f = 0;
700 argc = parse_options(argc, argv, builtin_commit_options, usage, 0);
701 logfile = parse_options_fix_filename(prefix, logfile);
702 if (logfile)
703 logfile = xstrdup(logfile);
704 template_file = parse_options_fix_filename(prefix, template_file);
705 if (template_file)
706 template_file = xstrdup(template_file);
708 if (force_author && !strchr(force_author, '>'))
709 force_author = find_author_by_nickname(force_author);
711 if (logfile || message.len || use_message)
712 use_editor = 0;
713 if (edit_flag)
714 use_editor = 1;
715 if (!use_editor)
716 setenv("GIT_EDITOR", ":", 1);
718 if (get_sha1("HEAD", head_sha1))
719 initial_commit = 1;
721 if (!get_sha1("MERGE_HEAD", merge_head_sha1))
722 in_merge = 1;
724 /* Sanity check options */
725 if (amend && initial_commit)
726 die("You have nothing to amend.");
727 if (amend && in_merge)
728 die("You are in the middle of a merge -- cannot amend.");
730 if (use_message)
731 f++;
732 if (edit_message)
733 f++;
734 if (logfile)
735 f++;
736 if (f > 1)
737 die("Only one of -c/-C/-F can be used.");
738 if (message.len && f > 0)
739 die("Option -m cannot be combined with -c/-C/-F.");
740 if (edit_message)
741 use_message = edit_message;
742 if (amend && !use_message)
743 use_message = "HEAD";
744 if (use_message) {
745 unsigned char sha1[20];
746 static char utf8[] = "UTF-8";
747 const char *out_enc;
748 char *enc, *end;
749 struct commit *commit;
751 if (get_sha1(use_message, sha1))
752 die("could not lookup commit %s", use_message);
753 commit = lookup_commit_reference(sha1);
754 if (!commit || parse_commit(commit))
755 die("could not parse commit %s", use_message);
757 enc = strstr(commit->buffer, "\nencoding");
758 if (enc) {
759 end = strchr(enc + 10, '\n');
760 enc = xstrndup(enc + 10, end - (enc + 10));
761 } else {
762 enc = utf8;
764 out_enc = git_commit_encoding ? git_commit_encoding : utf8;
766 if (strcmp(out_enc, enc))
767 use_message_buffer =
768 reencode_string(commit->buffer, out_enc, enc);
771 * If we failed to reencode the buffer, just copy it
772 * byte for byte so the user can try to fix it up.
773 * This also handles the case where input and output
774 * encodings are identical.
776 if (use_message_buffer == NULL)
777 use_message_buffer = xstrdup(commit->buffer);
778 if (enc != utf8)
779 free(enc);
782 if (!!also + !!only + !!all + !!interactive > 1)
783 die("Only one of --include/--only/--all/--interactive can be used.");
784 if (argc == 0 && (also || (only && !amend)))
785 die("No paths with --include/--only does not make sense.");
786 if (argc == 0 && only && amend)
787 only_include_assumed = "Clever... amending the last one with dirty index.";
788 if (argc > 0 && !also && !only)
789 only_include_assumed = "Explicit paths specified without -i nor -o; assuming --only paths...";
790 if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
791 cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
792 else if (!strcmp(cleanup_arg, "verbatim"))
793 cleanup_mode = CLEANUP_NONE;
794 else if (!strcmp(cleanup_arg, "whitespace"))
795 cleanup_mode = CLEANUP_SPACE;
796 else if (!strcmp(cleanup_arg, "strip"))
797 cleanup_mode = CLEANUP_ALL;
798 else
799 die("Invalid cleanup mode %s", cleanup_arg);
801 if (!untracked_files_arg)
802 ; /* default already initialized */
803 else if (!strcmp(untracked_files_arg, "no"))
804 show_untracked_files = SHOW_NO_UNTRACKED_FILES;
805 else if (!strcmp(untracked_files_arg, "normal"))
806 show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
807 else if (!strcmp(untracked_files_arg, "all"))
808 show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
809 else
810 die("Invalid untracked files mode '%s'", untracked_files_arg);
812 if (all && argc > 0)
813 die("Paths with -a does not make sense.");
814 else if (interactive && argc > 0)
815 die("Paths with --interactive does not make sense.");
817 return argc;
820 int cmd_status(int argc, const char **argv, const char *prefix)
822 const char *index_file;
823 int commitable;
825 git_config(git_status_config, NULL);
827 if (wt_status_use_color == -1)
828 wt_status_use_color = git_use_color_default;
830 if (diff_use_color_default == -1)
831 diff_use_color_default = git_use_color_default;
833 argc = parse_and_validate_options(argc, argv, builtin_status_usage, prefix);
835 index_file = prepare_index(argc, argv, prefix);
837 commitable = run_status(stdout, index_file, prefix, 0);
839 rollback_index_files();
841 return commitable ? 0 : 1;
844 static void print_summary(const char *prefix, const unsigned char *sha1)
846 struct rev_info rev;
847 struct commit *commit;
848 static const char *format = "format:%h] %s";
849 unsigned char junk_sha1[20];
850 const char *head = resolve_ref("HEAD", junk_sha1, 0, NULL);
852 commit = lookup_commit(sha1);
853 if (!commit)
854 die("couldn't look up newly created commit");
855 if (!commit || parse_commit(commit))
856 die("could not parse newly created commit");
858 init_revisions(&rev, prefix);
859 setup_revisions(0, NULL, &rev, NULL);
861 rev.abbrev = 0;
862 rev.diff = 1;
863 rev.diffopt.output_format =
864 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
866 rev.verbose_header = 1;
867 rev.show_root_diff = 1;
868 get_commit_format(format, &rev);
869 rev.always_show_header = 0;
870 rev.diffopt.detect_rename = 1;
871 rev.diffopt.rename_limit = 100;
872 rev.diffopt.break_opt = 0;
873 diff_setup_done(&rev.diffopt);
875 printf("[%s%s ",
876 !prefixcmp(head, "refs/heads/") ?
877 head + 11 :
878 !strcmp(head, "HEAD") ?
879 "detached HEAD" :
880 head,
881 initial_commit ? " (root-commit)" : "");
883 if (!log_tree_commit(&rev, commit)) {
884 struct strbuf buf = STRBUF_INIT;
885 format_commit_message(commit, format + 7, &buf, DATE_NORMAL);
886 printf("%s\n", buf.buf);
887 strbuf_release(&buf);
891 static int git_commit_config(const char *k, const char *v, void *cb)
893 if (!strcmp(k, "commit.template"))
894 return git_config_string(&template_file, k, v);
896 return git_status_config(k, v, cb);
899 int cmd_commit(int argc, const char **argv, const char *prefix)
901 struct strbuf sb = STRBUF_INIT;
902 const char *index_file, *reflog_msg;
903 char *nl, *p;
904 unsigned char commit_sha1[20];
905 struct ref_lock *ref_lock;
906 struct commit_list *parents = NULL, **pptr = &parents;
907 struct stat statbuf;
908 int allow_fast_forward = 1;
910 git_config(git_commit_config, NULL);
912 if (wt_status_use_color == -1)
913 wt_status_use_color = git_use_color_default;
915 argc = parse_and_validate_options(argc, argv, builtin_commit_usage, prefix);
917 index_file = prepare_index(argc, argv, prefix);
919 /* Set up everything for writing the commit object. This includes
920 running hooks, writing the trees, and interacting with the user. */
921 if (!prepare_to_commit(index_file, prefix)) {
922 rollback_index_files();
923 return 1;
926 /* Determine parents */
927 if (initial_commit) {
928 reflog_msg = "commit (initial)";
929 } else if (amend) {
930 struct commit_list *c;
931 struct commit *commit;
933 reflog_msg = "commit (amend)";
934 commit = lookup_commit(head_sha1);
935 if (!commit || parse_commit(commit))
936 die("could not parse HEAD commit");
938 for (c = commit->parents; c; c = c->next)
939 pptr = &commit_list_insert(c->item, pptr)->next;
940 } else if (in_merge) {
941 struct strbuf m = STRBUF_INIT;
942 FILE *fp;
944 reflog_msg = "commit (merge)";
945 pptr = &commit_list_insert(lookup_commit(head_sha1), pptr)->next;
946 fp = fopen(git_path("MERGE_HEAD"), "r");
947 if (fp == NULL)
948 die("could not open %s for reading: %s",
949 git_path("MERGE_HEAD"), strerror(errno));
950 while (strbuf_getline(&m, fp, '\n') != EOF) {
951 unsigned char sha1[20];
952 if (get_sha1_hex(m.buf, sha1) < 0)
953 die("Corrupt MERGE_HEAD file (%s)", m.buf);
954 pptr = &commit_list_insert(lookup_commit(sha1), pptr)->next;
956 fclose(fp);
957 strbuf_release(&m);
958 if (!stat(git_path("MERGE_MODE"), &statbuf)) {
959 if (strbuf_read_file(&sb, git_path("MERGE_MODE"), 0) < 0)
960 die("could not read MERGE_MODE: %s",
961 strerror(errno));
962 if (!strcmp(sb.buf, "no-ff"))
963 allow_fast_forward = 0;
965 if (allow_fast_forward)
966 parents = reduce_heads(parents);
967 } else {
968 reflog_msg = "commit";
969 pptr = &commit_list_insert(lookup_commit(head_sha1), pptr)->next;
972 /* Finally, get the commit message */
973 strbuf_reset(&sb);
974 if (strbuf_read_file(&sb, git_path(commit_editmsg), 0) < 0) {
975 rollback_index_files();
976 die("could not read commit message");
979 /* Truncate the message just before the diff, if any. */
980 if (verbose) {
981 p = strstr(sb.buf, "\ndiff --git ");
982 if (p != NULL)
983 strbuf_setlen(&sb, p - sb.buf + 1);
986 if (cleanup_mode != CLEANUP_NONE)
987 stripspace(&sb, cleanup_mode == CLEANUP_ALL);
988 if (message_is_empty(&sb)) {
989 rollback_index_files();
990 fprintf(stderr, "Aborting commit due to empty commit message.\n");
991 exit(1);
994 if (commit_tree(sb.buf, active_cache_tree->sha1, parents, commit_sha1,
995 fmt_ident(author_name, author_email, author_date,
996 IDENT_ERROR_ON_NO_NAME))) {
997 rollback_index_files();
998 die("failed to write commit object");
1001 ref_lock = lock_any_ref_for_update("HEAD",
1002 initial_commit ? NULL : head_sha1,
1005 nl = strchr(sb.buf, '\n');
1006 if (nl)
1007 strbuf_setlen(&sb, nl + 1 - sb.buf);
1008 else
1009 strbuf_addch(&sb, '\n');
1010 strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
1011 strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
1013 if (!ref_lock) {
1014 rollback_index_files();
1015 die("cannot lock HEAD ref");
1017 if (write_ref_sha1(ref_lock, commit_sha1, sb.buf) < 0) {
1018 rollback_index_files();
1019 die("cannot update HEAD ref");
1022 unlink(git_path("MERGE_HEAD"));
1023 unlink(git_path("MERGE_MSG"));
1024 unlink(git_path("MERGE_MODE"));
1025 unlink(git_path("SQUASH_MSG"));
1027 if (commit_index_files())
1028 die ("Repository has been updated, but unable to write\n"
1029 "new_index file. Check that disk is not full or quota is\n"
1030 "not exceeded, and then \"git reset HEAD\" to recover.");
1032 rerere();
1033 run_hook(get_index_file(), "post-commit", NULL);
1034 if (!quiet)
1035 print_summary(prefix, commit_sha1);
1037 return 0;