Compact commit template message
[git.git] / builtin-commit.c
blobb783e6eb46d2603d61d3260420c5dff48913d182
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 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 (!pathspec_match(pattern, m, ce->name, 0))
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 interactive_add(argc, argv, prefix);
228 if (read_cache() < 0)
229 die("index file corrupt");
230 commit_style = COMMIT_AS_IS;
231 return get_index_file();
234 if (read_cache() < 0)
235 die("index file corrupt");
237 if (*argv)
238 pathspec = get_pathspec(prefix, argv);
241 * Non partial, non as-is commit.
243 * (1) get the real index;
244 * (2) update the_index as necessary;
245 * (3) write the_index out to the real index (still locked);
246 * (4) return the name of the locked index file.
248 * The caller should run hooks on the locked real index, and
249 * (A) if all goes well, commit the real index;
250 * (B) on failure, rollback the real index.
252 if (all || (also && pathspec && *pathspec)) {
253 int fd = hold_locked_index(&index_lock, 1);
254 add_files_to_cache(also ? prefix : NULL, pathspec, 0);
255 refresh_cache(REFRESH_QUIET);
256 if (write_cache(fd, active_cache, active_nr) ||
257 close_lock_file(&index_lock))
258 die("unable to write new_index file");
259 commit_style = COMMIT_NORMAL;
260 return index_lock.filename;
264 * As-is commit.
266 * (1) return the name of the real index file.
268 * The caller should run hooks on the real index, and run
269 * hooks on the real index, and create commit from the_index.
270 * We still need to refresh the index here.
272 if (!pathspec || !*pathspec) {
273 fd = hold_locked_index(&index_lock, 1);
274 refresh_cache(REFRESH_QUIET);
275 if (write_cache(fd, active_cache, active_nr) ||
276 commit_locked_index(&index_lock))
277 die("unable to write new_index file");
278 commit_style = COMMIT_AS_IS;
279 return get_index_file();
283 * A partial commit.
285 * (0) find the set of affected paths;
286 * (1) get lock on the real index file;
287 * (2) update the_index with the given paths;
288 * (3) write the_index out to the real index (still locked);
289 * (4) get lock on the false index file;
290 * (5) reset the_index from HEAD;
291 * (6) update the_index the same way as (2);
292 * (7) write the_index out to the false index file;
293 * (8) return the name of the false index file (still locked);
295 * The caller should run hooks on the locked false index, and
296 * create commit from it. Then
297 * (A) if all goes well, commit the real index;
298 * (B) on failure, rollback the real index;
299 * In either case, rollback the false index.
301 commit_style = COMMIT_PARTIAL;
303 if (file_exists(git_path("MERGE_HEAD")))
304 die("cannot do a partial commit during a merge.");
306 memset(&partial, 0, sizeof(partial));
307 partial.strdup_strings = 1;
308 if (list_paths(&partial, initial_commit ? NULL : "HEAD", prefix, pathspec))
309 exit(1);
311 discard_cache();
312 if (read_cache() < 0)
313 die("cannot read the index");
315 fd = hold_locked_index(&index_lock, 1);
316 add_remove_files(&partial);
317 refresh_cache(REFRESH_QUIET);
318 if (write_cache(fd, active_cache, active_nr) ||
319 close_lock_file(&index_lock))
320 die("unable to write new_index file");
322 fd = hold_lock_file_for_update(&false_lock,
323 git_path("next-index-%d", getpid()), 1);
325 create_base_index();
326 add_remove_files(&partial);
327 refresh_cache(REFRESH_QUIET);
329 if (write_cache(fd, active_cache, active_nr) ||
330 close_lock_file(&false_lock))
331 die("unable to write temporary index file");
333 discard_cache();
334 read_cache_from(false_lock.filename);
336 return false_lock.filename;
339 static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn)
341 struct wt_status s;
343 wt_status_prepare(&s);
344 if (wt_status_relative_paths)
345 s.prefix = prefix;
347 if (amend) {
348 s.amend = 1;
349 s.reference = "HEAD^1";
351 s.verbose = verbose;
352 s.untracked = (show_untracked_files == SHOW_ALL_UNTRACKED_FILES);
353 s.index_file = index_file;
354 s.fp = fp;
355 s.nowarn = nowarn;
357 wt_status_print(&s);
359 return s.commitable;
362 static int run_hook(const char *index_file, const char *name, ...)
364 struct child_process hook;
365 const char *argv[10], *env[2];
366 char index[PATH_MAX];
367 va_list args;
368 int i;
370 va_start(args, name);
371 argv[0] = git_path("hooks/%s", name);
372 i = 0;
373 do {
374 if (++i >= ARRAY_SIZE(argv))
375 die ("run_hook(): too many arguments");
376 argv[i] = va_arg(args, const char *);
377 } while (argv[i]);
378 va_end(args);
380 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
381 env[0] = index;
382 env[1] = NULL;
384 if (access(argv[0], X_OK) < 0)
385 return 0;
387 memset(&hook, 0, sizeof(hook));
388 hook.argv = argv;
389 hook.no_stdin = 1;
390 hook.stdout_to_stderr = 1;
391 hook.env = env;
393 return run_command(&hook);
396 static int is_a_merge(const unsigned char *sha1)
398 struct commit *commit = lookup_commit(sha1);
399 if (!commit || parse_commit(commit))
400 die("could not parse HEAD commit");
401 return !!(commit->parents && commit->parents->next);
404 static const char sign_off_header[] = "Signed-off-by: ";
406 static void determine_author_info(void)
408 char *name, *email, *date;
410 name = getenv("GIT_AUTHOR_NAME");
411 email = getenv("GIT_AUTHOR_EMAIL");
412 date = getenv("GIT_AUTHOR_DATE");
414 if (use_message) {
415 const char *a, *lb, *rb, *eol;
417 a = strstr(use_message_buffer, "\nauthor ");
418 if (!a)
419 die("invalid commit: %s", use_message);
421 lb = strstr(a + 8, " <");
422 rb = strstr(a + 8, "> ");
423 eol = strchr(a + 8, '\n');
424 if (!lb || !rb || !eol)
425 die("invalid commit: %s", use_message);
427 name = xstrndup(a + 8, lb - (a + 8));
428 email = xstrndup(lb + 2, rb - (lb + 2));
429 date = xstrndup(rb + 2, eol - (rb + 2));
432 if (force_author) {
433 const char *lb = strstr(force_author, " <");
434 const char *rb = strchr(force_author, '>');
436 if (!lb || !rb)
437 die("malformed --author parameter");
438 name = xstrndup(force_author, lb - force_author);
439 email = xstrndup(lb + 2, rb - (lb + 2));
442 author_name = name;
443 author_email = email;
444 author_date = date;
447 static int prepare_to_commit(const char *index_file, const char *prefix)
449 struct stat statbuf;
450 int commitable, saved_color_setting;
451 struct strbuf sb;
452 char *buffer;
453 FILE *fp;
454 const char *hook_arg1 = NULL;
455 const char *hook_arg2 = NULL;
456 int ident_shown = 0;
458 if (!no_verify && run_hook(index_file, "pre-commit", NULL))
459 return 0;
461 strbuf_init(&sb, 0);
462 if (message.len) {
463 strbuf_addbuf(&sb, &message);
464 hook_arg1 = "message";
465 } else if (logfile && !strcmp(logfile, "-")) {
466 if (isatty(0))
467 fprintf(stderr, "(reading log message from standard input)\n");
468 if (strbuf_read(&sb, 0, 0) < 0)
469 die("could not read log from standard input");
470 hook_arg1 = "message";
471 } else if (logfile) {
472 if (strbuf_read_file(&sb, logfile, 0) < 0)
473 die("could not read log file '%s': %s",
474 logfile, strerror(errno));
475 hook_arg1 = "message";
476 } else if (use_message) {
477 buffer = strstr(use_message_buffer, "\n\n");
478 if (!buffer || buffer[2] == '\0')
479 die("commit has empty message");
480 strbuf_add(&sb, buffer + 2, strlen(buffer + 2));
481 hook_arg1 = "commit";
482 hook_arg2 = use_message;
483 } else if (!stat(git_path("MERGE_MSG"), &statbuf)) {
484 if (strbuf_read_file(&sb, git_path("MERGE_MSG"), 0) < 0)
485 die("could not read MERGE_MSG: %s", strerror(errno));
486 hook_arg1 = "merge";
487 } else if (!stat(git_path("SQUASH_MSG"), &statbuf)) {
488 if (strbuf_read_file(&sb, git_path("SQUASH_MSG"), 0) < 0)
489 die("could not read SQUASH_MSG: %s", strerror(errno));
490 hook_arg1 = "squash";
491 } else if (template_file && !stat(template_file, &statbuf)) {
492 if (strbuf_read_file(&sb, template_file, 0) < 0)
493 die("could not read %s: %s",
494 template_file, strerror(errno));
495 hook_arg1 = "template";
499 * This final case does not modify the template message,
500 * it just sets the argument to the prepare-commit-msg hook.
502 else if (in_merge)
503 hook_arg1 = "merge";
505 fp = fopen(git_path(commit_editmsg), "w");
506 if (fp == NULL)
507 die("could not open %s: %s",
508 git_path(commit_editmsg), strerror(errno));
510 if (cleanup_mode != CLEANUP_NONE)
511 stripspace(&sb, 0);
513 if (signoff) {
514 struct strbuf sob;
515 int i;
517 strbuf_init(&sob, 0);
518 strbuf_addstr(&sob, sign_off_header);
519 strbuf_addstr(&sob, fmt_name(getenv("GIT_COMMITTER_NAME"),
520 getenv("GIT_COMMITTER_EMAIL")));
521 strbuf_addch(&sob, '\n');
522 for (i = sb.len - 1; i > 0 && sb.buf[i - 1] != '\n'; i--)
523 ; /* do nothing */
524 if (prefixcmp(sb.buf + i, sob.buf)) {
525 if (prefixcmp(sb.buf + i, sign_off_header))
526 strbuf_addch(&sb, '\n');
527 strbuf_addbuf(&sb, &sob);
529 strbuf_release(&sob);
532 if (fwrite(sb.buf, 1, sb.len, fp) < sb.len)
533 die("could not write commit template: %s", strerror(errno));
535 strbuf_release(&sb);
537 determine_author_info();
539 /* This checks if committer ident is explicitly given */
540 git_committer_info(0);
541 if (use_editor) {
542 char *author_ident;
543 const char *committer_ident;
545 if (in_merge)
546 fprintf(fp,
547 "#\n"
548 "# It looks like you may be committing a MERGE.\n"
549 "# If this is not correct, please remove the file\n"
550 "# %s\n"
551 "# and try again.\n"
552 "#\n",
553 git_path("MERGE_HEAD"));
555 fprintf(fp,
556 "\n"
557 "# Please enter the commit message for your changes.");
558 if (cleanup_mode == CLEANUP_ALL)
559 fprintf(fp,
560 " Lines starting\n"
561 "# with '#' will be ignored, and an empty"
562 " message aborts the commit.\n");
563 else /* CLEANUP_SPACE, that is. */
564 fprintf(fp,
565 " Lines starting\n"
566 "# with '#' will be kept; you may remove them"
567 " yourself if you want to.\n"
568 "# An empty message aborts the commit.\n");
569 if (only_include_assumed)
570 fprintf(fp, "# %s\n", only_include_assumed);
572 author_ident = xstrdup(fmt_name(author_name, author_email));
573 committer_ident = fmt_name(getenv("GIT_COMMITTER_NAME"),
574 getenv("GIT_COMMITTER_EMAIL"));
575 if (strcmp(author_ident, committer_ident))
576 fprintf(fp,
577 "%s"
578 "# Author: %s\n",
579 ident_shown++ ? "" : "#\n",
580 author_ident);
581 free(author_ident);
583 if (!user_ident_explicitly_given)
584 fprintf(fp,
585 "%s"
586 "# Committer: %s\n",
587 ident_shown++ ? "" : "#\n",
588 committer_ident);
590 if (ident_shown)
591 fprintf(fp, "#\n");
593 saved_color_setting = wt_status_use_color;
594 wt_status_use_color = 0;
595 commitable = run_status(fp, index_file, prefix, 1);
596 wt_status_use_color = saved_color_setting;
597 } else {
598 struct rev_info rev;
599 unsigned char sha1[20];
600 const char *parent = "HEAD";
602 if (!active_nr && read_cache() < 0)
603 die("Cannot read index");
605 if (amend)
606 parent = "HEAD^1";
608 if (get_sha1(parent, sha1))
609 commitable = !!active_nr;
610 else {
611 init_revisions(&rev, "");
612 rev.abbrev = 0;
613 setup_revisions(0, NULL, &rev, parent);
614 DIFF_OPT_SET(&rev.diffopt, QUIET);
615 DIFF_OPT_SET(&rev.diffopt, EXIT_WITH_STATUS);
616 run_diff_index(&rev, 1 /* cached */);
618 commitable = !!DIFF_OPT_TST(&rev.diffopt, HAS_CHANGES);
622 fclose(fp);
624 if (!commitable && !in_merge && !allow_empty &&
625 !(amend && is_a_merge(head_sha1))) {
626 run_status(stdout, index_file, prefix, 0);
627 unlink(commit_editmsg);
628 return 0;
632 * Re-read the index as pre-commit hook could have updated it,
633 * and write it out as a tree. We must do this before we invoke
634 * the editor and after we invoke run_status above.
636 discard_cache();
637 read_cache_from(index_file);
638 if (!active_cache_tree)
639 active_cache_tree = cache_tree();
640 if (cache_tree_update(active_cache_tree,
641 active_cache, active_nr, 0, 0) < 0) {
642 error("Error building trees");
643 return 0;
646 if (run_hook(index_file, "prepare-commit-msg",
647 git_path(commit_editmsg), hook_arg1, hook_arg2, NULL))
648 return 0;
650 if (use_editor) {
651 char index[PATH_MAX];
652 const char *env[2] = { index, NULL };
653 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
654 if (launch_editor(git_path(commit_editmsg), NULL, env)) {
655 fprintf(stderr,
656 "Please supply the message using either -m or -F option.\n");
657 exit(1);
661 if (!no_verify &&
662 run_hook(index_file, "commit-msg", git_path(commit_editmsg), NULL)) {
663 return 0;
666 return 1;
670 * Find out if the message starting at position 'start' in the strbuf
671 * contains only whitespace and Signed-off-by lines.
673 static int message_is_empty(struct strbuf *sb, int start)
675 struct strbuf tmpl;
676 const char *nl;
677 int eol, i;
679 if (cleanup_mode == CLEANUP_NONE && sb->len)
680 return 0;
682 /* See if the template is just a prefix of the message. */
683 strbuf_init(&tmpl, 0);
684 if (template_file && strbuf_read_file(&tmpl, template_file, 0) > 0) {
685 stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
686 if (start + tmpl.len <= sb->len &&
687 memcmp(tmpl.buf, sb->buf + start, tmpl.len) == 0)
688 start += tmpl.len;
690 strbuf_release(&tmpl);
692 /* Check if the rest is just whitespace and Signed-of-by's. */
693 for (i = start; i < sb->len; i++) {
694 nl = memchr(sb->buf + i, '\n', sb->len - i);
695 if (nl)
696 eol = nl - sb->buf;
697 else
698 eol = sb->len;
700 if (strlen(sign_off_header) <= eol - i &&
701 !prefixcmp(sb->buf + i, sign_off_header)) {
702 i = eol;
703 continue;
705 while (i < eol)
706 if (!isspace(sb->buf[i++]))
707 return 0;
710 return 1;
713 static int parse_and_validate_options(int argc, const char *argv[],
714 const char * const usage[])
716 int f = 0;
718 argc = parse_options(argc, argv, builtin_commit_options, usage, 0);
720 if (logfile || message.len || use_message)
721 use_editor = 0;
722 if (edit_flag)
723 use_editor = 1;
724 if (!use_editor)
725 setenv("GIT_EDITOR", ":", 1);
727 if (get_sha1("HEAD", head_sha1))
728 initial_commit = 1;
730 if (!get_sha1("MERGE_HEAD", merge_head_sha1))
731 in_merge = 1;
733 /* Sanity check options */
734 if (amend && initial_commit)
735 die("You have nothing to amend.");
736 if (amend && in_merge)
737 die("You are in the middle of a merge -- cannot amend.");
739 if (use_message)
740 f++;
741 if (edit_message)
742 f++;
743 if (logfile)
744 f++;
745 if (f > 1)
746 die("Only one of -c/-C/-F can be used.");
747 if (message.len && f > 0)
748 die("Option -m cannot be combined with -c/-C/-F.");
749 if (edit_message)
750 use_message = edit_message;
751 if (amend && !use_message)
752 use_message = "HEAD";
753 if (use_message) {
754 unsigned char sha1[20];
755 static char utf8[] = "UTF-8";
756 const char *out_enc;
757 char *enc, *end;
758 struct commit *commit;
760 if (get_sha1(use_message, sha1))
761 die("could not lookup commit %s", use_message);
762 commit = lookup_commit_reference(sha1);
763 if (!commit || parse_commit(commit))
764 die("could not parse commit %s", use_message);
766 enc = strstr(commit->buffer, "\nencoding");
767 if (enc) {
768 end = strchr(enc + 10, '\n');
769 enc = xstrndup(enc + 10, end - (enc + 10));
770 } else {
771 enc = utf8;
773 out_enc = git_commit_encoding ? git_commit_encoding : utf8;
775 if (strcmp(out_enc, enc))
776 use_message_buffer =
777 reencode_string(commit->buffer, out_enc, enc);
780 * If we failed to reencode the buffer, just copy it
781 * byte for byte so the user can try to fix it up.
782 * This also handles the case where input and output
783 * encodings are identical.
785 if (use_message_buffer == NULL)
786 use_message_buffer = xstrdup(commit->buffer);
787 if (enc != utf8)
788 free(enc);
791 if (!!also + !!only + !!all + !!interactive > 1)
792 die("Only one of --include/--only/--all/--interactive can be used.");
793 if (argc == 0 && (also || (only && !amend)))
794 die("No paths with --include/--only does not make sense.");
795 if (argc == 0 && only && amend)
796 only_include_assumed = "Clever... amending the last one with dirty index.";
797 if (argc > 0 && !also && !only)
798 only_include_assumed = "Explicit paths specified without -i nor -o; assuming --only paths...";
799 if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
800 cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
801 else if (!strcmp(cleanup_arg, "verbatim"))
802 cleanup_mode = CLEANUP_NONE;
803 else if (!strcmp(cleanup_arg, "whitespace"))
804 cleanup_mode = CLEANUP_SPACE;
805 else if (!strcmp(cleanup_arg, "strip"))
806 cleanup_mode = CLEANUP_ALL;
807 else
808 die("Invalid cleanup mode %s", cleanup_arg);
810 if (!untracked_files_arg)
811 ; /* default already initialized */
812 else if (!strcmp(untracked_files_arg, "no"))
813 show_untracked_files = SHOW_NO_UNTRACKED_FILES;
814 else if (!strcmp(untracked_files_arg, "normal"))
815 show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
816 else if (!strcmp(untracked_files_arg, "all"))
817 show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
818 else
819 die("Invalid untracked files mode '%s'", untracked_files_arg);
821 if (all && argc > 0)
822 die("Paths with -a does not make sense.");
823 else if (interactive && argc > 0)
824 die("Paths with --interactive does not make sense.");
826 return argc;
829 int cmd_status(int argc, const char **argv, const char *prefix)
831 const char *index_file;
832 int commitable;
834 git_config(git_status_config, NULL);
836 if (wt_status_use_color == -1)
837 wt_status_use_color = git_use_color_default;
839 argc = parse_and_validate_options(argc, argv, builtin_status_usage);
841 index_file = prepare_index(argc, argv, prefix);
843 commitable = run_status(stdout, index_file, prefix, 0);
845 rollback_index_files();
847 return commitable ? 0 : 1;
850 static void print_summary(const char *prefix, const unsigned char *sha1)
852 struct rev_info rev;
853 struct commit *commit;
855 commit = lookup_commit(sha1);
856 if (!commit)
857 die("couldn't look up newly created commit");
858 if (!commit || parse_commit(commit))
859 die("could not parse newly created commit");
861 init_revisions(&rev, prefix);
862 setup_revisions(0, NULL, &rev, NULL);
864 rev.abbrev = 0;
865 rev.diff = 1;
866 rev.diffopt.output_format =
867 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
869 rev.verbose_header = 1;
870 rev.show_root_diff = 1;
871 get_commit_format("format:%h: %s", &rev);
872 rev.always_show_header = 0;
873 rev.diffopt.detect_rename = 1;
874 rev.diffopt.rename_limit = 100;
875 rev.diffopt.break_opt = 0;
876 diff_setup_done(&rev.diffopt);
878 printf("Created %scommit ", initial_commit ? "initial " : "");
880 if (!log_tree_commit(&rev, commit)) {
881 struct strbuf buf = STRBUF_INIT;
882 format_commit_message(commit, "%h: %s", &buf);
883 printf("%s\n", buf.buf);
884 strbuf_release(&buf);
888 static int git_commit_config(const char *k, const char *v, void *cb)
890 if (!strcmp(k, "commit.template"))
891 return git_config_string(&template_file, k, v);
893 return git_status_config(k, v, cb);
896 static const char commit_utf8_warn[] =
897 "Warning: commit message does not conform to UTF-8.\n"
898 "You may want to amend it after fixing the message, or set the config\n"
899 "variable i18n.commitencoding to the encoding your project uses.\n";
901 static void add_parent(struct strbuf *sb, const unsigned char *sha1)
903 struct object *obj = parse_object(sha1);
904 const char *parent = sha1_to_hex(sha1);
905 const char *cp;
907 if (!obj)
908 die("Unable to find commit parent %s", parent);
909 if (obj->type != OBJ_COMMIT)
910 die("Parent %s isn't a proper commit", parent);
912 for (cp = sb->buf; cp && (cp = strstr(cp, "\nparent ")); cp += 8) {
913 if (!memcmp(cp + 8, parent, 40) && cp[48] == '\n') {
914 error("duplicate parent %s ignored", parent);
915 return;
918 strbuf_addf(sb, "parent %s\n", parent);
921 int cmd_commit(int argc, const char **argv, const char *prefix)
923 int header_len;
924 struct strbuf sb;
925 const char *index_file, *reflog_msg;
926 char *nl, *p;
927 unsigned char commit_sha1[20];
928 struct ref_lock *ref_lock;
930 git_config(git_commit_config, NULL);
932 argc = parse_and_validate_options(argc, argv, builtin_commit_usage);
934 index_file = prepare_index(argc, argv, prefix);
936 /* Set up everything for writing the commit object. This includes
937 running hooks, writing the trees, and interacting with the user. */
938 if (!prepare_to_commit(index_file, prefix)) {
939 rollback_index_files();
940 return 1;
944 * The commit object
946 strbuf_init(&sb, 0);
947 strbuf_addf(&sb, "tree %s\n",
948 sha1_to_hex(active_cache_tree->sha1));
950 /* Determine parents */
951 if (initial_commit) {
952 reflog_msg = "commit (initial)";
953 } else if (amend) {
954 struct commit_list *c;
955 struct commit *commit;
957 reflog_msg = "commit (amend)";
958 commit = lookup_commit(head_sha1);
959 if (!commit || parse_commit(commit))
960 die("could not parse HEAD commit");
962 for (c = commit->parents; c; c = c->next)
963 add_parent(&sb, c->item->object.sha1);
964 } else if (in_merge) {
965 struct strbuf m;
966 FILE *fp;
968 reflog_msg = "commit (merge)";
969 add_parent(&sb, head_sha1);
970 strbuf_init(&m, 0);
971 fp = fopen(git_path("MERGE_HEAD"), "r");
972 if (fp == NULL)
973 die("could not open %s for reading: %s",
974 git_path("MERGE_HEAD"), strerror(errno));
975 while (strbuf_getline(&m, fp, '\n') != EOF) {
976 unsigned char sha1[20];
977 if (get_sha1_hex(m.buf, sha1) < 0)
978 die("Corrupt MERGE_HEAD file (%s)", m.buf);
979 add_parent(&sb, sha1);
981 fclose(fp);
982 strbuf_release(&m);
983 } else {
984 reflog_msg = "commit";
985 strbuf_addf(&sb, "parent %s\n", sha1_to_hex(head_sha1));
988 strbuf_addf(&sb, "author %s\n",
989 fmt_ident(author_name, author_email, author_date, IDENT_ERROR_ON_NO_NAME));
990 strbuf_addf(&sb, "committer %s\n", git_committer_info(IDENT_ERROR_ON_NO_NAME));
991 if (!is_encoding_utf8(git_commit_encoding))
992 strbuf_addf(&sb, "encoding %s\n", git_commit_encoding);
993 strbuf_addch(&sb, '\n');
995 /* Finally, get the commit message */
996 header_len = sb.len;
997 if (strbuf_read_file(&sb, git_path(commit_editmsg), 0) < 0) {
998 rollback_index_files();
999 die("could not read commit message");
1002 /* Truncate the message just before the diff, if any. */
1003 p = strstr(sb.buf, "\ndiff --git a/");
1004 if (p != NULL)
1005 strbuf_setlen(&sb, p - sb.buf + 1);
1007 if (cleanup_mode != CLEANUP_NONE)
1008 stripspace(&sb, cleanup_mode == CLEANUP_ALL);
1009 if (sb.len < header_len || message_is_empty(&sb, header_len)) {
1010 rollback_index_files();
1011 fprintf(stderr, "Aborting commit due to empty commit message.\n");
1012 exit(1);
1014 strbuf_addch(&sb, '\0');
1015 if (is_encoding_utf8(git_commit_encoding) && !is_utf8(sb.buf))
1016 fprintf(stderr, commit_utf8_warn);
1018 if (write_sha1_file(sb.buf, sb.len - 1, commit_type, commit_sha1)) {
1019 rollback_index_files();
1020 die("failed to write commit object");
1023 ref_lock = lock_any_ref_for_update("HEAD",
1024 initial_commit ? NULL : head_sha1,
1027 nl = strchr(sb.buf + header_len, '\n');
1028 if (nl)
1029 strbuf_setlen(&sb, nl + 1 - sb.buf);
1030 else
1031 strbuf_addch(&sb, '\n');
1032 strbuf_remove(&sb, 0, header_len);
1033 strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
1034 strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
1036 if (!ref_lock) {
1037 rollback_index_files();
1038 die("cannot lock HEAD ref");
1040 if (write_ref_sha1(ref_lock, commit_sha1, sb.buf) < 0) {
1041 rollback_index_files();
1042 die("cannot update HEAD ref");
1045 unlink(git_path("MERGE_HEAD"));
1046 unlink(git_path("MERGE_MSG"));
1047 unlink(git_path("SQUASH_MSG"));
1049 if (commit_index_files())
1050 die ("Repository has been updated, but unable to write\n"
1051 "new_index file. Check that disk is not full or quota is\n"
1052 "not exceeded, and then \"git reset HEAD\" to recover.");
1054 rerere();
1055 run_hook(get_index_file(), "post-commit", NULL);
1056 if (!quiet)
1057 print_summary(prefix, commit_sha1);
1059 return 0;