Code

Do not strip empty lines / trailing spaces from a commit message template
[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"
27 #include "quote.h"
28 #include "submodule.h"
30 static const char * const builtin_commit_usage[] = {
31         "git commit [options] [--] <filepattern>...",
32         NULL
33 };
35 static const char * const builtin_status_usage[] = {
36         "git status [options] [--] <filepattern>...",
37         NULL
38 };
40 static const char implicit_ident_advice[] =
41 N_("Your name and email address were configured automatically based\n"
42 "on your username and hostname. Please check that they are accurate.\n"
43 "You can suppress this message by setting them explicitly:\n"
44 "\n"
45 "    git config --global user.name \"Your Name\"\n"
46 "    git config --global user.email you@example.com\n"
47 "\n"
48 "After doing this, you may fix the identity used for this commit with:\n"
49 "\n"
50 "    git commit --amend --reset-author\n");
52 static const char empty_amend_advice[] =
53 N_("You asked to amend the most recent commit, but doing so would make\n"
54 "it empty. You can repeat your command with --allow-empty, or you can\n"
55 "remove the commit entirely with \"git reset HEAD^\".\n");
57 static const char empty_cherry_pick_advice[] =
58 N_("The previous cherry-pick is now empty, possibly due to conflict resolution.\n"
59 "If you wish to commit it anyway, use:\n"
60 "\n"
61 "    git commit --allow-empty\n"
62 "\n"
63 "Otherwise, please use 'git reset'\n");
65 static unsigned char head_sha1[20];
67 static const char *use_message_buffer;
68 static const char commit_editmsg[] = "COMMIT_EDITMSG";
69 static struct lock_file index_lock; /* real index */
70 static struct lock_file false_lock; /* used only for partial commits */
71 static enum {
72         COMMIT_AS_IS = 1,
73         COMMIT_NORMAL,
74         COMMIT_PARTIAL
75 } commit_style;
77 static const char *logfile, *force_author;
78 static const char *template_file;
79 /*
80  * The _message variables are commit names from which to take
81  * the commit message and/or authorship.
82  */
83 static const char *author_message, *author_message_buffer;
84 static char *edit_message, *use_message;
85 static char *fixup_message, *squash_message;
86 static int all, edit_flag, also, interactive, only, amend, signoff;
87 static int quiet, verbose, no_verify, allow_empty, dry_run, renew_authorship;
88 static int no_post_rewrite, allow_empty_message;
89 static char *untracked_files_arg, *force_date, *ignore_submodule_arg;
90 /*
91  * The default commit message cleanup mode will remove the lines
92  * beginning with # (shell comments) and leading and trailing
93  * whitespaces (empty lines or containing only whitespaces)
94  * if editor is used, and only the whitespaces if the message
95  * is specified explicitly.
96  */
97 static enum {
98         CLEANUP_SPACE,
99         CLEANUP_NONE,
100         CLEANUP_ALL
101 } cleanup_mode;
102 static char *cleanup_arg;
104 static enum commit_whence whence;
105 static int use_editor = 1, initial_commit, include_status = 1;
106 static int show_ignored_in_status;
107 static const char *only_include_assumed;
108 static struct strbuf message;
110 static int null_termination;
111 static enum {
112         STATUS_FORMAT_LONG,
113         STATUS_FORMAT_SHORT,
114         STATUS_FORMAT_PORCELAIN
115 } status_format = STATUS_FORMAT_LONG;
116 static int status_show_branch;
118 static int opt_parse_m(const struct option *opt, const char *arg, int unset)
120         struct strbuf *buf = opt->value;
121         if (unset)
122                 strbuf_setlen(buf, 0);
123         else {
124                 strbuf_addstr(buf, arg);
125                 strbuf_addstr(buf, "\n\n");
126         }
127         return 0;
130 static struct option builtin_commit_options[] = {
131         OPT__QUIET(&quiet, "suppress summary after successful commit"),
132         OPT__VERBOSE(&verbose, "show diff in commit message template"),
134         OPT_GROUP("Commit message options"),
135         OPT_FILENAME('F', "file", &logfile, "read message from file"),
136         OPT_STRING(0, "author", &force_author, "author", "override author for commit"),
137         OPT_STRING(0, "date", &force_date, "date", "override date for commit"),
138         OPT_CALLBACK('m', "message", &message, "message", "commit message", opt_parse_m),
139         OPT_STRING('c', "reedit-message", &edit_message, "commit", "reuse and edit message from specified commit"),
140         OPT_STRING('C', "reuse-message", &use_message, "commit", "reuse message from specified commit"),
141         OPT_STRING(0, "fixup", &fixup_message, "commit", "use autosquash formatted message to fixup specified commit"),
142         OPT_STRING(0, "squash", &squash_message, "commit", "use autosquash formatted message to squash specified commit"),
143         OPT_BOOLEAN(0, "reset-author", &renew_authorship, "the commit is authored by me now (used with -C-c/--amend)"),
144         OPT_BOOLEAN('s', "signoff", &signoff, "add Signed-off-by:"),
145         OPT_FILENAME('t', "template", &template_file, "use specified template file"),
146         OPT_BOOLEAN('e', "edit", &edit_flag, "force edit of commit"),
147         OPT_STRING(0, "cleanup", &cleanup_arg, "default", "how to strip spaces and #comments from message"),
148         OPT_BOOLEAN(0, "status", &include_status, "include status in commit message template"),
149         /* end commit message options */
151         OPT_GROUP("Commit contents options"),
152         OPT_BOOLEAN('a', "all", &all, "commit all changed files"),
153         OPT_BOOLEAN('i', "include", &also, "add specified files to index for commit"),
154         OPT_BOOLEAN(0, "interactive", &interactive, "interactively add files"),
155         OPT_BOOLEAN('o', "only", &only, "commit only specified files"),
156         OPT_BOOLEAN('n', "no-verify", &no_verify, "bypass pre-commit hook"),
157         OPT_BOOLEAN(0, "dry-run", &dry_run, "show what would be committed"),
158         OPT_SET_INT(0, "short", &status_format, "show status concisely",
159                     STATUS_FORMAT_SHORT),
160         OPT_BOOLEAN(0, "branch", &status_show_branch, "show branch information"),
161         OPT_SET_INT(0, "porcelain", &status_format,
162                     "machine-readable output", STATUS_FORMAT_PORCELAIN),
163         OPT_BOOLEAN('z', "null", &null_termination,
164                     "terminate entries with NUL"),
165         OPT_BOOLEAN(0, "amend", &amend, "amend previous commit"),
166         OPT_BOOLEAN(0, "no-post-rewrite", &no_post_rewrite, "bypass post-rewrite hook"),
167         { 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" },
168         /* end commit contents options */
170         { OPTION_BOOLEAN, 0, "allow-empty", &allow_empty, NULL,
171           "ok to record an empty change",
172           PARSE_OPT_NOARG | PARSE_OPT_HIDDEN },
173         { OPTION_BOOLEAN, 0, "allow-empty-message", &allow_empty_message, NULL,
174           "ok to record a change with an empty message",
175           PARSE_OPT_NOARG | PARSE_OPT_HIDDEN },
177         OPT_END()
178 };
180 static void determine_whence(struct wt_status *s)
182         if (file_exists(git_path("MERGE_HEAD")))
183                 whence = FROM_MERGE;
184         else if (file_exists(git_path("CHERRY_PICK_HEAD")))
185                 whence = FROM_CHERRY_PICK;
186         else
187                 whence = FROM_COMMIT;
188         if (s)
189                 s->whence = whence;
192 static const char *whence_s(void)
194         char *s = "";
196         switch (whence) {
197         case FROM_COMMIT:
198                 break;
199         case FROM_MERGE:
200                 s = "merge";
201                 break;
202         case FROM_CHERRY_PICK:
203                 s = "cherry-pick";
204                 break;
205         }
207         return s;
210 static void rollback_index_files(void)
212         switch (commit_style) {
213         case COMMIT_AS_IS:
214                 break; /* nothing to do */
215         case COMMIT_NORMAL:
216                 rollback_lock_file(&index_lock);
217                 break;
218         case COMMIT_PARTIAL:
219                 rollback_lock_file(&index_lock);
220                 rollback_lock_file(&false_lock);
221                 break;
222         }
225 static int commit_index_files(void)
227         int err = 0;
229         switch (commit_style) {
230         case COMMIT_AS_IS:
231                 break; /* nothing to do */
232         case COMMIT_NORMAL:
233                 err = commit_lock_file(&index_lock);
234                 break;
235         case COMMIT_PARTIAL:
236                 err = commit_lock_file(&index_lock);
237                 rollback_lock_file(&false_lock);
238                 break;
239         }
241         return err;
244 /*
245  * Take a union of paths in the index and the named tree (typically, "HEAD"),
246  * and return the paths that match the given pattern in list.
247  */
248 static int list_paths(struct string_list *list, const char *with_tree,
249                       const char *prefix, const char **pattern)
251         int i;
252         char *m;
254         for (i = 0; pattern[i]; i++)
255                 ;
256         m = xcalloc(1, i);
258         if (with_tree)
259                 overlay_tree_on_cache(with_tree, prefix);
261         for (i = 0; i < active_nr; i++) {
262                 struct cache_entry *ce = active_cache[i];
263                 struct string_list_item *item;
265                 if (ce->ce_flags & CE_UPDATE)
266                         continue;
267                 if (!match_pathspec(pattern, ce->name, ce_namelen(ce), 0, m))
268                         continue;
269                 item = string_list_insert(list, ce->name);
270                 if (ce_skip_worktree(ce))
271                         item->util = item; /* better a valid pointer than a fake one */
272         }
274         return report_path_error(m, pattern, prefix ? strlen(prefix) : 0);
277 static void add_remove_files(struct string_list *list)
279         int i;
280         for (i = 0; i < list->nr; i++) {
281                 struct stat st;
282                 struct string_list_item *p = &(list->items[i]);
284                 /* p->util is skip-worktree */
285                 if (p->util)
286                         continue;
288                 if (!lstat(p->string, &st)) {
289                         if (add_to_cache(p->string, &st, 0))
290                                 die(_("updating files failed"));
291                 } else
292                         remove_file_from_cache(p->string);
293         }
296 static void create_base_index(void)
298         struct tree *tree;
299         struct unpack_trees_options opts;
300         struct tree_desc t;
302         if (initial_commit) {
303                 discard_cache();
304                 return;
305         }
307         memset(&opts, 0, sizeof(opts));
308         opts.head_idx = 1;
309         opts.index_only = 1;
310         opts.merge = 1;
311         opts.src_index = &the_index;
312         opts.dst_index = &the_index;
314         opts.fn = oneway_merge;
315         tree = parse_tree_indirect(head_sha1);
316         if (!tree)
317                 die(_("failed to unpack HEAD tree object"));
318         parse_tree(tree);
319         init_tree_desc(&t, tree->buffer, tree->size);
320         if (unpack_trees(1, &t, &opts))
321                 exit(128); /* We've already reported the error, finish dying */
324 static void refresh_cache_or_die(int refresh_flags)
326         /*
327          * refresh_flags contains REFRESH_QUIET, so the only errors
328          * are for unmerged entries.
329          */
330         if (refresh_cache(refresh_flags | REFRESH_IN_PORCELAIN))
331                 die_resolve_conflict("commit");
334 static char *prepare_index(int argc, const char **argv, const char *prefix, int is_status)
336         int fd;
337         struct string_list partial;
338         const char **pathspec = NULL;
339         int refresh_flags = REFRESH_QUIET;
341         if (is_status)
342                 refresh_flags |= REFRESH_UNMERGED;
343         if (interactive) {
344                 if (interactive_add(argc, argv, prefix) != 0)
345                         die(_("interactive add failed"));
346                 if (read_cache_preload(NULL) < 0)
347                         die(_("index file corrupt"));
348                 commit_style = COMMIT_AS_IS;
349                 return get_index_file();
350         }
352         if (*argv)
353                 pathspec = get_pathspec(prefix, argv);
355         if (read_cache_preload(pathspec) < 0)
356                 die(_("index file corrupt"));
358         /*
359          * Non partial, non as-is commit.
360          *
361          * (1) get the real index;
362          * (2) update the_index as necessary;
363          * (3) write the_index out to the real index (still locked);
364          * (4) return the name of the locked index file.
365          *
366          * The caller should run hooks on the locked real index, and
367          * (A) if all goes well, commit the real index;
368          * (B) on failure, rollback the real index.
369          */
370         if (all || (also && pathspec && *pathspec)) {
371                 fd = hold_locked_index(&index_lock, 1);
372                 add_files_to_cache(also ? prefix : NULL, pathspec, 0);
373                 refresh_cache_or_die(refresh_flags);
374                 if (write_cache(fd, active_cache, active_nr) ||
375                     close_lock_file(&index_lock))
376                         die(_("unable to write new_index file"));
377                 commit_style = COMMIT_NORMAL;
378                 return index_lock.filename;
379         }
381         /*
382          * As-is commit.
383          *
384          * (1) return the name of the real index file.
385          *
386          * The caller should run hooks on the real index,
387          * and create commit from the_index.
388          * We still need to refresh the index here.
389          */
390         if (!pathspec || !*pathspec) {
391                 fd = hold_locked_index(&index_lock, 1);
392                 refresh_cache_or_die(refresh_flags);
393                 if (active_cache_changed) {
394                         if (write_cache(fd, active_cache, active_nr) ||
395                             commit_locked_index(&index_lock))
396                                 die(_("unable to write new_index file"));
397                 } else {
398                         rollback_lock_file(&index_lock);
399                 }
400                 commit_style = COMMIT_AS_IS;
401                 return get_index_file();
402         }
404         /*
405          * A partial commit.
406          *
407          * (0) find the set of affected paths;
408          * (1) get lock on the real index file;
409          * (2) update the_index with the given paths;
410          * (3) write the_index out to the real index (still locked);
411          * (4) get lock on the false index file;
412          * (5) reset the_index from HEAD;
413          * (6) update the_index the same way as (2);
414          * (7) write the_index out to the false index file;
415          * (8) return the name of the false index file (still locked);
416          *
417          * The caller should run hooks on the locked false index, and
418          * create commit from it.  Then
419          * (A) if all goes well, commit the real index;
420          * (B) on failure, rollback the real index;
421          * In either case, rollback the false index.
422          */
423         commit_style = COMMIT_PARTIAL;
425         if (whence != FROM_COMMIT)
426                 die(_("cannot do a partial commit during a %s."), whence_s());
428         memset(&partial, 0, sizeof(partial));
429         partial.strdup_strings = 1;
430         if (list_paths(&partial, initial_commit ? NULL : "HEAD", prefix, pathspec))
431                 exit(1);
433         discard_cache();
434         if (read_cache() < 0)
435                 die(_("cannot read the index"));
437         fd = hold_locked_index(&index_lock, 1);
438         add_remove_files(&partial);
439         refresh_cache(REFRESH_QUIET);
440         if (write_cache(fd, active_cache, active_nr) ||
441             close_lock_file(&index_lock))
442                 die(_("unable to write new_index file"));
444         fd = hold_lock_file_for_update(&false_lock,
445                                        git_path("next-index-%"PRIuMAX,
446                                                 (uintmax_t) getpid()),
447                                        LOCK_DIE_ON_ERROR);
449         create_base_index();
450         add_remove_files(&partial);
451         refresh_cache(REFRESH_QUIET);
453         if (write_cache(fd, active_cache, active_nr) ||
454             close_lock_file(&false_lock))
455                 die(_("unable to write temporary index file"));
457         discard_cache();
458         read_cache_from(false_lock.filename);
460         return false_lock.filename;
463 static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn,
464                       struct wt_status *s)
466         unsigned char sha1[20];
468         if (s->relative_paths)
469                 s->prefix = prefix;
471         if (amend) {
472                 s->amend = 1;
473                 s->reference = "HEAD^1";
474         }
475         s->verbose = verbose;
476         s->index_file = index_file;
477         s->fp = fp;
478         s->nowarn = nowarn;
479         s->is_initial = get_sha1(s->reference, sha1) ? 1 : 0;
481         wt_status_collect(s);
483         switch (status_format) {
484         case STATUS_FORMAT_SHORT:
485                 wt_shortstatus_print(s, null_termination, status_show_branch);
486                 break;
487         case STATUS_FORMAT_PORCELAIN:
488                 wt_porcelain_print(s, null_termination);
489                 break;
490         case STATUS_FORMAT_LONG:
491                 wt_status_print(s);
492                 break;
493         }
495         return s->commitable;
498 static int is_a_merge(const unsigned char *sha1)
500         struct commit *commit = lookup_commit(sha1);
501         if (!commit || parse_commit(commit))
502                 die(_("could not parse HEAD commit"));
503         return !!(commit->parents && commit->parents->next);
506 static const char sign_off_header[] = "Signed-off-by: ";
508 static void determine_author_info(struct strbuf *author_ident)
510         char *name, *email, *date;
512         name = getenv("GIT_AUTHOR_NAME");
513         email = getenv("GIT_AUTHOR_EMAIL");
514         date = getenv("GIT_AUTHOR_DATE");
516         if (author_message) {
517                 const char *a, *lb, *rb, *eol;
519                 a = strstr(author_message_buffer, "\nauthor ");
520                 if (!a)
521                         die(_("invalid commit: %s"), author_message);
523                 lb = strchrnul(a + strlen("\nauthor "), '<');
524                 rb = strchrnul(lb, '>');
525                 eol = strchrnul(rb, '\n');
526                 if (!*lb || !*rb || !*eol)
527                         die(_("invalid commit: %s"), author_message);
529                 if (lb == a + strlen("\nauthor "))
530                         /* \nauthor <foo@example.com> */
531                         name = xcalloc(1, 1);
532                 else
533                         name = xmemdupz(a + strlen("\nauthor "),
534                                         (lb - strlen(" ") -
535                                          (a + strlen("\nauthor "))));
536                 email = xmemdupz(lb + strlen("<"), rb - (lb + strlen("<")));
537                 date = xmemdupz(rb + strlen("> "), eol - (rb + strlen("> ")));
538         }
540         if (force_author) {
541                 const char *lb = strstr(force_author, " <");
542                 const char *rb = strchr(force_author, '>');
544                 if (!lb || !rb)
545                         die(_("malformed --author parameter"));
546                 name = xstrndup(force_author, lb - force_author);
547                 email = xstrndup(lb + 2, rb - (lb + 2));
548         }
550         if (force_date)
551                 date = force_date;
552         strbuf_addstr(author_ident, fmt_ident(name, email, date,
553                                               IDENT_ERROR_ON_NO_NAME));
556 static int ends_rfc2822_footer(struct strbuf *sb)
558         int ch;
559         int hit = 0;
560         int i, j, k;
561         int len = sb->len;
562         int first = 1;
563         const char *buf = sb->buf;
565         for (i = len - 1; i > 0; i--) {
566                 if (hit && buf[i] == '\n')
567                         break;
568                 hit = (buf[i] == '\n');
569         }
571         while (i < len - 1 && buf[i] == '\n')
572                 i++;
574         for (; i < len; i = k) {
575                 for (k = i; k < len && buf[k] != '\n'; k++)
576                         ; /* do nothing */
577                 k++;
579                 if ((buf[k] == ' ' || buf[k] == '\t') && !first)
580                         continue;
582                 first = 0;
584                 for (j = 0; i + j < len; j++) {
585                         ch = buf[i + j];
586                         if (ch == ':')
587                                 break;
588                         if (isalnum(ch) ||
589                             (ch == '-'))
590                                 continue;
591                         return 0;
592                 }
593         }
594         return 1;
597 static char *cut_ident_timestamp_part(char *string)
599         char *ket = strrchr(string, '>');
600         if (!ket || ket[1] != ' ')
601                 die(_("Malformed ident string: '%s'"), string);
602         *++ket = '\0';
603         return ket;
606 static int prepare_to_commit(const char *index_file, const char *prefix,
607                              struct wt_status *s,
608                              struct strbuf *author_ident)
610         struct stat statbuf;
611         struct strbuf committer_ident = STRBUF_INIT;
612         int commitable, saved_color_setting;
613         struct strbuf sb = STRBUF_INIT;
614         char *buffer;
615         const char *hook_arg1 = NULL;
616         const char *hook_arg2 = NULL;
617         int ident_shown = 0;
618         int clean_message_contents = (cleanup_mode != CLEANUP_NONE);
620         if (!no_verify && run_hook(index_file, "pre-commit", NULL))
621                 return 0;
623         if (squash_message) {
624                 /*
625                  * Insert the proper subject line before other commit
626                  * message options add their content.
627                  */
628                 if (use_message && !strcmp(use_message, squash_message))
629                         strbuf_addstr(&sb, "squash! ");
630                 else {
631                         struct pretty_print_context ctx = {0};
632                         struct commit *c;
633                         c = lookup_commit_reference_by_name(squash_message);
634                         if (!c)
635                                 die(_("could not lookup commit %s"), squash_message);
636                         ctx.output_encoding = get_commit_output_encoding();
637                         format_commit_message(c, "squash! %s\n\n", &sb,
638                                               &ctx);
639                 }
640         }
642         if (message.len) {
643                 strbuf_addbuf(&sb, &message);
644                 hook_arg1 = "message";
645         } else if (logfile && !strcmp(logfile, "-")) {
646                 if (isatty(0))
647                         fprintf(stderr, _("(reading log message from standard input)\n"));
648                 if (strbuf_read(&sb, 0, 0) < 0)
649                         die_errno(_("could not read log from standard input"));
650                 hook_arg1 = "message";
651         } else if (logfile) {
652                 if (strbuf_read_file(&sb, logfile, 0) < 0)
653                         die_errno(_("could not read log file '%s'"),
654                                   logfile);
655                 hook_arg1 = "message";
656         } else if (use_message) {
657                 buffer = strstr(use_message_buffer, "\n\n");
658                 if (!buffer || buffer[2] == '\0')
659                         die(_("commit has empty message"));
660                 strbuf_add(&sb, buffer + 2, strlen(buffer + 2));
661                 hook_arg1 = "commit";
662                 hook_arg2 = use_message;
663         } else if (fixup_message) {
664                 struct pretty_print_context ctx = {0};
665                 struct commit *commit;
666                 commit = lookup_commit_reference_by_name(fixup_message);
667                 if (!commit)
668                         die(_("could not lookup commit %s"), fixup_message);
669                 ctx.output_encoding = get_commit_output_encoding();
670                 format_commit_message(commit, "fixup! %s\n\n",
671                                       &sb, &ctx);
672                 hook_arg1 = "message";
673         } else if (!stat(git_path("MERGE_MSG"), &statbuf)) {
674                 if (strbuf_read_file(&sb, git_path("MERGE_MSG"), 0) < 0)
675                         die_errno(_("could not read MERGE_MSG"));
676                 hook_arg1 = "merge";
677         } else if (!stat(git_path("SQUASH_MSG"), &statbuf)) {
678                 if (strbuf_read_file(&sb, git_path("SQUASH_MSG"), 0) < 0)
679                         die_errno(_("could not read SQUASH_MSG"));
680                 hook_arg1 = "squash";
681         } else if (template_file) {
682                 if (strbuf_read_file(&sb, template_file, 0) < 0)
683                         die_errno(_("could not read '%s'"), template_file);
684                 hook_arg1 = "template";
685                 clean_message_contents = 0;
686         }
688         /*
689          * The remaining cases don't modify the template message, but
690          * just set the argument(s) to the prepare-commit-msg hook.
691          */
692         else if (whence == FROM_MERGE)
693                 hook_arg1 = "merge";
694         else if (whence == FROM_CHERRY_PICK) {
695                 hook_arg1 = "commit";
696                 hook_arg2 = "CHERRY_PICK_HEAD";
697         }
699         if (squash_message) {
700                 /*
701                  * If squash_commit was used for the commit subject,
702                  * then we're possibly hijacking other commit log options.
703                  * Reset the hook args to tell the real story.
704                  */
705                 hook_arg1 = "message";
706                 hook_arg2 = "";
707         }
709         s->fp = fopen(git_path(commit_editmsg), "w");
710         if (s->fp == NULL)
711                 die_errno(_("could not open '%s'"), git_path(commit_editmsg));
713         if (clean_message_contents)
714                 stripspace(&sb, 0);
716         if (signoff) {
717                 struct strbuf sob = STRBUF_INIT;
718                 int i;
720                 strbuf_addstr(&sob, sign_off_header);
721                 strbuf_addstr(&sob, fmt_name(getenv("GIT_COMMITTER_NAME"),
722                                              getenv("GIT_COMMITTER_EMAIL")));
723                 strbuf_addch(&sob, '\n');
724                 for (i = sb.len - 1; i > 0 && sb.buf[i - 1] != '\n'; i--)
725                         ; /* do nothing */
726                 if (prefixcmp(sb.buf + i, sob.buf)) {
727                         if (!i || !ends_rfc2822_footer(&sb))
728                                 strbuf_addch(&sb, '\n');
729                         strbuf_addbuf(&sb, &sob);
730                 }
731                 strbuf_release(&sob);
732         }
734         if (fwrite(sb.buf, 1, sb.len, s->fp) < sb.len)
735                 die_errno(_("could not write commit template"));
737         strbuf_release(&sb);
739         /* This checks and barfs if author is badly specified */
740         determine_author_info(author_ident);
742         /* This checks if committer ident is explicitly given */
743         strbuf_addstr(&committer_ident, git_committer_info(0));
744         if (use_editor && include_status) {
745                 char *ai_tmp, *ci_tmp;
746                 if (whence != FROM_COMMIT)
747                         status_printf_ln(s, GIT_COLOR_NORMAL,
748                                 _("\n"
749                                 "It looks like you may be committing a %s.\n"
750                                 "If this is not correct, please remove the file\n"
751                                 "       %s\n"
752                                 "and try again.\n"
753                                 ""),
754                                 whence_s(),
755                                 git_path(whence == FROM_MERGE
756                                          ? "MERGE_HEAD"
757                                          : "CHERRY_PICK_HEAD"));
759                 fprintf(s->fp, "\n");
760                 status_printf(s, GIT_COLOR_NORMAL,
761                         _("Please enter the commit message for your changes."));
762                 if (cleanup_mode == CLEANUP_ALL)
763                         status_printf_more(s, GIT_COLOR_NORMAL,
764                                 _(" Lines starting\n"
765                                 "with '#' will be ignored, and an empty"
766                                 " message aborts the commit.\n"));
767                 else /* CLEANUP_SPACE, that is. */
768                         status_printf_more(s, GIT_COLOR_NORMAL,
769                                 _(" Lines starting\n"
770                                 "with '#' will be kept; you may remove them"
771                                 " yourself if you want to.\n"
772                                 "An empty message aborts the commit.\n"));
773                 if (only_include_assumed)
774                         status_printf_ln(s, GIT_COLOR_NORMAL,
775                                         "%s", only_include_assumed);
777                 ai_tmp = cut_ident_timestamp_part(author_ident->buf);
778                 ci_tmp = cut_ident_timestamp_part(committer_ident.buf);
779                 if (strcmp(author_ident->buf, committer_ident.buf))
780                         status_printf_ln(s, GIT_COLOR_NORMAL,
781                                 _("%s"
782                                 "Author:    %s"),
783                                 ident_shown++ ? "" : "\n",
784                                 author_ident->buf);
786                 if (!user_ident_sufficiently_given())
787                         status_printf_ln(s, GIT_COLOR_NORMAL,
788                                 _("%s"
789                                 "Committer: %s"),
790                                 ident_shown++ ? "" : "\n",
791                                 committer_ident.buf);
793                 if (ident_shown)
794                         status_printf_ln(s, GIT_COLOR_NORMAL, "");
796                 saved_color_setting = s->use_color;
797                 s->use_color = 0;
798                 commitable = run_status(s->fp, index_file, prefix, 1, s);
799                 s->use_color = saved_color_setting;
801                 *ai_tmp = ' ';
802                 *ci_tmp = ' ';
803         } else {
804                 unsigned char sha1[20];
805                 const char *parent = "HEAD";
807                 if (!active_nr && read_cache() < 0)
808                         die(_("Cannot read index"));
810                 if (amend)
811                         parent = "HEAD^1";
813                 if (get_sha1(parent, sha1))
814                         commitable = !!active_nr;
815                 else
816                         commitable = index_differs_from(parent, 0);
817         }
818         strbuf_release(&committer_ident);
820         fclose(s->fp);
822         /*
823          * Reject an attempt to record a non-merge empty commit without
824          * explicit --allow-empty. In the cherry-pick case, it may be
825          * empty due to conflict resolution, which the user should okay.
826          */
827         if (!commitable && whence != FROM_MERGE && !allow_empty &&
828             !(amend && is_a_merge(head_sha1))) {
829                 run_status(stdout, index_file, prefix, 0, s);
830                 if (amend)
831                         fputs(_(empty_amend_advice), stderr);
832                 else if (whence == FROM_CHERRY_PICK)
833                         fputs(_(empty_cherry_pick_advice), stderr);
834                 return 0;
835         }
837         /*
838          * Re-read the index as pre-commit hook could have updated it,
839          * and write it out as a tree.  We must do this before we invoke
840          * the editor and after we invoke run_status above.
841          */
842         discard_cache();
843         read_cache_from(index_file);
844         if (!active_cache_tree)
845                 active_cache_tree = cache_tree();
846         if (cache_tree_update(active_cache_tree,
847                               active_cache, active_nr, 0, 0) < 0) {
848                 error(_("Error building trees"));
849                 return 0;
850         }
852         if (run_hook(index_file, "prepare-commit-msg",
853                      git_path(commit_editmsg), hook_arg1, hook_arg2, NULL))
854                 return 0;
856         if (use_editor) {
857                 char index[PATH_MAX];
858                 const char *env[2] = { NULL };
859                 env[0] =  index;
860                 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
861                 if (launch_editor(git_path(commit_editmsg), NULL, env)) {
862                         fprintf(stderr,
863                         _("Please supply the message using either -m or -F option.\n"));
864                         exit(1);
865                 }
866         }
868         if (!no_verify &&
869             run_hook(index_file, "commit-msg", git_path(commit_editmsg), NULL)) {
870                 return 0;
871         }
873         return 1;
876 /*
877  * Find out if the message in the strbuf contains only whitespace and
878  * Signed-off-by lines.
879  */
880 static int message_is_empty(struct strbuf *sb)
882         struct strbuf tmpl = STRBUF_INIT;
883         const char *nl;
884         int eol, i, start = 0;
886         if (cleanup_mode == CLEANUP_NONE && sb->len)
887                 return 0;
889         /* See if the template is just a prefix of the message. */
890         if (template_file && strbuf_read_file(&tmpl, template_file, 0) > 0) {
891                 stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
892                 if (start + tmpl.len <= sb->len &&
893                     memcmp(tmpl.buf, sb->buf + start, tmpl.len) == 0)
894                         start += tmpl.len;
895         }
896         strbuf_release(&tmpl);
898         /* Check if the rest is just whitespace and Signed-of-by's. */
899         for (i = start; i < sb->len; i++) {
900                 nl = memchr(sb->buf + i, '\n', sb->len - i);
901                 if (nl)
902                         eol = nl - sb->buf;
903                 else
904                         eol = sb->len;
906                 if (strlen(sign_off_header) <= eol - i &&
907                     !prefixcmp(sb->buf + i, sign_off_header)) {
908                         i = eol;
909                         continue;
910                 }
911                 while (i < eol)
912                         if (!isspace(sb->buf[i++]))
913                                 return 0;
914         }
916         return 1;
919 static const char *find_author_by_nickname(const char *name)
921         struct rev_info revs;
922         struct commit *commit;
923         struct strbuf buf = STRBUF_INIT;
924         const char *av[20];
925         int ac = 0;
927         init_revisions(&revs, NULL);
928         strbuf_addf(&buf, "--author=%s", name);
929         av[++ac] = "--all";
930         av[++ac] = "-i";
931         av[++ac] = buf.buf;
932         av[++ac] = NULL;
933         setup_revisions(ac, av, &revs, NULL);
934         prepare_revision_walk(&revs);
935         commit = get_revision(&revs);
936         if (commit) {
937                 struct pretty_print_context ctx = {0};
938                 ctx.date_mode = DATE_NORMAL;
939                 strbuf_release(&buf);
940                 format_commit_message(commit, "%an <%ae>", &buf, &ctx);
941                 return strbuf_detach(&buf, NULL);
942         }
943         die(_("No existing author found with '%s'"), name);
947 static void handle_untracked_files_arg(struct wt_status *s)
949         if (!untracked_files_arg)
950                 ; /* default already initialized */
951         else if (!strcmp(untracked_files_arg, "no"))
952                 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
953         else if (!strcmp(untracked_files_arg, "normal"))
954                 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
955         else if (!strcmp(untracked_files_arg, "all"))
956                 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
957         else
958                 die(_("Invalid untracked files mode '%s'"), untracked_files_arg);
961 static const char *read_commit_message(const char *name)
963         const char *out_enc, *out;
964         struct commit *commit;
966         commit = lookup_commit_reference_by_name(name);
967         if (!commit)
968                 die(_("could not lookup commit %s"), name);
969         out_enc = get_commit_output_encoding();
970         out = logmsg_reencode(commit, out_enc);
972         /*
973          * If we failed to reencode the buffer, just copy it
974          * byte for byte so the user can try to fix it up.
975          * This also handles the case where input and output
976          * encodings are identical.
977          */
978         if (out == NULL)
979                 out = xstrdup(commit->buffer);
980         return out;
983 static int parse_and_validate_options(int argc, const char *argv[],
984                                       const char * const usage[],
985                                       const char *prefix,
986                                       struct wt_status *s)
988         int f = 0;
990         argc = parse_options(argc, argv, prefix, builtin_commit_options, usage,
991                              0);
993         if (force_author && !strchr(force_author, '>'))
994                 force_author = find_author_by_nickname(force_author);
996         if (force_author && renew_authorship)
997                 die(_("Using both --reset-author and --author does not make sense"));
999         if (logfile || message.len || use_message || fixup_message)
1000                 use_editor = 0;
1001         if (edit_flag)
1002                 use_editor = 1;
1003         if (!use_editor)
1004                 setenv("GIT_EDITOR", ":", 1);
1006         if (get_sha1("HEAD", head_sha1))
1007                 initial_commit = 1;
1009         /* Sanity check options */
1010         if (amend && initial_commit)
1011                 die(_("You have nothing to amend."));
1012         if (amend && whence != FROM_COMMIT)
1013                 die(_("You are in the middle of a %s -- cannot amend."), whence_s());
1014         if (fixup_message && squash_message)
1015                 die(_("Options --squash and --fixup cannot be used together"));
1016         if (use_message)
1017                 f++;
1018         if (edit_message)
1019                 f++;
1020         if (fixup_message)
1021                 f++;
1022         if (logfile)
1023                 f++;
1024         if (f > 1)
1025                 die(_("Only one of -c/-C/-F/--fixup can be used."));
1026         if (message.len && f > 0)
1027                 die((_("Option -m cannot be combined with -c/-C/-F/--fixup.")));
1028         if (edit_message)
1029                 use_message = edit_message;
1030         if (amend && !use_message && !fixup_message)
1031                 use_message = "HEAD";
1032         if (!use_message && whence != FROM_CHERRY_PICK && renew_authorship)
1033                 die(_("--reset-author can be used only with -C, -c or --amend."));
1034         if (use_message) {
1035                 use_message_buffer = read_commit_message(use_message);
1036                 if (!renew_authorship) {
1037                         author_message = use_message;
1038                         author_message_buffer = use_message_buffer;
1039                 }
1040         }
1041         if (whence == FROM_CHERRY_PICK && !renew_authorship) {
1042                 author_message = "CHERRY_PICK_HEAD";
1043                 author_message_buffer = read_commit_message(author_message);
1044         }
1046         if (!!also + !!only + !!all + !!interactive > 1)
1047                 die(_("Only one of --include/--only/--all/--interactive can be used."));
1048         if (argc == 0 && (also || (only && !amend)))
1049                 die(_("No paths with --include/--only does not make sense."));
1050         if (argc == 0 && only && amend)
1051                 only_include_assumed = _("Clever... amending the last one with dirty index.");
1052         if (argc > 0 && !also && !only)
1053                 only_include_assumed = _("Explicit paths specified without -i nor -o; assuming --only paths...");
1054         if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
1055                 cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
1056         else if (!strcmp(cleanup_arg, "verbatim"))
1057                 cleanup_mode = CLEANUP_NONE;
1058         else if (!strcmp(cleanup_arg, "whitespace"))
1059                 cleanup_mode = CLEANUP_SPACE;
1060         else if (!strcmp(cleanup_arg, "strip"))
1061                 cleanup_mode = CLEANUP_ALL;
1062         else
1063                 die(_("Invalid cleanup mode %s"), cleanup_arg);
1065         handle_untracked_files_arg(s);
1067         if (all && argc > 0)
1068                 die(_("Paths with -a does not make sense."));
1069         else if (interactive && argc > 0)
1070                 die(_("Paths with --interactive does not make sense."));
1072         if (null_termination && status_format == STATUS_FORMAT_LONG)
1073                 status_format = STATUS_FORMAT_PORCELAIN;
1074         if (status_format != STATUS_FORMAT_LONG)
1075                 dry_run = 1;
1077         return argc;
1080 static int dry_run_commit(int argc, const char **argv, const char *prefix,
1081                           struct wt_status *s)
1083         int commitable;
1084         const char *index_file;
1086         index_file = prepare_index(argc, argv, prefix, 1);
1087         commitable = run_status(stdout, index_file, prefix, 0, s);
1088         rollback_index_files();
1090         return commitable ? 0 : 1;
1093 static int parse_status_slot(const char *var, int offset)
1095         if (!strcasecmp(var+offset, "header"))
1096                 return WT_STATUS_HEADER;
1097         if (!strcasecmp(var+offset, "branch"))
1098                 return WT_STATUS_ONBRANCH;
1099         if (!strcasecmp(var+offset, "updated")
1100                 || !strcasecmp(var+offset, "added"))
1101                 return WT_STATUS_UPDATED;
1102         if (!strcasecmp(var+offset, "changed"))
1103                 return WT_STATUS_CHANGED;
1104         if (!strcasecmp(var+offset, "untracked"))
1105                 return WT_STATUS_UNTRACKED;
1106         if (!strcasecmp(var+offset, "nobranch"))
1107                 return WT_STATUS_NOBRANCH;
1108         if (!strcasecmp(var+offset, "unmerged"))
1109                 return WT_STATUS_UNMERGED;
1110         return -1;
1113 static int git_status_config(const char *k, const char *v, void *cb)
1115         struct wt_status *s = cb;
1117         if (!strcmp(k, "status.submodulesummary")) {
1118                 int is_bool;
1119                 s->submodule_summary = git_config_bool_or_int(k, v, &is_bool);
1120                 if (is_bool && s->submodule_summary)
1121                         s->submodule_summary = -1;
1122                 return 0;
1123         }
1124         if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
1125                 s->use_color = git_config_colorbool(k, v, -1);
1126                 return 0;
1127         }
1128         if (!prefixcmp(k, "status.color.") || !prefixcmp(k, "color.status.")) {
1129                 int slot = parse_status_slot(k, 13);
1130                 if (slot < 0)
1131                         return 0;
1132                 if (!v)
1133                         return config_error_nonbool(k);
1134                 color_parse(v, k, s->color_palette[slot]);
1135                 return 0;
1136         }
1137         if (!strcmp(k, "status.relativepaths")) {
1138                 s->relative_paths = git_config_bool(k, v);
1139                 return 0;
1140         }
1141         if (!strcmp(k, "status.showuntrackedfiles")) {
1142                 if (!v)
1143                         return config_error_nonbool(k);
1144                 else if (!strcmp(v, "no"))
1145                         s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1146                 else if (!strcmp(v, "normal"))
1147                         s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1148                 else if (!strcmp(v, "all"))
1149                         s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1150                 else
1151                         return error(_("Invalid untracked files mode '%s'"), v);
1152                 return 0;
1153         }
1154         return git_diff_ui_config(k, v, NULL);
1157 int cmd_status(int argc, const char **argv, const char *prefix)
1159         struct wt_status s;
1160         int fd;
1161         unsigned char sha1[20];
1162         static struct option builtin_status_options[] = {
1163                 OPT__VERBOSE(&verbose, "be verbose"),
1164                 OPT_SET_INT('s', "short", &status_format,
1165                             "show status concisely", STATUS_FORMAT_SHORT),
1166                 OPT_BOOLEAN('b', "branch", &status_show_branch,
1167                             "show branch information"),
1168                 OPT_SET_INT(0, "porcelain", &status_format,
1169                             "machine-readable output",
1170                             STATUS_FORMAT_PORCELAIN),
1171                 OPT_BOOLEAN('z', "null", &null_termination,
1172                             "terminate entries with NUL"),
1173                 { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg,
1174                   "mode",
1175                   "show untracked files, optional modes: all, normal, no. (Default: all)",
1176                   PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1177                 OPT_BOOLEAN(0, "ignored", &show_ignored_in_status,
1178                             "show ignored files"),
1179                 { OPTION_STRING, 0, "ignore-submodules", &ignore_submodule_arg, "when",
1180                   "ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)",
1181                   PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1182                 OPT_END(),
1183         };
1185         if (argc == 2 && !strcmp(argv[1], "-h"))
1186                 usage_with_options(builtin_status_usage, builtin_status_options);
1188         if (null_termination && status_format == STATUS_FORMAT_LONG)
1189                 status_format = STATUS_FORMAT_PORCELAIN;
1191         wt_status_prepare(&s);
1192         gitmodules_config();
1193         git_config(git_status_config, &s);
1194         determine_whence(&s);
1195         argc = parse_options(argc, argv, prefix,
1196                              builtin_status_options,
1197                              builtin_status_usage, 0);
1198         handle_untracked_files_arg(&s);
1199         if (show_ignored_in_status)
1200                 s.show_ignored_files = 1;
1201         if (*argv)
1202                 s.pathspec = get_pathspec(prefix, argv);
1204         read_cache_preload(s.pathspec);
1205         refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, s.pathspec, NULL, NULL);
1207         fd = hold_locked_index(&index_lock, 0);
1208         if (0 <= fd)
1209                 update_index_if_able(&the_index, &index_lock);
1211         s.is_initial = get_sha1(s.reference, sha1) ? 1 : 0;
1212         s.ignore_submodule_arg = ignore_submodule_arg;
1213         wt_status_collect(&s);
1215         if (s.relative_paths)
1216                 s.prefix = prefix;
1217         if (s.use_color == -1)
1218                 s.use_color = git_use_color_default;
1219         if (diff_use_color_default == -1)
1220                 diff_use_color_default = git_use_color_default;
1222         switch (status_format) {
1223         case STATUS_FORMAT_SHORT:
1224                 wt_shortstatus_print(&s, null_termination, status_show_branch);
1225                 break;
1226         case STATUS_FORMAT_PORCELAIN:
1227                 wt_porcelain_print(&s, null_termination);
1228                 break;
1229         case STATUS_FORMAT_LONG:
1230                 s.verbose = verbose;
1231                 s.ignore_submodule_arg = ignore_submodule_arg;
1232                 wt_status_print(&s);
1233                 break;
1234         }
1235         return 0;
1238 static void print_summary(const char *prefix, const unsigned char *sha1)
1240         struct rev_info rev;
1241         struct commit *commit;
1242         struct strbuf format = STRBUF_INIT;
1243         unsigned char junk_sha1[20];
1244         const char *head = resolve_ref("HEAD", junk_sha1, 0, NULL);
1245         struct pretty_print_context pctx = {0};
1246         struct strbuf author_ident = STRBUF_INIT;
1247         struct strbuf committer_ident = STRBUF_INIT;
1249         commit = lookup_commit(sha1);
1250         if (!commit)
1251                 die(_("couldn't look up newly created commit"));
1252         if (!commit || parse_commit(commit))
1253                 die(_("could not parse newly created commit"));
1255         strbuf_addstr(&format, "format:%h] %s");
1257         format_commit_message(commit, "%an <%ae>", &author_ident, &pctx);
1258         format_commit_message(commit, "%cn <%ce>", &committer_ident, &pctx);
1259         if (strbuf_cmp(&author_ident, &committer_ident)) {
1260                 strbuf_addstr(&format, "\n Author: ");
1261                 strbuf_addbuf_percentquote(&format, &author_ident);
1262         }
1263         if (!user_ident_sufficiently_given()) {
1264                 strbuf_addstr(&format, "\n Committer: ");
1265                 strbuf_addbuf_percentquote(&format, &committer_ident);
1266                 if (advice_implicit_identity) {
1267                         strbuf_addch(&format, '\n');
1268                         strbuf_addstr(&format, _(implicit_ident_advice));
1269                 }
1270         }
1271         strbuf_release(&author_ident);
1272         strbuf_release(&committer_ident);
1274         init_revisions(&rev, prefix);
1275         setup_revisions(0, NULL, &rev, NULL);
1277         rev.diff = 1;
1278         rev.diffopt.output_format =
1279                 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
1281         rev.verbose_header = 1;
1282         rev.show_root_diff = 1;
1283         get_commit_format(format.buf, &rev);
1284         rev.always_show_header = 0;
1285         rev.diffopt.detect_rename = 1;
1286         rev.diffopt.break_opt = 0;
1287         diff_setup_done(&rev.diffopt);
1289         printf("[%s%s ",
1290                 !prefixcmp(head, "refs/heads/") ?
1291                         head + 11 :
1292                         !strcmp(head, "HEAD") ?
1293                                 _("detached HEAD") :
1294                                 head,
1295                 initial_commit ? _(" (root-commit)") : "");
1297         if (!log_tree_commit(&rev, commit)) {
1298                 rev.always_show_header = 1;
1299                 rev.use_terminator = 1;
1300                 log_tree_commit(&rev, commit);
1301         }
1303         strbuf_release(&format);
1306 static int git_commit_config(const char *k, const char *v, void *cb)
1308         struct wt_status *s = cb;
1310         if (!strcmp(k, "commit.template"))
1311                 return git_config_pathname(&template_file, k, v);
1312         if (!strcmp(k, "commit.status")) {
1313                 include_status = git_config_bool(k, v);
1314                 return 0;
1315         }
1317         return git_status_config(k, v, s);
1320 static const char post_rewrite_hook[] = "hooks/post-rewrite";
1322 static int run_rewrite_hook(const unsigned char *oldsha1,
1323                             const unsigned char *newsha1)
1325         /* oldsha1 SP newsha1 LF NUL */
1326         static char buf[2*40 + 3];
1327         struct child_process proc;
1328         const char *argv[3];
1329         int code;
1330         size_t n;
1332         if (access(git_path(post_rewrite_hook), X_OK) < 0)
1333                 return 0;
1335         argv[0] = git_path(post_rewrite_hook);
1336         argv[1] = "amend";
1337         argv[2] = NULL;
1339         memset(&proc, 0, sizeof(proc));
1340         proc.argv = argv;
1341         proc.in = -1;
1342         proc.stdout_to_stderr = 1;
1344         code = start_command(&proc);
1345         if (code)
1346                 return code;
1347         n = snprintf(buf, sizeof(buf), "%s %s\n",
1348                      sha1_to_hex(oldsha1), sha1_to_hex(newsha1));
1349         write_in_full(proc.in, buf, n);
1350         close(proc.in);
1351         return finish_command(&proc);
1354 int cmd_commit(int argc, const char **argv, const char *prefix)
1356         struct strbuf sb = STRBUF_INIT;
1357         struct strbuf author_ident = STRBUF_INIT;
1358         const char *index_file, *reflog_msg;
1359         char *nl, *p;
1360         unsigned char commit_sha1[20];
1361         struct ref_lock *ref_lock;
1362         struct commit_list *parents = NULL, **pptr = &parents;
1363         struct stat statbuf;
1364         int allow_fast_forward = 1;
1365         struct wt_status s;
1367         if (argc == 2 && !strcmp(argv[1], "-h"))
1368                 usage_with_options(builtin_commit_usage, builtin_commit_options);
1370         wt_status_prepare(&s);
1371         git_config(git_commit_config, &s);
1372         determine_whence(&s);
1374         if (s.use_color == -1)
1375                 s.use_color = git_use_color_default;
1376         argc = parse_and_validate_options(argc, argv, builtin_commit_usage,
1377                                           prefix, &s);
1378         if (dry_run) {
1379                 if (diff_use_color_default == -1)
1380                         diff_use_color_default = git_use_color_default;
1381                 return dry_run_commit(argc, argv, prefix, &s);
1382         }
1383         index_file = prepare_index(argc, argv, prefix, 0);
1385         /* Set up everything for writing the commit object.  This includes
1386            running hooks, writing the trees, and interacting with the user.  */
1387         if (!prepare_to_commit(index_file, prefix, &s, &author_ident)) {
1388                 rollback_index_files();
1389                 return 1;
1390         }
1392         /* Determine parents */
1393         reflog_msg = getenv("GIT_REFLOG_ACTION");
1394         if (initial_commit) {
1395                 if (!reflog_msg)
1396                         reflog_msg = "commit (initial)";
1397         } else if (amend) {
1398                 struct commit_list *c;
1399                 struct commit *commit;
1401                 if (!reflog_msg)
1402                         reflog_msg = "commit (amend)";
1403                 commit = lookup_commit(head_sha1);
1404                 if (!commit || parse_commit(commit))
1405                         die(_("could not parse HEAD commit"));
1407                 for (c = commit->parents; c; c = c->next)
1408                         pptr = &commit_list_insert(c->item, pptr)->next;
1409         } else if (whence == FROM_MERGE) {
1410                 struct strbuf m = STRBUF_INIT;
1411                 FILE *fp;
1413                 if (!reflog_msg)
1414                         reflog_msg = "commit (merge)";
1415                 pptr = &commit_list_insert(lookup_commit(head_sha1), pptr)->next;
1416                 fp = fopen(git_path("MERGE_HEAD"), "r");
1417                 if (fp == NULL)
1418                         die_errno(_("could not open '%s' for reading"),
1419                                   git_path("MERGE_HEAD"));
1420                 while (strbuf_getline(&m, fp, '\n') != EOF) {
1421                         unsigned char sha1[20];
1422                         if (get_sha1_hex(m.buf, sha1) < 0)
1423                                 die(_("Corrupt MERGE_HEAD file (%s)"), m.buf);
1424                         pptr = &commit_list_insert(lookup_commit(sha1), pptr)->next;
1425                 }
1426                 fclose(fp);
1427                 strbuf_release(&m);
1428                 if (!stat(git_path("MERGE_MODE"), &statbuf)) {
1429                         if (strbuf_read_file(&sb, git_path("MERGE_MODE"), 0) < 0)
1430                                 die_errno(_("could not read MERGE_MODE"));
1431                         if (!strcmp(sb.buf, "no-ff"))
1432                                 allow_fast_forward = 0;
1433                 }
1434                 if (allow_fast_forward)
1435                         parents = reduce_heads(parents);
1436         } else {
1437                 if (!reflog_msg)
1438                         reflog_msg = (whence == FROM_CHERRY_PICK)
1439                                         ? "commit (cherry-pick)"
1440                                         : "commit";
1441                 pptr = &commit_list_insert(lookup_commit(head_sha1), pptr)->next;
1442         }
1444         /* Finally, get the commit message */
1445         strbuf_reset(&sb);
1446         if (strbuf_read_file(&sb, git_path(commit_editmsg), 0) < 0) {
1447                 int saved_errno = errno;
1448                 rollback_index_files();
1449                 die(_("could not read commit message: %s"), strerror(saved_errno));
1450         }
1452         /* Truncate the message just before the diff, if any. */
1453         if (verbose) {
1454                 p = strstr(sb.buf, "\ndiff --git ");
1455                 if (p != NULL)
1456                         strbuf_setlen(&sb, p - sb.buf + 1);
1457         }
1459         if (cleanup_mode != CLEANUP_NONE)
1460                 stripspace(&sb, cleanup_mode == CLEANUP_ALL);
1461         if (message_is_empty(&sb) && !allow_empty_message) {
1462                 rollback_index_files();
1463                 fprintf(stderr, _("Aborting commit due to empty commit message.\n"));
1464                 exit(1);
1465         }
1467         if (commit_tree(sb.buf, active_cache_tree->sha1, parents, commit_sha1,
1468                         author_ident.buf)) {
1469                 rollback_index_files();
1470                 die(_("failed to write commit object"));
1471         }
1472         strbuf_release(&author_ident);
1474         ref_lock = lock_any_ref_for_update("HEAD",
1475                                            initial_commit ? NULL : head_sha1,
1476                                            0);
1478         nl = strchr(sb.buf, '\n');
1479         if (nl)
1480                 strbuf_setlen(&sb, nl + 1 - sb.buf);
1481         else
1482                 strbuf_addch(&sb, '\n');
1483         strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
1484         strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
1486         if (!ref_lock) {
1487                 rollback_index_files();
1488                 die(_("cannot lock HEAD ref"));
1489         }
1490         if (write_ref_sha1(ref_lock, commit_sha1, sb.buf) < 0) {
1491                 rollback_index_files();
1492                 die(_("cannot update HEAD ref"));
1493         }
1495         unlink(git_path("CHERRY_PICK_HEAD"));
1496         unlink(git_path("MERGE_HEAD"));
1497         unlink(git_path("MERGE_MSG"));
1498         unlink(git_path("MERGE_MODE"));
1499         unlink(git_path("SQUASH_MSG"));
1501         if (commit_index_files())
1502                 die (_("Repository has been updated, but unable to write\n"
1503                      "new_index file. Check that disk is not full or quota is\n"
1504                      "not exceeded, and then \"git reset HEAD\" to recover."));
1506         rerere(0);
1507         run_hook(get_index_file(), "post-commit", NULL);
1508         if (amend && !no_post_rewrite) {
1509                 struct notes_rewrite_cfg *cfg;
1510                 cfg = init_copy_notes_for_rewrite("amend");
1511                 if (cfg) {
1512                         copy_note_for_rewrite(cfg, head_sha1, commit_sha1);
1513                         finish_copy_notes_for_rewrite(cfg);
1514                 }
1515                 run_rewrite_hook(head_sha1, commit_sha1);
1516         }
1517         if (!quiet)
1518                 print_summary(prefix, commit_sha1);
1520         return 0;