Code

tag.h: Remove unused signature field
[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 "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
31 };
33 static const char * const builtin_status_usage[] = {
34         "git status [options] [--] <filepattern>...",
35         NULL
36 };
38 static unsigned char head_sha1[20], merge_head_sha1[20];
39 static char *use_message_buffer;
40 static const char commit_editmsg[] = "COMMIT_EDITMSG";
41 static struct lock_file index_lock; /* real index */
42 static struct lock_file false_lock; /* used only for partial commits */
43 static enum {
44         COMMIT_AS_IS = 1,
45         COMMIT_NORMAL,
46         COMMIT_PARTIAL,
47 } commit_style;
49 static const char *logfile, *force_author;
50 static const char *template_file;
51 static char *edit_message, *use_message;
52 static char *author_name, *author_email, *author_date;
53 static int all, edit_flag, also, interactive, only, amend, signoff;
54 static int quiet, verbose, no_verify, allow_empty, dry_run, renew_authorship;
55 static char *untracked_files_arg;
56 /*
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.
62  */
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)
75 {
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");
82         }
83         return 0;
84 }
86 static struct option builtin_commit_options[] = {
87         OPT__QUIET(&quiet),
88         OPT__VERBOSE(&verbose),
90         OPT_GROUP("Commit message options"),
91         OPT_FILENAME('F', "file", &logfile, "read log from file"),
92         OPT_STRING(0, "author", &force_author, "AUTHOR", "override author for commit"),
93         OPT_CALLBACK('m', "message", &message, "MESSAGE", "specify commit message", opt_parse_m),
94         OPT_STRING('c', "reedit-message", &edit_message, "COMMIT", "reuse and edit message from specified commit"),
95         OPT_STRING('C', "reuse-message", &use_message, "COMMIT", "reuse message from specified commit"),
96         OPT_BOOLEAN(0, "reset-author", &renew_authorship, "the commit is authored by me now (used with -C-c/--amend)"),
97         OPT_BOOLEAN('s', "signoff", &signoff, "add Signed-off-by:"),
98         OPT_FILENAME('t', "template", &template_file, "use specified template file"),
99         OPT_BOOLEAN('e', "edit", &edit_flag, "force edit of commit"),
100         OPT_STRING(0, "cleanup", &cleanup_arg, "default", "how to strip spaces and #comments from message"),
101         /* end commit message options */
103         OPT_GROUP("Commit contents options"),
104         OPT_BOOLEAN('a', "all", &all, "commit all changed files"),
105         OPT_BOOLEAN('i', "include", &also, "add specified files to index for commit"),
106         OPT_BOOLEAN(0, "interactive", &interactive, "interactively add files"),
107         OPT_BOOLEAN('o', "only", &only, "commit only specified files"),
108         OPT_BOOLEAN('n', "no-verify", &no_verify, "bypass pre-commit hook"),
109         OPT_BOOLEAN(0, "dry-run", &dry_run, "show what would be committed"),
110         OPT_BOOLEAN(0, "amend", &amend, "amend previous commit"),
111         { 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" },
112         OPT_BOOLEAN(0, "allow-empty", &allow_empty, "ok to record an empty change"),
113         /* end commit contents options */
115         OPT_END()
116 };
118 static void rollback_index_files(void)
120         switch (commit_style) {
121         case COMMIT_AS_IS:
122                 break; /* nothing to do */
123         case COMMIT_NORMAL:
124                 rollback_lock_file(&index_lock);
125                 break;
126         case COMMIT_PARTIAL:
127                 rollback_lock_file(&index_lock);
128                 rollback_lock_file(&false_lock);
129                 break;
130         }
133 static int commit_index_files(void)
135         int err = 0;
137         switch (commit_style) {
138         case COMMIT_AS_IS:
139                 break; /* nothing to do */
140         case COMMIT_NORMAL:
141                 err = commit_lock_file(&index_lock);
142                 break;
143         case COMMIT_PARTIAL:
144                 err = commit_lock_file(&index_lock);
145                 rollback_lock_file(&false_lock);
146                 break;
147         }
149         return err;
152 /*
153  * Take a union of paths in the index and the named tree (typically, "HEAD"),
154  * and return the paths that match the given pattern in list.
155  */
156 static int list_paths(struct string_list *list, const char *with_tree,
157                       const char *prefix, const char **pattern)
159         int i;
160         char *m;
162         for (i = 0; pattern[i]; i++)
163                 ;
164         m = xcalloc(1, i);
166         if (with_tree)
167                 overlay_tree_on_cache(with_tree, prefix);
169         for (i = 0; i < active_nr; i++) {
170                 struct cache_entry *ce = active_cache[i];
171                 if (ce->ce_flags & CE_UPDATE)
172                         continue;
173                 if (!match_pathspec(pattern, ce->name, ce_namelen(ce), 0, m))
174                         continue;
175                 string_list_insert(ce->name, list);
176         }
178         return report_path_error(m, pattern, prefix ? strlen(prefix) : 0);
181 static void add_remove_files(struct string_list *list)
183         int i;
184         for (i = 0; i < list->nr; i++) {
185                 struct stat st;
186                 struct string_list_item *p = &(list->items[i]);
188                 if (!lstat(p->string, &st)) {
189                         if (add_to_cache(p->string, &st, 0))
190                                 die("updating files failed");
191                 } else
192                         remove_file_from_cache(p->string);
193         }
196 static void create_base_index(void)
198         struct tree *tree;
199         struct unpack_trees_options opts;
200         struct tree_desc t;
202         if (initial_commit) {
203                 discard_cache();
204                 return;
205         }
207         memset(&opts, 0, sizeof(opts));
208         opts.head_idx = 1;
209         opts.index_only = 1;
210         opts.merge = 1;
211         opts.src_index = &the_index;
212         opts.dst_index = &the_index;
214         opts.fn = oneway_merge;
215         tree = parse_tree_indirect(head_sha1);
216         if (!tree)
217                 die("failed to unpack HEAD tree object");
218         parse_tree(tree);
219         init_tree_desc(&t, tree->buffer, tree->size);
220         if (unpack_trees(1, &t, &opts))
221                 exit(128); /* We've already reported the error, finish dying */
224 static char *prepare_index(int argc, const char **argv, const char *prefix, int is_status)
226         int fd;
227         struct string_list partial;
228         const char **pathspec = NULL;
229         int refresh_flags = REFRESH_QUIET;
231         if (is_status)
232                 refresh_flags |= REFRESH_UNMERGED;
233         if (interactive) {
234                 if (interactive_add(argc, argv, prefix) != 0)
235                         die("interactive add failed");
236                 if (read_cache_preload(NULL) < 0)
237                         die("index file corrupt");
238                 commit_style = COMMIT_AS_IS;
239                 return get_index_file();
240         }
242         if (*argv)
243                 pathspec = get_pathspec(prefix, argv);
245         if (read_cache_preload(pathspec) < 0)
246                 die("index file corrupt");
248         /*
249          * Non partial, non as-is commit.
250          *
251          * (1) get the real index;
252          * (2) update the_index as necessary;
253          * (3) write the_index out to the real index (still locked);
254          * (4) return the name of the locked index file.
255          *
256          * The caller should run hooks on the locked real index, and
257          * (A) if all goes well, commit the real index;
258          * (B) on failure, rollback the real index.
259          */
260         if (all || (also && pathspec && *pathspec)) {
261                 int fd = hold_locked_index(&index_lock, 1);
262                 add_files_to_cache(also ? prefix : NULL, pathspec, 0);
263                 refresh_cache(refresh_flags);
264                 if (write_cache(fd, active_cache, active_nr) ||
265                     close_lock_file(&index_lock))
266                         die("unable to write new_index file");
267                 commit_style = COMMIT_NORMAL;
268                 return index_lock.filename;
269         }
271         /*
272          * As-is commit.
273          *
274          * (1) return the name of the real index file.
275          *
276          * The caller should run hooks on the real index, and run
277          * hooks on the real index, and create commit from the_index.
278          * We still need to refresh the index here.
279          */
280         if (!pathspec || !*pathspec) {
281                 fd = hold_locked_index(&index_lock, !is_status);
282                 refresh_cache(refresh_flags);
283                 if (0 <= fd) {
284                         if (write_cache(fd, active_cache, active_nr) ||
285                             commit_locked_index(&index_lock))
286                                 die("unable to write new_index file");
287                 }
288                 commit_style = COMMIT_AS_IS;
289                 return get_index_file();
290         }
292         /*
293          * A partial commit.
294          *
295          * (0) find the set of affected paths;
296          * (1) get lock on the real index file;
297          * (2) update the_index with the given paths;
298          * (3) write the_index out to the real index (still locked);
299          * (4) get lock on the false index file;
300          * (5) reset the_index from HEAD;
301          * (6) update the_index the same way as (2);
302          * (7) write the_index out to the false index file;
303          * (8) return the name of the false index file (still locked);
304          *
305          * The caller should run hooks on the locked false index, and
306          * create commit from it.  Then
307          * (A) if all goes well, commit the real index;
308          * (B) on failure, rollback the real index;
309          * In either case, rollback the false index.
310          */
311         commit_style = COMMIT_PARTIAL;
313         if (file_exists(git_path("MERGE_HEAD")))
314                 die("cannot do a partial commit during a merge.");
316         memset(&partial, 0, sizeof(partial));
317         partial.strdup_strings = 1;
318         if (list_paths(&partial, initial_commit ? NULL : "HEAD", prefix, pathspec))
319                 exit(1);
321         discard_cache();
322         if (read_cache() < 0)
323                 die("cannot read the index");
325         fd = hold_locked_index(&index_lock, 1);
326         add_remove_files(&partial);
327         refresh_cache(REFRESH_QUIET);
328         if (write_cache(fd, active_cache, active_nr) ||
329             close_lock_file(&index_lock))
330                 die("unable to write new_index file");
332         fd = hold_lock_file_for_update(&false_lock,
333                                        git_path("next-index-%"PRIuMAX,
334                                                 (uintmax_t) getpid()),
335                                        LOCK_DIE_ON_ERROR);
337         create_base_index();
338         add_remove_files(&partial);
339         refresh_cache(REFRESH_QUIET);
341         if (write_cache(fd, active_cache, active_nr) ||
342             close_lock_file(&false_lock))
343                 die("unable to write temporary index file");
345         discard_cache();
346         read_cache_from(false_lock.filename);
348         return false_lock.filename;
351 static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn,
352                       struct wt_status *s)
354         if (s->relative_paths)
355                 s->prefix = prefix;
357         if (amend) {
358                 s->amend = 1;
359                 s->reference = "HEAD^1";
360         }
361         s->verbose = verbose;
362         s->index_file = index_file;
363         s->fp = fp;
364         s->nowarn = nowarn;
366         wt_status_print(s);
368         return s->commitable;
371 static int is_a_merge(const unsigned char *sha1)
373         struct commit *commit = lookup_commit(sha1);
374         if (!commit || parse_commit(commit))
375                 die("could not parse HEAD commit");
376         return !!(commit->parents && commit->parents->next);
379 static const char sign_off_header[] = "Signed-off-by: ";
381 static void determine_author_info(void)
383         char *name, *email, *date;
385         name = getenv("GIT_AUTHOR_NAME");
386         email = getenv("GIT_AUTHOR_EMAIL");
387         date = getenv("GIT_AUTHOR_DATE");
389         if (use_message && !renew_authorship) {
390                 const char *a, *lb, *rb, *eol;
392                 a = strstr(use_message_buffer, "\nauthor ");
393                 if (!a)
394                         die("invalid commit: %s", use_message);
396                 lb = strstr(a + 8, " <");
397                 rb = strstr(a + 8, "> ");
398                 eol = strchr(a + 8, '\n');
399                 if (!lb || !rb || !eol)
400                         die("invalid commit: %s", use_message);
402                 name = xstrndup(a + 8, lb - (a + 8));
403                 email = xstrndup(lb + 2, rb - (lb + 2));
404                 date = xstrndup(rb + 2, eol - (rb + 2));
405         }
407         if (force_author) {
408                 const char *lb = strstr(force_author, " <");
409                 const char *rb = strchr(force_author, '>');
411                 if (!lb || !rb)
412                         die("malformed --author parameter");
413                 name = xstrndup(force_author, lb - force_author);
414                 email = xstrndup(lb + 2, rb - (lb + 2));
415         }
417         author_name = name;
418         author_email = email;
419         author_date = date;
422 static int ends_rfc2822_footer(struct strbuf *sb)
424         int ch;
425         int hit = 0;
426         int i, j, k;
427         int len = sb->len;
428         int first = 1;
429         const char *buf = sb->buf;
431         for (i = len - 1; i > 0; i--) {
432                 if (hit && buf[i] == '\n')
433                         break;
434                 hit = (buf[i] == '\n');
435         }
437         while (i < len - 1 && buf[i] == '\n')
438                 i++;
440         for (; i < len; i = k) {
441                 for (k = i; k < len && buf[k] != '\n'; k++)
442                         ; /* do nothing */
443                 k++;
445                 if ((buf[k] == ' ' || buf[k] == '\t') && !first)
446                         continue;
448                 first = 0;
450                 for (j = 0; i + j < len; j++) {
451                         ch = buf[i + j];
452                         if (ch == ':')
453                                 break;
454                         if (isalnum(ch) ||
455                             (ch == '-'))
456                                 continue;
457                         return 0;
458                 }
459         }
460         return 1;
463 static int prepare_to_commit(const char *index_file, const char *prefix,
464                              struct wt_status *s)
466         struct stat statbuf;
467         int commitable, saved_color_setting;
468         struct strbuf sb = STRBUF_INIT;
469         char *buffer;
470         FILE *fp;
471         const char *hook_arg1 = NULL;
472         const char *hook_arg2 = NULL;
473         int ident_shown = 0;
475         if (!no_verify && run_hook(index_file, "pre-commit", NULL))
476                 return 0;
478         if (message.len) {
479                 strbuf_addbuf(&sb, &message);
480                 hook_arg1 = "message";
481         } else if (logfile && !strcmp(logfile, "-")) {
482                 if (isatty(0))
483                         fprintf(stderr, "(reading log message from standard input)\n");
484                 if (strbuf_read(&sb, 0, 0) < 0)
485                         die_errno("could not read log from standard input");
486                 hook_arg1 = "message";
487         } else if (logfile) {
488                 if (strbuf_read_file(&sb, logfile, 0) < 0)
489                         die_errno("could not read log file '%s'",
490                                   logfile);
491                 hook_arg1 = "message";
492         } else if (use_message) {
493                 buffer = strstr(use_message_buffer, "\n\n");
494                 if (!buffer || buffer[2] == '\0')
495                         die("commit has empty message");
496                 strbuf_add(&sb, buffer + 2, strlen(buffer + 2));
497                 hook_arg1 = "commit";
498                 hook_arg2 = use_message;
499         } else if (!stat(git_path("MERGE_MSG"), &statbuf)) {
500                 if (strbuf_read_file(&sb, git_path("MERGE_MSG"), 0) < 0)
501                         die_errno("could not read MERGE_MSG");
502                 hook_arg1 = "merge";
503         } else if (!stat(git_path("SQUASH_MSG"), &statbuf)) {
504                 if (strbuf_read_file(&sb, git_path("SQUASH_MSG"), 0) < 0)
505                         die_errno("could not read SQUASH_MSG");
506                 hook_arg1 = "squash";
507         } else if (template_file && !stat(template_file, &statbuf)) {
508                 if (strbuf_read_file(&sb, template_file, 0) < 0)
509                         die_errno("could not read '%s'", template_file);
510                 hook_arg1 = "template";
511         }
513         /*
514          * This final case does not modify the template message,
515          * it just sets the argument to the prepare-commit-msg hook.
516          */
517         else if (in_merge)
518                 hook_arg1 = "merge";
520         fp = fopen(git_path(commit_editmsg), "w");
521         if (fp == NULL)
522                 die_errno("could not open '%s'", git_path(commit_editmsg));
524         if (cleanup_mode != CLEANUP_NONE)
525                 stripspace(&sb, 0);
527         if (signoff) {
528                 struct strbuf sob = STRBUF_INIT;
529                 int i;
531                 strbuf_addstr(&sob, sign_off_header);
532                 strbuf_addstr(&sob, fmt_name(getenv("GIT_COMMITTER_NAME"),
533                                              getenv("GIT_COMMITTER_EMAIL")));
534                 strbuf_addch(&sob, '\n');
535                 for (i = sb.len - 1; i > 0 && sb.buf[i - 1] != '\n'; i--)
536                         ; /* do nothing */
537                 if (prefixcmp(sb.buf + i, sob.buf)) {
538                         if (!i || !ends_rfc2822_footer(&sb))
539                                 strbuf_addch(&sb, '\n');
540                         strbuf_addbuf(&sb, &sob);
541                 }
542                 strbuf_release(&sob);
543         }
545         if (fwrite(sb.buf, 1, sb.len, fp) < sb.len)
546                 die_errno("could not write commit template");
548         strbuf_release(&sb);
550         determine_author_info();
552         /* This checks if committer ident is explicitly given */
553         git_committer_info(0);
554         if (use_editor) {
555                 char *author_ident;
556                 const char *committer_ident;
558                 if (in_merge)
559                         fprintf(fp,
560                                 "#\n"
561                                 "# It looks like you may be committing a MERGE.\n"
562                                 "# If this is not correct, please remove the file\n"
563                                 "#      %s\n"
564                                 "# and try again.\n"
565                                 "#\n",
566                                 git_path("MERGE_HEAD"));
568                 fprintf(fp,
569                         "\n"
570                         "# Please enter the commit message for your changes.");
571                 if (cleanup_mode == CLEANUP_ALL)
572                         fprintf(fp,
573                                 " Lines starting\n"
574                                 "# with '#' will be ignored, and an empty"
575                                 " message aborts the commit.\n");
576                 else /* CLEANUP_SPACE, that is. */
577                         fprintf(fp,
578                                 " Lines starting\n"
579                                 "# with '#' will be kept; you may remove them"
580                                 " yourself if you want to.\n"
581                                 "# An empty message aborts the commit.\n");
582                 if (only_include_assumed)
583                         fprintf(fp, "# %s\n", only_include_assumed);
585                 author_ident = xstrdup(fmt_name(author_name, author_email));
586                 committer_ident = fmt_name(getenv("GIT_COMMITTER_NAME"),
587                                            getenv("GIT_COMMITTER_EMAIL"));
588                 if (strcmp(author_ident, committer_ident))
589                         fprintf(fp,
590                                 "%s"
591                                 "# Author:    %s\n",
592                                 ident_shown++ ? "" : "#\n",
593                                 author_ident);
594                 free(author_ident);
596                 if (!user_ident_explicitly_given)
597                         fprintf(fp,
598                                 "%s"
599                                 "# Committer: %s\n",
600                                 ident_shown++ ? "" : "#\n",
601                                 committer_ident);
603                 if (ident_shown)
604                         fprintf(fp, "#\n");
606                 saved_color_setting = s->use_color;
607                 s->use_color = 0;
608                 commitable = run_status(fp, index_file, prefix, 1, s);
609                 s->use_color = saved_color_setting;
610         } else {
611                 unsigned char sha1[20];
612                 const char *parent = "HEAD";
614                 if (!active_nr && read_cache() < 0)
615                         die("Cannot read index");
617                 if (amend)
618                         parent = "HEAD^1";
620                 if (get_sha1(parent, sha1))
621                         commitable = !!active_nr;
622                 else
623                         commitable = index_differs_from(parent, 0);
624         }
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, s);
631                 return 0;
632         }
634         /*
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.
638          */
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");
646                 return 0;
647         }
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);
661                 }
662         }
664         if (!no_verify &&
665             run_hook(index_file, "commit-msg", git_path(commit_editmsg), NULL)) {
666                 return 0;
667         }
669         return 1;
672 /*
673  * Find out if the message in the strbuf contains only whitespace and
674  * Signed-off-by lines.
675  */
676 static int message_is_empty(struct strbuf *sb)
678         struct strbuf tmpl = STRBUF_INIT;
679         const char *nl;
680         int eol, i, start = 0;
682         if (cleanup_mode == CLEANUP_NONE && sb->len)
683                 return 0;
685         /* See if the template is just a prefix of the message. */
686         if (template_file && strbuf_read_file(&tmpl, template_file, 0) > 0) {
687                 stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
688                 if (start + tmpl.len <= sb->len &&
689                     memcmp(tmpl.buf, sb->buf + start, tmpl.len) == 0)
690                         start += tmpl.len;
691         }
692         strbuf_release(&tmpl);
694         /* Check if the rest is just whitespace and Signed-of-by's. */
695         for (i = start; i < sb->len; i++) {
696                 nl = memchr(sb->buf + i, '\n', sb->len - i);
697                 if (nl)
698                         eol = nl - sb->buf;
699                 else
700                         eol = sb->len;
702                 if (strlen(sign_off_header) <= eol - i &&
703                     !prefixcmp(sb->buf + i, sign_off_header)) {
704                         i = eol;
705                         continue;
706                 }
707                 while (i < eol)
708                         if (!isspace(sb->buf[i++]))
709                                 return 0;
710         }
712         return 1;
715 static const char *find_author_by_nickname(const char *name)
717         struct rev_info revs;
718         struct commit *commit;
719         struct strbuf buf = STRBUF_INIT;
720         const char *av[20];
721         int ac = 0;
723         init_revisions(&revs, NULL);
724         strbuf_addf(&buf, "--author=%s", name);
725         av[++ac] = "--all";
726         av[++ac] = "-i";
727         av[++ac] = buf.buf;
728         av[++ac] = NULL;
729         setup_revisions(ac, av, &revs, NULL);
730         prepare_revision_walk(&revs);
731         commit = get_revision(&revs);
732         if (commit) {
733                 struct pretty_print_context ctx = {0};
734                 ctx.date_mode = DATE_NORMAL;
735                 strbuf_release(&buf);
736                 format_commit_message(commit, "%an <%ae>", &buf, &ctx);
737                 return strbuf_detach(&buf, NULL);
738         }
739         die("No existing author found with '%s'", name);
742 static int parse_and_validate_options(int argc, const char *argv[],
743                                       const char * const usage[],
744                                       const char *prefix,
745                                       struct wt_status *s)
747         int f = 0;
749         argc = parse_options(argc, argv, prefix, builtin_commit_options, usage,
750                              0);
752         if (force_author && !strchr(force_author, '>'))
753                 force_author = find_author_by_nickname(force_author);
755         if (force_author && renew_authorship)
756                 die("Using both --reset-author and --author does not make sense");
758         if (logfile || message.len || use_message)
759                 use_editor = 0;
760         if (edit_flag)
761                 use_editor = 1;
762         if (!use_editor)
763                 setenv("GIT_EDITOR", ":", 1);
765         if (get_sha1("HEAD", head_sha1))
766                 initial_commit = 1;
768         if (!get_sha1("MERGE_HEAD", merge_head_sha1))
769                 in_merge = 1;
771         /* Sanity check options */
772         if (amend && initial_commit)
773                 die("You have nothing to amend.");
774         if (amend && in_merge)
775                 die("You are in the middle of a merge -- cannot amend.");
777         if (use_message)
778                 f++;
779         if (edit_message)
780                 f++;
781         if (logfile)
782                 f++;
783         if (f > 1)
784                 die("Only one of -c/-C/-F can be used.");
785         if (message.len && f > 0)
786                 die("Option -m cannot be combined with -c/-C/-F.");
787         if (edit_message)
788                 use_message = edit_message;
789         if (amend && !use_message)
790                 use_message = "HEAD";
791         if (!use_message && renew_authorship)
792                 die("--reset-author can be used only with -C, -c or --amend.");
793         if (use_message) {
794                 unsigned char sha1[20];
795                 static char utf8[] = "UTF-8";
796                 const char *out_enc;
797                 char *enc, *end;
798                 struct commit *commit;
800                 if (get_sha1(use_message, sha1))
801                         die("could not lookup commit %s", use_message);
802                 commit = lookup_commit_reference(sha1);
803                 if (!commit || parse_commit(commit))
804                         die("could not parse commit %s", use_message);
806                 enc = strstr(commit->buffer, "\nencoding");
807                 if (enc) {
808                         end = strchr(enc + 10, '\n');
809                         enc = xstrndup(enc + 10, end - (enc + 10));
810                 } else {
811                         enc = utf8;
812                 }
813                 out_enc = git_commit_encoding ? git_commit_encoding : utf8;
815                 if (strcmp(out_enc, enc))
816                         use_message_buffer =
817                                 reencode_string(commit->buffer, out_enc, enc);
819                 /*
820                  * If we failed to reencode the buffer, just copy it
821                  * byte for byte so the user can try to fix it up.
822                  * This also handles the case where input and output
823                  * encodings are identical.
824                  */
825                 if (use_message_buffer == NULL)
826                         use_message_buffer = xstrdup(commit->buffer);
827                 if (enc != utf8)
828                         free(enc);
829         }
831         if (!!also + !!only + !!all + !!interactive > 1)
832                 die("Only one of --include/--only/--all/--interactive can be used.");
833         if (argc == 0 && (also || (only && !amend)))
834                 die("No paths with --include/--only does not make sense.");
835         if (argc == 0 && only && amend)
836                 only_include_assumed = "Clever... amending the last one with dirty index.";
837         if (argc > 0 && !also && !only)
838                 only_include_assumed = "Explicit paths specified without -i nor -o; assuming --only paths...";
839         if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
840                 cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
841         else if (!strcmp(cleanup_arg, "verbatim"))
842                 cleanup_mode = CLEANUP_NONE;
843         else if (!strcmp(cleanup_arg, "whitespace"))
844                 cleanup_mode = CLEANUP_SPACE;
845         else if (!strcmp(cleanup_arg, "strip"))
846                 cleanup_mode = CLEANUP_ALL;
847         else
848                 die("Invalid cleanup mode %s", cleanup_arg);
850         if (!untracked_files_arg)
851                 ; /* default already initialized */
852         else if (!strcmp(untracked_files_arg, "no"))
853                 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
854         else if (!strcmp(untracked_files_arg, "normal"))
855                 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
856         else if (!strcmp(untracked_files_arg, "all"))
857                 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
858         else
859                 die("Invalid untracked files mode '%s'", untracked_files_arg);
861         if (all && argc > 0)
862                 die("Paths with -a does not make sense.");
863         else if (interactive && argc > 0)
864                 die("Paths with --interactive does not make sense.");
866         return argc;
869 static int dry_run_commit(int argc, const char **argv, const char *prefix,
870                           struct wt_status *s)
872         int commitable;
873         const char *index_file;
875         index_file = prepare_index(argc, argv, prefix, 1);
876         commitable = run_status(stdout, index_file, prefix, 0, s);
877         rollback_index_files();
879         return commitable ? 0 : 1;
882 static int parse_status_slot(const char *var, int offset)
884         if (!strcasecmp(var+offset, "header"))
885                 return WT_STATUS_HEADER;
886         if (!strcasecmp(var+offset, "updated")
887                 || !strcasecmp(var+offset, "added"))
888                 return WT_STATUS_UPDATED;
889         if (!strcasecmp(var+offset, "changed"))
890                 return WT_STATUS_CHANGED;
891         if (!strcasecmp(var+offset, "untracked"))
892                 return WT_STATUS_UNTRACKED;
893         if (!strcasecmp(var+offset, "nobranch"))
894                 return WT_STATUS_NOBRANCH;
895         if (!strcasecmp(var+offset, "unmerged"))
896                 return WT_STATUS_UNMERGED;
897         return -1;
900 static int git_status_config(const char *k, const char *v, void *cb)
902         struct wt_status *s = cb;
904         if (!strcmp(k, "status.submodulesummary")) {
905                 int is_bool;
906                 s->submodule_summary = git_config_bool_or_int(k, v, &is_bool);
907                 if (is_bool && s->submodule_summary)
908                         s->submodule_summary = -1;
909                 return 0;
910         }
911         if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
912                 s->use_color = git_config_colorbool(k, v, -1);
913                 return 0;
914         }
915         if (!prefixcmp(k, "status.color.") || !prefixcmp(k, "color.status.")) {
916                 int slot = parse_status_slot(k, 13);
917                 if (slot < 0)
918                         return 0;
919                 if (!v)
920                         return config_error_nonbool(k);
921                 color_parse(v, k, s->color_palette[slot]);
922                 return 0;
923         }
924         if (!strcmp(k, "status.relativepaths")) {
925                 s->relative_paths = git_config_bool(k, v);
926                 return 0;
927         }
928         if (!strcmp(k, "status.showuntrackedfiles")) {
929                 if (!v)
930                         return config_error_nonbool(k);
931                 else if (!strcmp(v, "no"))
932                         s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
933                 else if (!strcmp(v, "normal"))
934                         s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
935                 else if (!strcmp(v, "all"))
936                         s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
937                 else
938                         return error("Invalid untracked files mode '%s'", v);
939                 return 0;
940         }
941         return git_diff_ui_config(k, v, NULL);
944 int cmd_status(int argc, const char **argv, const char *prefix)
946         struct wt_status s;
948         wt_status_prepare(&s);
949         git_config(git_status_config, &s);
950         if (s.use_color == -1)
951                 s.use_color = git_use_color_default;
952         if (diff_use_color_default == -1)
953                 diff_use_color_default = git_use_color_default;
955         argc = parse_and_validate_options(argc, argv, builtin_status_usage,
956                                           prefix, &s);
957         return dry_run_commit(argc, argv, prefix, &s);
960 static void print_summary(const char *prefix, const unsigned char *sha1)
962         struct rev_info rev;
963         struct commit *commit;
964         static const char *format = "format:%h] %s";
965         unsigned char junk_sha1[20];
966         const char *head = resolve_ref("HEAD", junk_sha1, 0, NULL);
968         commit = lookup_commit(sha1);
969         if (!commit)
970                 die("couldn't look up newly created commit");
971         if (!commit || parse_commit(commit))
972                 die("could not parse newly created commit");
974         init_revisions(&rev, prefix);
975         setup_revisions(0, NULL, &rev, NULL);
977         rev.abbrev = 0;
978         rev.diff = 1;
979         rev.diffopt.output_format =
980                 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
982         rev.verbose_header = 1;
983         rev.show_root_diff = 1;
984         get_commit_format(format, &rev);
985         rev.always_show_header = 0;
986         rev.diffopt.detect_rename = 1;
987         rev.diffopt.rename_limit = 100;
988         rev.diffopt.break_opt = 0;
989         diff_setup_done(&rev.diffopt);
991         printf("[%s%s ",
992                 !prefixcmp(head, "refs/heads/") ?
993                         head + 11 :
994                         !strcmp(head, "HEAD") ?
995                                 "detached HEAD" :
996                                 head,
997                 initial_commit ? " (root-commit)" : "");
999         if (!log_tree_commit(&rev, commit)) {
1000                 struct pretty_print_context ctx = {0};
1001                 struct strbuf buf = STRBUF_INIT;
1002                 ctx.date_mode = DATE_NORMAL;
1003                 format_commit_message(commit, format + 7, &buf, &ctx);
1004                 printf("%s\n", buf.buf);
1005                 strbuf_release(&buf);
1006         }
1009 static int git_commit_config(const char *k, const char *v, void *cb)
1011         struct wt_status *s = cb;
1013         if (!strcmp(k, "commit.template"))
1014                 return git_config_pathname(&template_file, k, v);
1016         return git_status_config(k, v, s);
1019 int cmd_commit(int argc, const char **argv, const char *prefix)
1021         struct strbuf sb = STRBUF_INIT;
1022         const char *index_file, *reflog_msg;
1023         char *nl, *p;
1024         unsigned char commit_sha1[20];
1025         struct ref_lock *ref_lock;
1026         struct commit_list *parents = NULL, **pptr = &parents;
1027         struct stat statbuf;
1028         int allow_fast_forward = 1;
1029         struct wt_status s;
1031         wt_status_prepare(&s);
1032         git_config(git_commit_config, &s);
1034         if (s.use_color == -1)
1035                 s.use_color = git_use_color_default;
1037         argc = parse_and_validate_options(argc, argv, builtin_commit_usage,
1038                                           prefix, &s);
1039         if (dry_run) {
1040                 if (diff_use_color_default == -1)
1041                         diff_use_color_default = git_use_color_default;
1042                 return dry_run_commit(argc, argv, prefix, &s);
1043         }
1044         index_file = prepare_index(argc, argv, prefix, 0);
1046         /* Set up everything for writing the commit object.  This includes
1047            running hooks, writing the trees, and interacting with the user.  */
1048         if (!prepare_to_commit(index_file, prefix, &s)) {
1049                 rollback_index_files();
1050                 return 1;
1051         }
1053         /* Determine parents */
1054         if (initial_commit) {
1055                 reflog_msg = "commit (initial)";
1056         } else if (amend) {
1057                 struct commit_list *c;
1058                 struct commit *commit;
1060                 reflog_msg = "commit (amend)";
1061                 commit = lookup_commit(head_sha1);
1062                 if (!commit || parse_commit(commit))
1063                         die("could not parse HEAD commit");
1065                 for (c = commit->parents; c; c = c->next)
1066                         pptr = &commit_list_insert(c->item, pptr)->next;
1067         } else if (in_merge) {
1068                 struct strbuf m = STRBUF_INIT;
1069                 FILE *fp;
1071                 reflog_msg = "commit (merge)";
1072                 pptr = &commit_list_insert(lookup_commit(head_sha1), pptr)->next;
1073                 fp = fopen(git_path("MERGE_HEAD"), "r");
1074                 if (fp == NULL)
1075                         die_errno("could not open '%s' for reading",
1076                                   git_path("MERGE_HEAD"));
1077                 while (strbuf_getline(&m, fp, '\n') != EOF) {
1078                         unsigned char sha1[20];
1079                         if (get_sha1_hex(m.buf, sha1) < 0)
1080                                 die("Corrupt MERGE_HEAD file (%s)", m.buf);
1081                         pptr = &commit_list_insert(lookup_commit(sha1), pptr)->next;
1082                 }
1083                 fclose(fp);
1084                 strbuf_release(&m);
1085                 if (!stat(git_path("MERGE_MODE"), &statbuf)) {
1086                         if (strbuf_read_file(&sb, git_path("MERGE_MODE"), 0) < 0)
1087                                 die_errno("could not read MERGE_MODE");
1088                         if (!strcmp(sb.buf, "no-ff"))
1089                                 allow_fast_forward = 0;
1090                 }
1091                 if (allow_fast_forward)
1092                         parents = reduce_heads(parents);
1093         } else {
1094                 reflog_msg = "commit";
1095                 pptr = &commit_list_insert(lookup_commit(head_sha1), pptr)->next;
1096         }
1098         /* Finally, get the commit message */
1099         strbuf_reset(&sb);
1100         if (strbuf_read_file(&sb, git_path(commit_editmsg), 0) < 0) {
1101                 int saved_errno = errno;
1102                 rollback_index_files();
1103                 die("could not read commit message: %s", strerror(saved_errno));
1104         }
1106         /* Truncate the message just before the diff, if any. */
1107         if (verbose) {
1108                 p = strstr(sb.buf, "\ndiff --git ");
1109                 if (p != NULL)
1110                         strbuf_setlen(&sb, p - sb.buf + 1);
1111         }
1113         if (cleanup_mode != CLEANUP_NONE)
1114                 stripspace(&sb, cleanup_mode == CLEANUP_ALL);
1115         if (message_is_empty(&sb)) {
1116                 rollback_index_files();
1117                 fprintf(stderr, "Aborting commit due to empty commit message.\n");
1118                 exit(1);
1119         }
1121         if (commit_tree(sb.buf, active_cache_tree->sha1, parents, commit_sha1,
1122                         fmt_ident(author_name, author_email, author_date,
1123                                 IDENT_ERROR_ON_NO_NAME))) {
1124                 rollback_index_files();
1125                 die("failed to write commit object");
1126         }
1128         ref_lock = lock_any_ref_for_update("HEAD",
1129                                            initial_commit ? NULL : head_sha1,
1130                                            0);
1132         nl = strchr(sb.buf, '\n');
1133         if (nl)
1134                 strbuf_setlen(&sb, nl + 1 - sb.buf);
1135         else
1136                 strbuf_addch(&sb, '\n');
1137         strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
1138         strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
1140         if (!ref_lock) {
1141                 rollback_index_files();
1142                 die("cannot lock HEAD ref");
1143         }
1144         if (write_ref_sha1(ref_lock, commit_sha1, sb.buf) < 0) {
1145                 rollback_index_files();
1146                 die("cannot update HEAD ref");
1147         }
1149         unlink(git_path("MERGE_HEAD"));
1150         unlink(git_path("MERGE_MSG"));
1151         unlink(git_path("MERGE_MODE"));
1152         unlink(git_path("SQUASH_MSG"));
1154         if (commit_index_files())
1155                 die ("Repository has been updated, but unable to write\n"
1156                      "new_index file. Check that disk is not full or quota is\n"
1157                      "not exceeded, and then \"git reset HEAD\" to recover.");
1159         rerere();
1160         run_hook(get_index_file(), "post-commit", NULL);
1161         if (!quiet)
1162                 print_summary(prefix, commit_sha1);
1164         return 0;