commit: --cleanup is a message option
[git/jnareb-git.git] / builtin-commit.c
blobcd4eff4719ec22cf382112503e8eb03077256648
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),
90 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"),
99 OPT_STRING(0, "cleanup", &cleanup_arg, "default", "how to strip spaces and #comments from message"),
100 /* end commit message options */
102 OPT_GROUP("Commit contents options"),
103 OPT_BOOLEAN('a', "all", &all, "commit all changed files"),
104 OPT_BOOLEAN('i', "include", &also, "add specified files to index for commit"),
105 OPT_BOOLEAN(0, "interactive", &interactive, "interactively add files"),
106 OPT_BOOLEAN('o', "only", &only, "commit only specified files"),
107 OPT_BOOLEAN('n', "no-verify", &no_verify, "bypass pre-commit hook"),
108 OPT_BOOLEAN(0, "amend", &amend, "amend previous commit"),
109 { 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" },
110 OPT_BOOLEAN(0, "allow-empty", &allow_empty, "ok to record an empty change"),
111 /* end commit contents options */
113 OPT_END()
116 static void rollback_index_files(void)
118 switch (commit_style) {
119 case COMMIT_AS_IS:
120 break; /* nothing to do */
121 case COMMIT_NORMAL:
122 rollback_lock_file(&index_lock);
123 break;
124 case COMMIT_PARTIAL:
125 rollback_lock_file(&index_lock);
126 rollback_lock_file(&false_lock);
127 break;
131 static int commit_index_files(void)
133 int err = 0;
135 switch (commit_style) {
136 case COMMIT_AS_IS:
137 break; /* nothing to do */
138 case COMMIT_NORMAL:
139 err = commit_lock_file(&index_lock);
140 break;
141 case COMMIT_PARTIAL:
142 err = commit_lock_file(&index_lock);
143 rollback_lock_file(&false_lock);
144 break;
147 return err;
151 * Take a union of paths in the index and the named tree (typically, "HEAD"),
152 * and return the paths that match the given pattern in list.
154 static int list_paths(struct string_list *list, const char *with_tree,
155 const char *prefix, const char **pattern)
157 int i;
158 char *m;
160 for (i = 0; pattern[i]; i++)
162 m = xcalloc(1, i);
164 if (with_tree)
165 overlay_tree_on_cache(with_tree, prefix);
167 for (i = 0; i < active_nr; i++) {
168 struct cache_entry *ce = active_cache[i];
169 if (ce->ce_flags & CE_UPDATE)
170 continue;
171 if (!pathspec_match(pattern, m, ce->name, 0))
172 continue;
173 string_list_insert(ce->name, list);
176 return report_path_error(m, pattern, prefix ? strlen(prefix) : 0);
179 static void add_remove_files(struct string_list *list)
181 int i;
182 for (i = 0; i < list->nr; i++) {
183 struct stat st;
184 struct string_list_item *p = &(list->items[i]);
186 if (!lstat(p->string, &st)) {
187 if (add_to_cache(p->string, &st, 0))
188 die("updating files failed");
189 } else
190 remove_file_from_cache(p->string);
194 static void create_base_index(void)
196 struct tree *tree;
197 struct unpack_trees_options opts;
198 struct tree_desc t;
200 if (initial_commit) {
201 discard_cache();
202 return;
205 memset(&opts, 0, sizeof(opts));
206 opts.head_idx = 1;
207 opts.index_only = 1;
208 opts.merge = 1;
209 opts.src_index = &the_index;
210 opts.dst_index = &the_index;
212 opts.fn = oneway_merge;
213 tree = parse_tree_indirect(head_sha1);
214 if (!tree)
215 die("failed to unpack HEAD tree object");
216 parse_tree(tree);
217 init_tree_desc(&t, tree->buffer, tree->size);
218 if (unpack_trees(1, &t, &opts))
219 exit(128); /* We've already reported the error, finish dying */
222 static char *prepare_index(int argc, const char **argv, const char *prefix)
224 int fd;
225 struct string_list partial;
226 const char **pathspec = NULL;
228 if (interactive) {
229 if (interactive_add(argc, argv, prefix) != 0)
230 die("interactive add failed");
231 if (read_cache() < 0)
232 die("index file corrupt");
233 commit_style = COMMIT_AS_IS;
234 return get_index_file();
237 if (read_cache() < 0)
238 die("index file corrupt");
240 if (*argv)
241 pathspec = get_pathspec(prefix, argv);
244 * Non partial, non as-is commit.
246 * (1) get the real index;
247 * (2) update the_index as necessary;
248 * (3) write the_index out to the real index (still locked);
249 * (4) return the name of the locked index file.
251 * The caller should run hooks on the locked real index, and
252 * (A) if all goes well, commit the real index;
253 * (B) on failure, rollback the real index.
255 if (all || (also && pathspec && *pathspec)) {
256 int fd = hold_locked_index(&index_lock, 1);
257 add_files_to_cache(also ? prefix : NULL, pathspec, 0);
258 refresh_cache(REFRESH_QUIET);
259 if (write_cache(fd, active_cache, active_nr) ||
260 close_lock_file(&index_lock))
261 die("unable to write new_index file");
262 commit_style = COMMIT_NORMAL;
263 return index_lock.filename;
267 * As-is commit.
269 * (1) return the name of the real index file.
271 * The caller should run hooks on the real index, and run
272 * hooks on the real index, and create commit from the_index.
273 * We still need to refresh the index here.
275 if (!pathspec || !*pathspec) {
276 fd = hold_locked_index(&index_lock, 1);
277 refresh_cache(REFRESH_QUIET);
278 if (write_cache(fd, active_cache, active_nr) ||
279 commit_locked_index(&index_lock))
280 die("unable to write new_index file");
281 commit_style = COMMIT_AS_IS;
282 return get_index_file();
286 * A partial commit.
288 * (0) find the set of affected paths;
289 * (1) get lock on the real index file;
290 * (2) update the_index with the given paths;
291 * (3) write the_index out to the real index (still locked);
292 * (4) get lock on the false index file;
293 * (5) reset the_index from HEAD;
294 * (6) update the_index the same way as (2);
295 * (7) write the_index out to the false index file;
296 * (8) return the name of the false index file (still locked);
298 * The caller should run hooks on the locked false index, and
299 * create commit from it. Then
300 * (A) if all goes well, commit the real index;
301 * (B) on failure, rollback the real index;
302 * In either case, rollback the false index.
304 commit_style = COMMIT_PARTIAL;
306 if (file_exists(git_path("MERGE_HEAD")))
307 die("cannot do a partial commit during a merge.");
309 memset(&partial, 0, sizeof(partial));
310 partial.strdup_strings = 1;
311 if (list_paths(&partial, initial_commit ? NULL : "HEAD", prefix, pathspec))
312 exit(1);
314 discard_cache();
315 if (read_cache() < 0)
316 die("cannot read the index");
318 fd = hold_locked_index(&index_lock, 1);
319 add_remove_files(&partial);
320 refresh_cache(REFRESH_QUIET);
321 if (write_cache(fd, active_cache, active_nr) ||
322 close_lock_file(&index_lock))
323 die("unable to write new_index file");
325 fd = hold_lock_file_for_update(&false_lock,
326 git_path("next-index-%d", getpid()),
327 LOCK_DIE_ON_ERROR);
329 create_base_index();
330 add_remove_files(&partial);
331 refresh_cache(REFRESH_QUIET);
333 if (write_cache(fd, active_cache, active_nr) ||
334 close_lock_file(&false_lock))
335 die("unable to write temporary index file");
337 discard_cache();
338 read_cache_from(false_lock.filename);
340 return false_lock.filename;
343 static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn)
345 struct wt_status s;
347 wt_status_prepare(&s);
348 if (wt_status_relative_paths)
349 s.prefix = prefix;
351 if (amend) {
352 s.amend = 1;
353 s.reference = "HEAD^1";
355 s.verbose = verbose;
356 s.untracked = (show_untracked_files == SHOW_ALL_UNTRACKED_FILES);
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 run_hook(const char *index_file, const char *name, ...)
368 struct child_process hook;
369 const char *argv[10], *env[2];
370 char index[PATH_MAX];
371 va_list args;
372 int i;
374 va_start(args, name);
375 argv[0] = git_path("hooks/%s", name);
376 i = 0;
377 do {
378 if (++i >= ARRAY_SIZE(argv))
379 die ("run_hook(): too many arguments");
380 argv[i] = va_arg(args, const char *);
381 } while (argv[i]);
382 va_end(args);
384 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
385 env[0] = index;
386 env[1] = NULL;
388 if (access(argv[0], X_OK) < 0)
389 return 0;
391 memset(&hook, 0, sizeof(hook));
392 hook.argv = argv;
393 hook.no_stdin = 1;
394 hook.stdout_to_stderr = 1;
395 hook.env = env;
397 return run_command(&hook);
400 static int is_a_merge(const unsigned char *sha1)
402 struct commit *commit = lookup_commit(sha1);
403 if (!commit || parse_commit(commit))
404 die("could not parse HEAD commit");
405 return !!(commit->parents && commit->parents->next);
408 static const char sign_off_header[] = "Signed-off-by: ";
410 static void determine_author_info(void)
412 char *name, *email, *date;
414 name = getenv("GIT_AUTHOR_NAME");
415 email = getenv("GIT_AUTHOR_EMAIL");
416 date = getenv("GIT_AUTHOR_DATE");
418 if (use_message) {
419 const char *a, *lb, *rb, *eol;
421 a = strstr(use_message_buffer, "\nauthor ");
422 if (!a)
423 die("invalid commit: %s", use_message);
425 lb = strstr(a + 8, " <");
426 rb = strstr(a + 8, "> ");
427 eol = strchr(a + 8, '\n');
428 if (!lb || !rb || !eol)
429 die("invalid commit: %s", use_message);
431 name = xstrndup(a + 8, lb - (a + 8));
432 email = xstrndup(lb + 2, rb - (lb + 2));
433 date = xstrndup(rb + 2, eol - (rb + 2));
436 if (force_author) {
437 const char *lb = strstr(force_author, " <");
438 const char *rb = strchr(force_author, '>');
440 if (!lb || !rb)
441 die("malformed --author parameter");
442 name = xstrndup(force_author, lb - force_author);
443 email = xstrndup(lb + 2, rb - (lb + 2));
446 author_name = name;
447 author_email = email;
448 author_date = date;
451 static int prepare_to_commit(const char *index_file, const char *prefix)
453 struct stat statbuf;
454 int commitable, saved_color_setting;
455 struct strbuf sb;
456 char *buffer;
457 FILE *fp;
458 const char *hook_arg1 = NULL;
459 const char *hook_arg2 = NULL;
460 int ident_shown = 0;
462 if (!no_verify && run_hook(index_file, "pre-commit", NULL))
463 return 0;
465 strbuf_init(&sb, 0);
466 if (message.len) {
467 strbuf_addbuf(&sb, &message);
468 hook_arg1 = "message";
469 } else if (logfile && !strcmp(logfile, "-")) {
470 if (isatty(0))
471 fprintf(stderr, "(reading log message from standard input)\n");
472 if (strbuf_read(&sb, 0, 0) < 0)
473 die("could not read log from standard input");
474 hook_arg1 = "message";
475 } else if (logfile) {
476 if (strbuf_read_file(&sb, logfile, 0) < 0)
477 die("could not read log file '%s': %s",
478 logfile, strerror(errno));
479 hook_arg1 = "message";
480 } else if (use_message) {
481 buffer = strstr(use_message_buffer, "\n\n");
482 if (!buffer || buffer[2] == '\0')
483 die("commit has empty message");
484 strbuf_add(&sb, buffer + 2, strlen(buffer + 2));
485 hook_arg1 = "commit";
486 hook_arg2 = use_message;
487 } else if (!stat(git_path("MERGE_MSG"), &statbuf)) {
488 if (strbuf_read_file(&sb, git_path("MERGE_MSG"), 0) < 0)
489 die("could not read MERGE_MSG: %s", strerror(errno));
490 hook_arg1 = "merge";
491 } else if (!stat(git_path("SQUASH_MSG"), &statbuf)) {
492 if (strbuf_read_file(&sb, git_path("SQUASH_MSG"), 0) < 0)
493 die("could not read SQUASH_MSG: %s", strerror(errno));
494 hook_arg1 = "squash";
495 } else if (template_file && !stat(template_file, &statbuf)) {
496 if (strbuf_read_file(&sb, template_file, 0) < 0)
497 die("could not read %s: %s",
498 template_file, strerror(errno));
499 hook_arg1 = "template";
503 * This final case does not modify the template message,
504 * it just sets the argument to the prepare-commit-msg hook.
506 else if (in_merge)
507 hook_arg1 = "merge";
509 fp = fopen(git_path(commit_editmsg), "w");
510 if (fp == NULL)
511 die("could not open %s: %s",
512 git_path(commit_editmsg), strerror(errno));
514 if (cleanup_mode != CLEANUP_NONE)
515 stripspace(&sb, 0);
517 if (signoff) {
518 struct strbuf sob;
519 int i;
521 strbuf_init(&sob, 0);
522 strbuf_addstr(&sob, sign_off_header);
523 strbuf_addstr(&sob, fmt_name(getenv("GIT_COMMITTER_NAME"),
524 getenv("GIT_COMMITTER_EMAIL")));
525 strbuf_addch(&sob, '\n');
526 for (i = sb.len - 1; i > 0 && sb.buf[i - 1] != '\n'; i--)
527 ; /* do nothing */
528 if (prefixcmp(sb.buf + i, sob.buf)) {
529 if (prefixcmp(sb.buf + i, sign_off_header))
530 strbuf_addch(&sb, '\n');
531 strbuf_addbuf(&sb, &sob);
533 strbuf_release(&sob);
536 if (fwrite(sb.buf, 1, sb.len, fp) < sb.len)
537 die("could not write commit template: %s", strerror(errno));
539 strbuf_release(&sb);
541 determine_author_info();
543 /* This checks if committer ident is explicitly given */
544 git_committer_info(0);
545 if (use_editor) {
546 char *author_ident;
547 const char *committer_ident;
549 if (in_merge)
550 fprintf(fp,
551 "#\n"
552 "# It looks like you may be committing a MERGE.\n"
553 "# If this is not correct, please remove the file\n"
554 "# %s\n"
555 "# and try again.\n"
556 "#\n",
557 git_path("MERGE_HEAD"));
559 fprintf(fp,
560 "\n"
561 "# Please enter the commit message for your changes.");
562 if (cleanup_mode == CLEANUP_ALL)
563 fprintf(fp,
564 " Lines starting\n"
565 "# with '#' will be ignored, and an empty"
566 " message aborts the commit.\n");
567 else /* CLEANUP_SPACE, that is. */
568 fprintf(fp,
569 " Lines starting\n"
570 "# with '#' will be kept; you may remove them"
571 " yourself if you want to.\n"
572 "# An empty message aborts the commit.\n");
573 if (only_include_assumed)
574 fprintf(fp, "# %s\n", only_include_assumed);
576 author_ident = xstrdup(fmt_name(author_name, author_email));
577 committer_ident = fmt_name(getenv("GIT_COMMITTER_NAME"),
578 getenv("GIT_COMMITTER_EMAIL"));
579 if (strcmp(author_ident, committer_ident))
580 fprintf(fp,
581 "%s"
582 "# Author: %s\n",
583 ident_shown++ ? "" : "#\n",
584 author_ident);
585 free(author_ident);
587 if (!user_ident_explicitly_given)
588 fprintf(fp,
589 "%s"
590 "# Committer: %s\n",
591 ident_shown++ ? "" : "#\n",
592 committer_ident);
594 if (ident_shown)
595 fprintf(fp, "#\n");
597 saved_color_setting = wt_status_use_color;
598 wt_status_use_color = 0;
599 commitable = run_status(fp, index_file, prefix, 1);
600 wt_status_use_color = saved_color_setting;
601 } else {
602 struct rev_info rev;
603 unsigned char sha1[20];
604 const char *parent = "HEAD";
606 if (!active_nr && read_cache() < 0)
607 die("Cannot read index");
609 if (amend)
610 parent = "HEAD^1";
612 if (get_sha1(parent, sha1))
613 commitable = !!active_nr;
614 else {
615 init_revisions(&rev, "");
616 rev.abbrev = 0;
617 setup_revisions(0, NULL, &rev, parent);
618 DIFF_OPT_SET(&rev.diffopt, QUIET);
619 DIFF_OPT_SET(&rev.diffopt, EXIT_WITH_STATUS);
620 run_diff_index(&rev, 1 /* cached */);
622 commitable = !!DIFF_OPT_TST(&rev.diffopt, HAS_CHANGES);
626 fclose(fp);
628 if (!commitable && !in_merge && !allow_empty &&
629 !(amend && is_a_merge(head_sha1))) {
630 run_status(stdout, index_file, prefix, 0);
631 return 0;
635 * Re-read the index as pre-commit hook could have updated it,
636 * and write it out as a tree. We must do this before we invoke
637 * the editor and after we invoke run_status above.
639 discard_cache();
640 read_cache_from(index_file);
641 if (!active_cache_tree)
642 active_cache_tree = cache_tree();
643 if (cache_tree_update(active_cache_tree,
644 active_cache, active_nr, 0, 0) < 0) {
645 error("Error building trees; the index is unmerged?");
646 return 0;
649 if (run_hook(index_file, "prepare-commit-msg",
650 git_path(commit_editmsg), hook_arg1, hook_arg2, NULL))
651 return 0;
653 if (use_editor) {
654 char index[PATH_MAX];
655 const char *env[2] = { index, NULL };
656 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
657 if (launch_editor(git_path(commit_editmsg), NULL, env)) {
658 fprintf(stderr,
659 "Please supply the message using either -m or -F option.\n");
660 exit(1);
664 if (!no_verify &&
665 run_hook(index_file, "commit-msg", git_path(commit_editmsg), NULL)) {
666 return 0;
669 return 1;
673 * Find out if the message starting at position 'start' in the strbuf
674 * contains only whitespace and Signed-off-by lines.
676 static int message_is_empty(struct strbuf *sb, int start)
678 struct strbuf tmpl;
679 const char *nl;
680 int eol, i;
682 if (cleanup_mode == CLEANUP_NONE && sb->len)
683 return 0;
685 /* See if the template is just a prefix of the message. */
686 strbuf_init(&tmpl, 0);
687 if (template_file && strbuf_read_file(&tmpl, template_file, 0) > 0) {
688 stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
689 if (start + tmpl.len <= sb->len &&
690 memcmp(tmpl.buf, sb->buf + start, tmpl.len) == 0)
691 start += tmpl.len;
693 strbuf_release(&tmpl);
695 /* Check if the rest is just whitespace and Signed-of-by's. */
696 for (i = start; i < sb->len; i++) {
697 nl = memchr(sb->buf + i, '\n', sb->len - i);
698 if (nl)
699 eol = nl - sb->buf;
700 else
701 eol = sb->len;
703 if (strlen(sign_off_header) <= eol - i &&
704 !prefixcmp(sb->buf + i, sign_off_header)) {
705 i = eol;
706 continue;
708 while (i < eol)
709 if (!isspace(sb->buf[i++]))
710 return 0;
713 return 1;
716 static int parse_and_validate_options(int argc, const char *argv[],
717 const char * const usage[],
718 const char *prefix)
720 int f = 0;
722 argc = parse_options(argc, argv, builtin_commit_options, usage, 0);
723 logfile = parse_options_fix_filename(prefix, logfile);
724 template_file = parse_options_fix_filename(prefix, template_file);
726 if (logfile || message.len || use_message)
727 use_editor = 0;
728 if (edit_flag)
729 use_editor = 1;
730 if (!use_editor)
731 setenv("GIT_EDITOR", ":", 1);
733 if (get_sha1("HEAD", head_sha1))
734 initial_commit = 1;
736 if (!get_sha1("MERGE_HEAD", merge_head_sha1))
737 in_merge = 1;
739 /* Sanity check options */
740 if (amend && initial_commit)
741 die("You have nothing to amend.");
742 if (amend && in_merge)
743 die("You are in the middle of a merge -- cannot amend.");
745 if (use_message)
746 f++;
747 if (edit_message)
748 f++;
749 if (logfile)
750 f++;
751 if (f > 1)
752 die("Only one of -c/-C/-F can be used.");
753 if (message.len && f > 0)
754 die("Option -m cannot be combined with -c/-C/-F.");
755 if (edit_message)
756 use_message = edit_message;
757 if (amend && !use_message)
758 use_message = "HEAD";
759 if (use_message) {
760 unsigned char sha1[20];
761 static char utf8[] = "UTF-8";
762 const char *out_enc;
763 char *enc, *end;
764 struct commit *commit;
766 if (get_sha1(use_message, sha1))
767 die("could not lookup commit %s", use_message);
768 commit = lookup_commit_reference(sha1);
769 if (!commit || parse_commit(commit))
770 die("could not parse commit %s", use_message);
772 enc = strstr(commit->buffer, "\nencoding");
773 if (enc) {
774 end = strchr(enc + 10, '\n');
775 enc = xstrndup(enc + 10, end - (enc + 10));
776 } else {
777 enc = utf8;
779 out_enc = git_commit_encoding ? git_commit_encoding : utf8;
781 if (strcmp(out_enc, enc))
782 use_message_buffer =
783 reencode_string(commit->buffer, out_enc, enc);
786 * If we failed to reencode the buffer, just copy it
787 * byte for byte so the user can try to fix it up.
788 * This also handles the case where input and output
789 * encodings are identical.
791 if (use_message_buffer == NULL)
792 use_message_buffer = xstrdup(commit->buffer);
793 if (enc != utf8)
794 free(enc);
797 if (!!also + !!only + !!all + !!interactive > 1)
798 die("Only one of --include/--only/--all/--interactive can be used.");
799 if (argc == 0 && (also || (only && !amend)))
800 die("No paths with --include/--only does not make sense.");
801 if (argc == 0 && only && amend)
802 only_include_assumed = "Clever... amending the last one with dirty index.";
803 if (argc > 0 && !also && !only)
804 only_include_assumed = "Explicit paths specified without -i nor -o; assuming --only paths...";
805 if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
806 cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
807 else if (!strcmp(cleanup_arg, "verbatim"))
808 cleanup_mode = CLEANUP_NONE;
809 else if (!strcmp(cleanup_arg, "whitespace"))
810 cleanup_mode = CLEANUP_SPACE;
811 else if (!strcmp(cleanup_arg, "strip"))
812 cleanup_mode = CLEANUP_ALL;
813 else
814 die("Invalid cleanup mode %s", cleanup_arg);
816 if (!untracked_files_arg)
817 ; /* default already initialized */
818 else if (!strcmp(untracked_files_arg, "no"))
819 show_untracked_files = SHOW_NO_UNTRACKED_FILES;
820 else if (!strcmp(untracked_files_arg, "normal"))
821 show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
822 else if (!strcmp(untracked_files_arg, "all"))
823 show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
824 else
825 die("Invalid untracked files mode '%s'", untracked_files_arg);
827 if (all && argc > 0)
828 die("Paths with -a does not make sense.");
829 else if (interactive && argc > 0)
830 die("Paths with --interactive does not make sense.");
832 return argc;
835 int cmd_status(int argc, const char **argv, const char *prefix)
837 const char *index_file;
838 int commitable;
840 git_config(git_status_config, NULL);
842 if (wt_status_use_color == -1)
843 wt_status_use_color = git_use_color_default;
845 argc = parse_and_validate_options(argc, argv, builtin_status_usage, prefix);
847 index_file = prepare_index(argc, argv, prefix);
849 commitable = run_status(stdout, index_file, prefix, 0);
851 rollback_index_files();
853 return commitable ? 0 : 1;
856 static void print_summary(const char *prefix, const unsigned char *sha1)
858 struct rev_info rev;
859 struct commit *commit;
861 commit = lookup_commit(sha1);
862 if (!commit)
863 die("couldn't look up newly created commit");
864 if (!commit || parse_commit(commit))
865 die("could not parse newly created commit");
867 init_revisions(&rev, prefix);
868 setup_revisions(0, NULL, &rev, NULL);
870 rev.abbrev = 0;
871 rev.diff = 1;
872 rev.diffopt.output_format =
873 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
875 rev.verbose_header = 1;
876 rev.show_root_diff = 1;
877 get_commit_format("format:%h: %s", &rev);
878 rev.always_show_header = 0;
879 rev.diffopt.detect_rename = 1;
880 rev.diffopt.rename_limit = 100;
881 rev.diffopt.break_opt = 0;
882 diff_setup_done(&rev.diffopt);
884 printf("Created %scommit ", initial_commit ? "initial " : "");
886 if (!log_tree_commit(&rev, commit)) {
887 struct strbuf buf = STRBUF_INIT;
888 format_commit_message(commit, "%h: %s", &buf, DATE_NORMAL);
889 printf("%s\n", buf.buf);
890 strbuf_release(&buf);
894 static int git_commit_config(const char *k, const char *v, void *cb)
896 if (!strcmp(k, "commit.template"))
897 return git_config_string(&template_file, k, v);
899 return git_status_config(k, v, cb);
902 static const char commit_utf8_warn[] =
903 "Warning: commit message does not conform to UTF-8.\n"
904 "You may want to amend it after fixing the message, or set the config\n"
905 "variable i18n.commitencoding to the encoding your project uses.\n";
907 static void add_parent(struct strbuf *sb, const unsigned char *sha1)
909 struct object *obj = parse_object(sha1);
910 const char *parent = sha1_to_hex(sha1);
911 const char *cp;
913 if (!obj)
914 die("Unable to find commit parent %s", parent);
915 if (obj->type != OBJ_COMMIT)
916 die("Parent %s isn't a proper commit", parent);
918 for (cp = sb->buf; cp && (cp = strstr(cp, "\nparent ")); cp += 8) {
919 if (!memcmp(cp + 8, parent, 40) && cp[48] == '\n') {
920 error("duplicate parent %s ignored", parent);
921 return;
924 strbuf_addf(sb, "parent %s\n", parent);
927 int cmd_commit(int argc, const char **argv, const char *prefix)
929 int header_len;
930 struct strbuf sb;
931 const char *index_file, *reflog_msg;
932 char *nl, *p;
933 unsigned char commit_sha1[20];
934 struct ref_lock *ref_lock;
936 git_config(git_commit_config, NULL);
938 argc = parse_and_validate_options(argc, argv, builtin_commit_usage, prefix);
940 index_file = prepare_index(argc, argv, prefix);
942 /* Set up everything for writing the commit object. This includes
943 running hooks, writing the trees, and interacting with the user. */
944 if (!prepare_to_commit(index_file, prefix)) {
945 rollback_index_files();
946 return 1;
950 * The commit object
952 strbuf_init(&sb, 0);
953 strbuf_addf(&sb, "tree %s\n",
954 sha1_to_hex(active_cache_tree->sha1));
956 /* Determine parents */
957 if (initial_commit) {
958 reflog_msg = "commit (initial)";
959 } else if (amend) {
960 struct commit_list *c;
961 struct commit *commit;
963 reflog_msg = "commit (amend)";
964 commit = lookup_commit(head_sha1);
965 if (!commit || parse_commit(commit))
966 die("could not parse HEAD commit");
968 for (c = commit->parents; c; c = c->next)
969 add_parent(&sb, c->item->object.sha1);
970 } else if (in_merge) {
971 struct strbuf m;
972 FILE *fp;
974 reflog_msg = "commit (merge)";
975 add_parent(&sb, head_sha1);
976 strbuf_init(&m, 0);
977 fp = fopen(git_path("MERGE_HEAD"), "r");
978 if (fp == NULL)
979 die("could not open %s for reading: %s",
980 git_path("MERGE_HEAD"), strerror(errno));
981 while (strbuf_getline(&m, fp, '\n') != EOF) {
982 unsigned char sha1[20];
983 if (get_sha1_hex(m.buf, sha1) < 0)
984 die("Corrupt MERGE_HEAD file (%s)", m.buf);
985 add_parent(&sb, sha1);
987 fclose(fp);
988 strbuf_release(&m);
989 } else {
990 reflog_msg = "commit";
991 strbuf_addf(&sb, "parent %s\n", sha1_to_hex(head_sha1));
994 strbuf_addf(&sb, "author %s\n",
995 fmt_ident(author_name, author_email, author_date, IDENT_ERROR_ON_NO_NAME));
996 strbuf_addf(&sb, "committer %s\n", git_committer_info(IDENT_ERROR_ON_NO_NAME));
997 if (!is_encoding_utf8(git_commit_encoding))
998 strbuf_addf(&sb, "encoding %s\n", git_commit_encoding);
999 strbuf_addch(&sb, '\n');
1001 /* Finally, get the commit message */
1002 header_len = sb.len;
1003 if (strbuf_read_file(&sb, git_path(commit_editmsg), 0) < 0) {
1004 rollback_index_files();
1005 die("could not read commit message");
1008 /* Truncate the message just before the diff, if any. */
1009 if (verbose) {
1010 p = strstr(sb.buf, "\ndiff --git ");
1011 if (p != NULL)
1012 strbuf_setlen(&sb, p - sb.buf + 1);
1015 if (cleanup_mode != CLEANUP_NONE)
1016 stripspace(&sb, cleanup_mode == CLEANUP_ALL);
1017 if (sb.len < header_len || message_is_empty(&sb, header_len)) {
1018 rollback_index_files();
1019 fprintf(stderr, "Aborting commit due to empty commit message.\n");
1020 exit(1);
1022 strbuf_addch(&sb, '\0');
1023 if (is_encoding_utf8(git_commit_encoding) && !is_utf8(sb.buf))
1024 fprintf(stderr, commit_utf8_warn);
1026 if (write_sha1_file(sb.buf, sb.len - 1, commit_type, commit_sha1)) {
1027 rollback_index_files();
1028 die("failed to write commit object");
1031 ref_lock = lock_any_ref_for_update("HEAD",
1032 initial_commit ? NULL : head_sha1,
1035 nl = strchr(sb.buf + header_len, '\n');
1036 if (nl)
1037 strbuf_setlen(&sb, nl + 1 - sb.buf);
1038 else
1039 strbuf_addch(&sb, '\n');
1040 strbuf_remove(&sb, 0, header_len);
1041 strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
1042 strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
1044 if (!ref_lock) {
1045 rollback_index_files();
1046 die("cannot lock HEAD ref");
1048 if (write_ref_sha1(ref_lock, commit_sha1, sb.buf) < 0) {
1049 rollback_index_files();
1050 die("cannot update HEAD ref");
1053 unlink(git_path("MERGE_HEAD"));
1054 unlink(git_path("MERGE_MSG"));
1055 unlink(git_path("SQUASH_MSG"));
1057 if (commit_index_files())
1058 die ("Repository has been updated, but unable to write\n"
1059 "new_index file. Check that disk is not full or quota is\n"
1060 "not exceeded, and then \"git reset HEAD\" to recover.");
1062 rerere();
1063 run_hook(get_index_file(), "post-commit", NULL);
1064 if (!quiet)
1065 print_summary(prefix, commit_sha1);
1067 return 0;