Code

Merge branch 'jk/empty-tree'
[git.git] / builtin-commit.c
1 /*
2  * Builtin "git commit"
3  *
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 "dir.h"
11 #include "builtin.h"
12 #include "diff.h"
13 #include "diffcore.h"
14 #include "commit.h"
15 #include "revision.h"
16 #include "wt-status.h"
17 #include "run-command.h"
18 #include "refs.h"
19 #include "log-tree.h"
20 #include "strbuf.h"
21 #include "utf8.h"
22 #include "parse-options.h"
23 #include "path-list.h"
24 #include "unpack-trees.h"
26 static const char * const builtin_commit_usage[] = {
27         "git-commit [options] [--] <filepattern>...",
28         NULL
29 };
31 static const char * const builtin_status_usage[] = {
32         "git-status [options] [--] <filepattern>...",
33         NULL
34 };
36 static unsigned char head_sha1[20], merge_head_sha1[20];
37 static char *use_message_buffer;
38 static const char commit_editmsg[] = "COMMIT_EDITMSG";
39 static struct lock_file index_lock; /* real index */
40 static struct lock_file false_lock; /* used only for partial commits */
41 static enum {
42         COMMIT_AS_IS = 1,
43         COMMIT_NORMAL,
44         COMMIT_PARTIAL,
45 } commit_style;
47 static char *logfile, *force_author, *template_file;
48 static char *edit_message, *use_message;
49 static int all, edit_flag, also, interactive, only, amend, signoff;
50 static int quiet, verbose, untracked_files, no_verify, allow_empty;
51 /*
52  * The default commit message cleanup mode will remove the lines
53  * beginning with # (shell comments) and leading and trailing
54  * whitespaces (empty lines or containing only whitespaces)
55  * if editor is used, and only the whitespaces if the message
56  * is specified explicitly.
57  */
58 static enum {
59         CLEANUP_SPACE,
60         CLEANUP_NONE,
61         CLEANUP_ALL,
62 } cleanup_mode;
63 static char *cleanup_arg;
65 static int use_editor = 1, initial_commit, in_merge;
66 const char *only_include_assumed;
67 struct strbuf message;
69 static int opt_parse_m(const struct option *opt, const char *arg, int unset)
70 {
71         struct strbuf *buf = opt->value;
72         if (unset)
73                 strbuf_setlen(buf, 0);
74         else {
75                 strbuf_addstr(buf, arg);
76                 strbuf_addch(buf, '\n');
77                 strbuf_addch(buf, '\n');
78         }
79         return 0;
80 }
82 static struct option builtin_commit_options[] = {
83         OPT__QUIET(&quiet),
84         OPT__VERBOSE(&verbose),
85         OPT_GROUP("Commit message options"),
87         OPT_STRING('F', "file", &logfile, "FILE", "read log from file"),
88         OPT_STRING(0, "author", &force_author, "AUTHOR", "override author for commit"),
89         OPT_CALLBACK('m', "message", &message, "MESSAGE", "specify commit message", opt_parse_m),
90         OPT_STRING('c', "reedit-message", &edit_message, "COMMIT", "reuse and edit message from specified commit "),
91         OPT_STRING('C', "reuse-message", &use_message, "COMMIT", "reuse message from specified commit"),
92         OPT_BOOLEAN('s', "signoff", &signoff, "add Signed-off-by: header"),
93         OPT_STRING('t', "template", &template_file, "FILE", "use specified template file"),
94         OPT_BOOLEAN('e', "edit", &edit_flag, "force edit of commit"),
96         OPT_GROUP("Commit contents options"),
97         OPT_BOOLEAN('a', "all", &all, "commit all changed files"),
98         OPT_BOOLEAN('i', "include", &also, "add specified files to index for commit"),
99         OPT_BOOLEAN(0, "interactive", &interactive, "interactively add files"),
100         OPT_BOOLEAN('o', "only", &only, ""),
101         OPT_BOOLEAN('n', "no-verify", &no_verify, "bypass pre-commit hook"),
102         OPT_BOOLEAN(0, "amend", &amend, "amend previous commit"),
103         OPT_BOOLEAN(0, "untracked-files", &untracked_files, "show all untracked files"),
104         OPT_BOOLEAN(0, "allow-empty", &allow_empty, "ok to record an empty change"),
105         OPT_STRING(0, "cleanup", &cleanup_arg, "default", "how to strip spaces and #comments from message"),
107         OPT_END()
108 };
110 static void rollback_index_files(void)
112         switch (commit_style) {
113         case COMMIT_AS_IS:
114                 break; /* nothing to do */
115         case COMMIT_NORMAL:
116                 rollback_lock_file(&index_lock);
117                 break;
118         case COMMIT_PARTIAL:
119                 rollback_lock_file(&index_lock);
120                 rollback_lock_file(&false_lock);
121                 break;
122         }
125 static int commit_index_files(void)
127         int err = 0;
129         switch (commit_style) {
130         case COMMIT_AS_IS:
131                 break; /* nothing to do */
132         case COMMIT_NORMAL:
133                 err = commit_lock_file(&index_lock);
134                 break;
135         case COMMIT_PARTIAL:
136                 err = commit_lock_file(&index_lock);
137                 rollback_lock_file(&false_lock);
138                 break;
139         }
141         return err;
144 /*
145  * Take a union of paths in the index and the named tree (typically, "HEAD"),
146  * and return the paths that match the given pattern in list.
147  */
148 static int list_paths(struct path_list *list, const char *with_tree,
149                       const char *prefix, const char **pattern)
151         int i;
152         char *m;
154         for (i = 0; pattern[i]; i++)
155                 ;
156         m = xcalloc(1, i);
158         if (with_tree)
159                 overlay_tree_on_cache(with_tree, prefix);
161         for (i = 0; i < active_nr; i++) {
162                 struct cache_entry *ce = active_cache[i];
163                 if (ce->ce_flags & CE_UPDATE)
164                         continue;
165                 if (!pathspec_match(pattern, m, ce->name, 0))
166                         continue;
167                 path_list_insert(ce->name, list);
168         }
170         return report_path_error(m, pattern, prefix ? strlen(prefix) : 0);
173 static void add_remove_files(struct path_list *list)
175         int i;
176         for (i = 0; i < list->nr; i++) {
177                 struct path_list_item *p = &(list->items[i]);
178                 if (file_exists(p->path))
179                         add_file_to_cache(p->path, 0);
180                 else
181                         remove_file_from_cache(p->path);
182         }
185 static void create_base_index(void)
187         struct tree *tree;
188         struct unpack_trees_options opts;
189         struct tree_desc t;
191         if (initial_commit) {
192                 discard_cache();
193                 return;
194         }
196         memset(&opts, 0, sizeof(opts));
197         opts.head_idx = 1;
198         opts.index_only = 1;
199         opts.merge = 1;
201         opts.fn = oneway_merge;
202         tree = parse_tree_indirect(head_sha1);
203         if (!tree)
204                 die("failed to unpack HEAD tree object");
205         parse_tree(tree);
206         init_tree_desc(&t, tree->buffer, tree->size);
207         unpack_trees(1, &t, &opts);
210 static char *prepare_index(int argc, const char **argv, const char *prefix)
212         int fd;
213         struct path_list partial;
214         const char **pathspec = NULL;
216         if (interactive) {
217                 interactive_add(argc, argv, prefix);
218                 commit_style = COMMIT_AS_IS;
219                 return get_index_file();
220         }
222         if (read_cache() < 0)
223                 die("index file corrupt");
225         if (*argv)
226                 pathspec = get_pathspec(prefix, argv);
228         /*
229          * Non partial, non as-is commit.
230          *
231          * (1) get the real index;
232          * (2) update the_index as necessary;
233          * (3) write the_index out to the real index (still locked);
234          * (4) return the name of the locked index file.
235          *
236          * The caller should run hooks on the locked real index, and
237          * (A) if all goes well, commit the real index;
238          * (B) on failure, rollback the real index.
239          */
240         if (all || (also && pathspec && *pathspec)) {
241                 int fd = hold_locked_index(&index_lock, 1);
242                 add_files_to_cache(0, also ? prefix : NULL, pathspec);
243                 refresh_cache(REFRESH_QUIET);
244                 if (write_cache(fd, active_cache, active_nr) ||
245                     close_lock_file(&index_lock))
246                         die("unable to write new_index file");
247                 commit_style = COMMIT_NORMAL;
248                 return index_lock.filename;
249         }
251         /*
252          * As-is commit.
253          *
254          * (1) return the name of the real index file.
255          *
256          * The caller should run hooks on the real index, and run
257          * hooks on the real index, and create commit from the_index.
258          * We still need to refresh the index here.
259          */
260         if (!pathspec || !*pathspec) {
261                 fd = hold_locked_index(&index_lock, 1);
262                 refresh_cache(REFRESH_QUIET);
263                 if (write_cache(fd, active_cache, active_nr) ||
264                     commit_locked_index(&index_lock))
265                         die("unable to write new_index file");
266                 commit_style = COMMIT_AS_IS;
267                 return get_index_file();
268         }
270         /*
271          * A partial commit.
272          *
273          * (0) find the set of affected paths;
274          * (1) get lock on the real index file;
275          * (2) update the_index with the given paths;
276          * (3) write the_index out to the real index (still locked);
277          * (4) get lock on the false index file;
278          * (5) reset the_index from HEAD;
279          * (6) update the_index the same way as (2);
280          * (7) write the_index out to the false index file;
281          * (8) return the name of the false index file (still locked);
282          *
283          * The caller should run hooks on the locked false index, and
284          * create commit from it.  Then
285          * (A) if all goes well, commit the real index;
286          * (B) on failure, rollback the real index;
287          * In either case, rollback the false index.
288          */
289         commit_style = COMMIT_PARTIAL;
291         if (file_exists(git_path("MERGE_HEAD")))
292                 die("cannot do a partial commit during a merge.");
294         memset(&partial, 0, sizeof(partial));
295         partial.strdup_paths = 1;
296         if (list_paths(&partial, initial_commit ? NULL : "HEAD", prefix, pathspec))
297                 exit(1);
299         discard_cache();
300         if (read_cache() < 0)
301                 die("cannot read the index");
303         fd = hold_locked_index(&index_lock, 1);
304         add_remove_files(&partial);
305         refresh_cache(REFRESH_QUIET);
306         if (write_cache(fd, active_cache, active_nr) ||
307             close_lock_file(&index_lock))
308                 die("unable to write new_index file");
310         fd = hold_lock_file_for_update(&false_lock,
311                                        git_path("next-index-%d", getpid()), 1);
313         create_base_index();
314         add_remove_files(&partial);
315         refresh_cache(REFRESH_QUIET);
317         if (write_cache(fd, active_cache, active_nr) ||
318             close_lock_file(&false_lock))
319                 die("unable to write temporary index file");
321         discard_cache();
322         read_cache_from(false_lock.filename);
324         return false_lock.filename;
327 static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn)
329         struct wt_status s;
331         wt_status_prepare(&s);
332         if (wt_status_relative_paths)
333                 s.prefix = prefix;
335         if (amend) {
336                 s.amend = 1;
337                 s.reference = "HEAD^1";
338         }
339         s.verbose = verbose;
340         s.untracked = untracked_files;
341         s.index_file = index_file;
342         s.fp = fp;
343         s.nowarn = nowarn;
345         wt_status_print(&s);
347         return s.commitable;
350 static int run_hook(const char *index_file, const char *name, ...)
352         struct child_process hook;
353         const char *argv[10], *env[2];
354         char index[PATH_MAX];
355         va_list args;
356         int i;
358         va_start(args, name);
359         argv[0] = git_path("hooks/%s", name);
360         i = 0;
361         do {
362                 if (++i >= ARRAY_SIZE(argv))
363                         die ("run_hook(): too many arguments");
364                 argv[i] = va_arg(args, const char *);
365         } while (argv[i]);
366         va_end(args);
368         snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
369         env[0] = index;
370         env[1] = NULL;
372         if (access(argv[0], X_OK) < 0)
373                 return 0;
375         memset(&hook, 0, sizeof(hook));
376         hook.argv = argv;
377         hook.no_stdin = 1;
378         hook.stdout_to_stderr = 1;
379         hook.env = env;
381         return run_command(&hook);
384 static int is_a_merge(const unsigned char *sha1)
386         struct commit *commit = lookup_commit(sha1);
387         if (!commit || parse_commit(commit))
388                 die("could not parse HEAD commit");
389         return !!(commit->parents && commit->parents->next);
392 static const char sign_off_header[] = "Signed-off-by: ";
394 static int prepare_to_commit(const char *index_file, const char *prefix)
396         struct stat statbuf;
397         int commitable, saved_color_setting;
398         struct strbuf sb;
399         char *buffer;
400         FILE *fp;
401         const char *hook_arg1 = NULL;
402         const char *hook_arg2 = NULL;
404         if (!no_verify && run_hook(index_file, "pre-commit", NULL))
405                 return 0;
407         strbuf_init(&sb, 0);
408         if (message.len) {
409                 strbuf_addbuf(&sb, &message);
410                 hook_arg1 = "message";
411         } else if (logfile && !strcmp(logfile, "-")) {
412                 if (isatty(0))
413                         fprintf(stderr, "(reading log message from standard input)\n");
414                 if (strbuf_read(&sb, 0, 0) < 0)
415                         die("could not read log from standard input");
416                 hook_arg1 = "message";
417         } else if (logfile) {
418                 if (strbuf_read_file(&sb, logfile, 0) < 0)
419                         die("could not read log file '%s': %s",
420                             logfile, strerror(errno));
421                 hook_arg1 = "message";
422         } else if (use_message) {
423                 buffer = strstr(use_message_buffer, "\n\n");
424                 if (!buffer || buffer[2] == '\0')
425                         die("commit has empty message");
426                 strbuf_add(&sb, buffer + 2, strlen(buffer + 2));
427                 hook_arg1 = "commit";
428                 hook_arg2 = use_message;
429         } else if (!stat(git_path("MERGE_MSG"), &statbuf)) {
430                 if (strbuf_read_file(&sb, git_path("MERGE_MSG"), 0) < 0)
431                         die("could not read MERGE_MSG: %s", strerror(errno));
432                 hook_arg1 = "merge";
433         } else if (!stat(git_path("SQUASH_MSG"), &statbuf)) {
434                 if (strbuf_read_file(&sb, git_path("SQUASH_MSG"), 0) < 0)
435                         die("could not read SQUASH_MSG: %s", strerror(errno));
436                 hook_arg1 = "squash";
437         } else if (template_file && !stat(template_file, &statbuf)) {
438                 if (strbuf_read_file(&sb, template_file, 0) < 0)
439                         die("could not read %s: %s",
440                             template_file, strerror(errno));
441                 hook_arg1 = "template";
442         }
444         /*
445          * This final case does not modify the template message,
446          * it just sets the argument to the prepare-commit-msg hook.
447          */
448         else if (in_merge)
449                 hook_arg1 = "merge";
451         fp = fopen(git_path(commit_editmsg), "w");
452         if (fp == NULL)
453                 die("could not open %s", git_path(commit_editmsg));
455         if (cleanup_mode != CLEANUP_NONE)
456                 stripspace(&sb, 0);
458         if (signoff) {
459                 struct strbuf sob;
460                 int i;
462                 strbuf_init(&sob, 0);
463                 strbuf_addstr(&sob, sign_off_header);
464                 strbuf_addstr(&sob, fmt_name(getenv("GIT_COMMITTER_NAME"),
465                                              getenv("GIT_COMMITTER_EMAIL")));
466                 strbuf_addch(&sob, '\n');
467                 for (i = sb.len - 1; i > 0 && sb.buf[i - 1] != '\n'; i--)
468                         ; /* do nothing */
469                 if (prefixcmp(sb.buf + i, sob.buf)) {
470                         if (prefixcmp(sb.buf + i, sign_off_header))
471                                 strbuf_addch(&sb, '\n');
472                         strbuf_addbuf(&sb, &sob);
473                 }
474                 strbuf_release(&sob);
475         }
477         if (fwrite(sb.buf, 1, sb.len, fp) < sb.len)
478                 die("could not write commit template: %s", strerror(errno));
480         strbuf_release(&sb);
482         if (use_editor) {
483                 if (in_merge)
484                         fprintf(fp,
485                                 "#\n"
486                                 "# It looks like you may be committing a MERGE.\n"
487                                 "# If this is not correct, please remove the file\n"
488                                 "#      %s\n"
489                                 "# and try again.\n"
490                                 "#\n",
491                                 git_path("MERGE_HEAD"));
493                 fprintf(fp,
494                         "\n"
495                         "# Please enter the commit message for your changes.\n"
496                         "# (Comment lines starting with '#' will ");
497                 if (cleanup_mode == CLEANUP_ALL)
498                         fprintf(fp, "not be included)\n");
499                 else /* CLEANUP_SPACE, that is. */
500                         fprintf(fp, "be kept.\n"
501                                 "# You can remove them yourself if you want to)\n");
502                 if (only_include_assumed)
503                         fprintf(fp, "# %s\n", only_include_assumed);
505                 saved_color_setting = wt_status_use_color;
506                 wt_status_use_color = 0;
507                 commitable = run_status(fp, index_file, prefix, 1);
508                 wt_status_use_color = saved_color_setting;
509         } else {
510                 struct rev_info rev;
511                 unsigned char sha1[20];
512                 const char *parent = "HEAD";
514                 if (!active_nr && read_cache() < 0)
515                         die("Cannot read index");
517                 if (amend)
518                         parent = "HEAD^1";
520                 if (get_sha1(parent, sha1))
521                         commitable = !!active_nr;
522                 else {
523                         init_revisions(&rev, "");
524                         rev.abbrev = 0;
525                         setup_revisions(0, NULL, &rev, parent);
526                         DIFF_OPT_SET(&rev.diffopt, QUIET);
527                         DIFF_OPT_SET(&rev.diffopt, EXIT_WITH_STATUS);
528                         run_diff_index(&rev, 1 /* cached */);
530                         commitable = !!DIFF_OPT_TST(&rev.diffopt, HAS_CHANGES);
531                 }
532         }
534         fclose(fp);
536         if (!commitable && !in_merge && !allow_empty &&
537             !(amend && is_a_merge(head_sha1))) {
538                 run_status(stdout, index_file, prefix, 0);
539                 unlink(commit_editmsg);
540                 return 0;
541         }
543         /*
544          * Re-read the index as pre-commit hook could have updated it,
545          * and write it out as a tree.  We must do this before we invoke
546          * the editor and after we invoke run_status above.
547          */
548         discard_cache();
549         read_cache_from(index_file);
550         if (!active_cache_tree)
551                 active_cache_tree = cache_tree();
552         if (cache_tree_update(active_cache_tree,
553                               active_cache, active_nr, 0, 0) < 0) {
554                 error("Error building trees");
555                 return 0;
556         }
558         if (run_hook(index_file, "prepare-commit-msg",
559                      git_path(commit_editmsg), hook_arg1, hook_arg2, NULL))
560                 return 0;
562         if (use_editor) {
563                 char index[PATH_MAX];
564                 const char *env[2] = { index, NULL };
565                 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
566                 launch_editor(git_path(commit_editmsg), NULL, env);
567         }
569         if (!no_verify &&
570             run_hook(index_file, "commit-msg", git_path(commit_editmsg), NULL)) {
571                 return 0;
572         }
574         return 1;
577 /*
578  * Find out if the message starting at position 'start' in the strbuf
579  * contains only whitespace and Signed-off-by lines.
580  */
581 static int message_is_empty(struct strbuf *sb, int start)
583         struct strbuf tmpl;
584         const char *nl;
585         int eol, i;
587         if (cleanup_mode == CLEANUP_NONE && sb->len)
588                 return 0;
590         /* See if the template is just a prefix of the message. */
591         strbuf_init(&tmpl, 0);
592         if (template_file && strbuf_read_file(&tmpl, template_file, 0) > 0) {
593                 stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
594                 if (start + tmpl.len <= sb->len &&
595                     memcmp(tmpl.buf, sb->buf + start, tmpl.len) == 0)
596                         start += tmpl.len;
597         }
598         strbuf_release(&tmpl);
600         /* Check if the rest is just whitespace and Signed-of-by's. */
601         for (i = start; i < sb->len; i++) {
602                 nl = memchr(sb->buf + i, '\n', sb->len - i);
603                 if (nl)
604                         eol = nl - sb->buf;
605                 else
606                         eol = sb->len;
608                 if (strlen(sign_off_header) <= eol - i &&
609                     !prefixcmp(sb->buf + i, sign_off_header)) {
610                         i = eol;
611                         continue;
612                 }
613                 while (i < eol)
614                         if (!isspace(sb->buf[i++]))
615                                 return 0;
616         }
618         return 1;
621 static void determine_author_info(struct strbuf *sb)
623         char *name, *email, *date;
625         name = getenv("GIT_AUTHOR_NAME");
626         email = getenv("GIT_AUTHOR_EMAIL");
627         date = getenv("GIT_AUTHOR_DATE");
629         if (use_message) {
630                 const char *a, *lb, *rb, *eol;
632                 a = strstr(use_message_buffer, "\nauthor ");
633                 if (!a)
634                         die("invalid commit: %s", use_message);
636                 lb = strstr(a + 8, " <");
637                 rb = strstr(a + 8, "> ");
638                 eol = strchr(a + 8, '\n');
639                 if (!lb || !rb || !eol)
640                         die("invalid commit: %s", use_message);
642                 name = xstrndup(a + 8, lb - (a + 8));
643                 email = xstrndup(lb + 2, rb - (lb + 2));
644                 date = xstrndup(rb + 2, eol - (rb + 2));
645         }
647         if (force_author) {
648                 const char *lb = strstr(force_author, " <");
649                 const char *rb = strchr(force_author, '>');
651                 if (!lb || !rb)
652                         die("malformed --author parameter");
653                 name = xstrndup(force_author, lb - force_author);
654                 email = xstrndup(lb + 2, rb - (lb + 2));
655         }
657         strbuf_addf(sb, "author %s\n", fmt_ident(name, email, date, IDENT_ERROR_ON_NO_NAME));
660 static int parse_and_validate_options(int argc, const char *argv[],
661                                       const char * const usage[])
663         int f = 0;
665         argc = parse_options(argc, argv, builtin_commit_options, usage, 0);
667         if (logfile || message.len || use_message)
668                 use_editor = 0;
669         if (edit_flag)
670                 use_editor = 1;
671         if (!use_editor)
672                 setenv("GIT_EDITOR", ":", 1);
674         if (get_sha1("HEAD", head_sha1))
675                 initial_commit = 1;
677         if (!get_sha1("MERGE_HEAD", merge_head_sha1))
678                 in_merge = 1;
680         /* Sanity check options */
681         if (amend && initial_commit)
682                 die("You have nothing to amend.");
683         if (amend && in_merge)
684                 die("You are in the middle of a merge -- cannot amend.");
686         if (use_message)
687                 f++;
688         if (edit_message)
689                 f++;
690         if (logfile)
691                 f++;
692         if (f > 1)
693                 die("Only one of -c/-C/-F can be used.");
694         if (message.len && f > 0)
695                 die("Option -m cannot be combined with -c/-C/-F.");
696         if (edit_message)
697                 use_message = edit_message;
698         if (amend && !use_message)
699                 use_message = "HEAD";
700         if (use_message) {
701                 unsigned char sha1[20];
702                 static char utf8[] = "UTF-8";
703                 const char *out_enc;
704                 char *enc, *end;
705                 struct commit *commit;
707                 if (get_sha1(use_message, sha1))
708                         die("could not lookup commit %s", use_message);
709                 commit = lookup_commit_reference(sha1);
710                 if (!commit || parse_commit(commit))
711                         die("could not parse commit %s", use_message);
713                 enc = strstr(commit->buffer, "\nencoding");
714                 if (enc) {
715                         end = strchr(enc + 10, '\n');
716                         enc = xstrndup(enc + 10, end - (enc + 10));
717                 } else {
718                         enc = utf8;
719                 }
720                 out_enc = git_commit_encoding ? git_commit_encoding : utf8;
722                 if (strcmp(out_enc, enc))
723                         use_message_buffer =
724                                 reencode_string(commit->buffer, out_enc, enc);
726                 /*
727                  * If we failed to reencode the buffer, just copy it
728                  * byte for byte so the user can try to fix it up.
729                  * This also handles the case where input and output
730                  * encodings are identical.
731                  */
732                 if (use_message_buffer == NULL)
733                         use_message_buffer = xstrdup(commit->buffer);
734                 if (enc != utf8)
735                         free(enc);
736         }
738         if (!!also + !!only + !!all + !!interactive > 1)
739                 die("Only one of --include/--only/--all/--interactive can be used.");
740         if (argc == 0 && (also || (only && !amend)))
741                 die("No paths with --include/--only does not make sense.");
742         if (argc == 0 && only && amend)
743                 only_include_assumed = "Clever... amending the last one with dirty index.";
744         if (argc > 0 && !also && !only) {
745                 only_include_assumed = "Explicit paths specified without -i nor -o; assuming --only paths...";
746                 also = 0;
747         }
748         if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
749                 cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
750         else if (!strcmp(cleanup_arg, "verbatim"))
751                 cleanup_mode = CLEANUP_NONE;
752         else if (!strcmp(cleanup_arg, "whitespace"))
753                 cleanup_mode = CLEANUP_SPACE;
754         else if (!strcmp(cleanup_arg, "strip"))
755                 cleanup_mode = CLEANUP_ALL;
756         else
757                 die("Invalid cleanup mode %s", cleanup_arg);
759         if (all && argc > 0)
760                 die("Paths with -a does not make sense.");
761         else if (interactive && argc > 0)
762                 die("Paths with --interactive does not make sense.");
764         return argc;
767 int cmd_status(int argc, const char **argv, const char *prefix)
769         const char *index_file;
770         int commitable;
772         git_config(git_status_config);
774         argc = parse_and_validate_options(argc, argv, builtin_status_usage);
776         index_file = prepare_index(argc, argv, prefix);
778         commitable = run_status(stdout, index_file, prefix, 0);
780         rollback_index_files();
782         return commitable ? 0 : 1;
785 static void print_summary(const char *prefix, const unsigned char *sha1)
787         struct rev_info rev;
788         struct commit *commit;
790         commit = lookup_commit(sha1);
791         if (!commit)
792                 die("couldn't look up newly created commit");
793         if (!commit || parse_commit(commit))
794                 die("could not parse newly created commit");
796         init_revisions(&rev, prefix);
797         setup_revisions(0, NULL, &rev, NULL);
799         rev.abbrev = 0;
800         rev.diff = 1;
801         rev.diffopt.output_format =
802                 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
804         rev.verbose_header = 1;
805         rev.show_root_diff = 1;
806         rev.commit_format = get_commit_format("format:%h: %s");
807         rev.always_show_header = 0;
808         rev.diffopt.detect_rename = 1;
809         rev.diffopt.rename_limit = 100;
810         rev.diffopt.break_opt = 0;
811         diff_setup_done(&rev.diffopt);
813         printf("Created %scommit ", initial_commit ? "initial " : "");
815         if (!log_tree_commit(&rev, commit)) {
816                 struct strbuf buf = STRBUF_INIT;
817                 format_commit_message(commit, "%h: %s", &buf);
818                 printf("%s\n", buf.buf);
819                 strbuf_release(&buf);
820         }
823 int git_commit_config(const char *k, const char *v)
825         if (!strcmp(k, "commit.template")) {
826                 if (!v)
827                         return config_error_nonbool(v);
828                 template_file = xstrdup(v);
829                 return 0;
830         }
832         return git_status_config(k, v);
835 static const char commit_utf8_warn[] =
836 "Warning: commit message does not conform to UTF-8.\n"
837 "You may want to amend it after fixing the message, or set the config\n"
838 "variable i18n.commitencoding to the encoding your project uses.\n";
840 static void add_parent(struct strbuf *sb, const unsigned char *sha1)
842         struct object *obj = parse_object(sha1);
843         const char *parent = sha1_to_hex(sha1);
844         if (!obj)
845                 die("Unable to find commit parent %s", parent);
846         if (obj->type != OBJ_COMMIT)
847                 die("Parent %s isn't a proper commit", parent);
848         strbuf_addf(sb, "parent %s\n", parent);
851 int cmd_commit(int argc, const char **argv, const char *prefix)
853         int header_len;
854         struct strbuf sb;
855         const char *index_file, *reflog_msg;
856         char *nl, *p;
857         unsigned char commit_sha1[20];
858         struct ref_lock *ref_lock;
860         git_config(git_commit_config);
862         argc = parse_and_validate_options(argc, argv, builtin_commit_usage);
864         index_file = prepare_index(argc, argv, prefix);
866         /* Set up everything for writing the commit object.  This includes
867            running hooks, writing the trees, and interacting with the user.  */
868         if (!prepare_to_commit(index_file, prefix)) {
869                 rollback_index_files();
870                 return 1;
871         }
873         /*
874          * The commit object
875          */
876         strbuf_init(&sb, 0);
877         strbuf_addf(&sb, "tree %s\n",
878                     sha1_to_hex(active_cache_tree->sha1));
880         /* Determine parents */
881         if (initial_commit) {
882                 reflog_msg = "commit (initial)";
883         } else if (amend) {
884                 struct commit_list *c;
885                 struct commit *commit;
887                 reflog_msg = "commit (amend)";
888                 commit = lookup_commit(head_sha1);
889                 if (!commit || parse_commit(commit))
890                         die("could not parse HEAD commit");
892                 for (c = commit->parents; c; c = c->next)
893                         add_parent(&sb, c->item->object.sha1);
894         } else if (in_merge) {
895                 struct strbuf m;
896                 FILE *fp;
898                 reflog_msg = "commit (merge)";
899                 add_parent(&sb, head_sha1);
900                 strbuf_init(&m, 0);
901                 fp = fopen(git_path("MERGE_HEAD"), "r");
902                 if (fp == NULL)
903                         die("could not open %s for reading: %s",
904                             git_path("MERGE_HEAD"), strerror(errno));
905                 while (strbuf_getline(&m, fp, '\n') != EOF) {
906                         unsigned char sha1[20];
907                         if (get_sha1_hex(m.buf, sha1) < 0)
908                                 die("Corrupt MERGE_HEAD file (%s)", m.buf);
909                         add_parent(&sb, sha1);
910                 }
911                 fclose(fp);
912                 strbuf_release(&m);
913         } else {
914                 reflog_msg = "commit";
915                 strbuf_addf(&sb, "parent %s\n", sha1_to_hex(head_sha1));
916         }
918         determine_author_info(&sb);
919         strbuf_addf(&sb, "committer %s\n", git_committer_info(IDENT_ERROR_ON_NO_NAME));
920         if (!is_encoding_utf8(git_commit_encoding))
921                 strbuf_addf(&sb, "encoding %s\n", git_commit_encoding);
922         strbuf_addch(&sb, '\n');
924         /* Finally, get the commit message */
925         header_len = sb.len;
926         if (strbuf_read_file(&sb, git_path(commit_editmsg), 0) < 0) {
927                 rollback_index_files();
928                 die("could not read commit message");
929         }
931         /* Truncate the message just before the diff, if any. */
932         p = strstr(sb.buf, "\ndiff --git a/");
933         if (p != NULL)
934                 strbuf_setlen(&sb, p - sb.buf + 1);
936         if (cleanup_mode != CLEANUP_NONE)
937                 stripspace(&sb, cleanup_mode == CLEANUP_ALL);
938         if (sb.len < header_len || message_is_empty(&sb, header_len)) {
939                 rollback_index_files();
940                 die("no commit message?  aborting commit.");
941         }
942         strbuf_addch(&sb, '\0');
943         if (is_encoding_utf8(git_commit_encoding) && !is_utf8(sb.buf))
944                 fprintf(stderr, commit_utf8_warn);
946         if (write_sha1_file(sb.buf, sb.len - 1, commit_type, commit_sha1)) {
947                 rollback_index_files();
948                 die("failed to write commit object");
949         }
951         ref_lock = lock_any_ref_for_update("HEAD",
952                                            initial_commit ? NULL : head_sha1,
953                                            0);
955         nl = strchr(sb.buf + header_len, '\n');
956         if (nl)
957                 strbuf_setlen(&sb, nl + 1 - sb.buf);
958         else
959                 strbuf_addch(&sb, '\n');
960         strbuf_remove(&sb, 0, header_len);
961         strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
962         strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
964         if (!ref_lock) {
965                 rollback_index_files();
966                 die("cannot lock HEAD ref");
967         }
968         if (write_ref_sha1(ref_lock, commit_sha1, sb.buf) < 0) {
969                 rollback_index_files();
970                 die("cannot update HEAD ref");
971         }
973         unlink(git_path("MERGE_HEAD"));
974         unlink(git_path("MERGE_MSG"));
975         unlink(git_path("SQUASH_MSG"));
977         if (commit_index_files())
978                 die ("Repository has been updated, but unable to write\n"
979                      "new_index file. Check that disk is not full or quota is\n"
980                      "not exceeded, and then \"git reset HEAD\" to recover.");
982         rerere();
983         run_hook(get_index_file(), "post-commit", NULL);
984         if (!quiet)
985                 print_summary(prefix, commit_sha1);
987         return 0;