Merge branch 'ep/varscope'
[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  */
7
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"
29 #include "gpg-interface.h"
30 #include "column.h"
31 #include "sequencer.h"
32 #include "notes-utils.h"
33 #include "mailmap.h"
34
35 static const char * const builtin_commit_usage[] = {
36         N_("git commit [options] [--] <pathspec>..."),
37         NULL
38 };
39
40 static const char * const builtin_status_usage[] = {
41         N_("git status [options] [--] <pathspec>..."),
42         NULL
43 };
44
45 static const char implicit_ident_advice[] =
46 N_("Your name and email address were configured automatically based\n"
47 "on your username and hostname. Please check that they are accurate.\n"
48 "You can suppress this message by setting them explicitly:\n"
49 "\n"
50 "    git config --global user.name \"Your Name\"\n"
51 "    git config --global user.email you@example.com\n"
52 "\n"
53 "After doing this, you may fix the identity used for this commit with:\n"
54 "\n"
55 "    git commit --amend --reset-author\n");
56
57 static const char empty_amend_advice[] =
58 N_("You asked to amend the most recent commit, but doing so would make\n"
59 "it empty. You can repeat your command with --allow-empty, or you can\n"
60 "remove the commit entirely with \"git reset HEAD^\".\n");
61
62 static const char empty_cherry_pick_advice[] =
63 N_("The previous cherry-pick is now empty, possibly due to conflict resolution.\n"
64 "If you wish to commit it anyway, use:\n"
65 "\n"
66 "    git commit --allow-empty\n"
67 "\n");
68
69 static const char empty_cherry_pick_advice_single[] =
70 N_("Otherwise, please use 'git reset'\n");
71
72 static const char empty_cherry_pick_advice_multi[] =
73 N_("If you wish to skip this commit, use:\n"
74 "\n"
75 "    git reset\n"
76 "\n"
77 "Then \"git cherry-pick --continue\" will resume cherry-picking\n"
78 "the remaining commits.\n");
79
80 static const char *use_message_buffer;
81 static const char commit_editmsg[] = "COMMIT_EDITMSG";
82 static struct lock_file index_lock; /* real index */
83 static struct lock_file false_lock; /* used only for partial commits */
84 static enum {
85         COMMIT_AS_IS = 1,
86         COMMIT_NORMAL,
87         COMMIT_PARTIAL
88 } commit_style;
89
90 static const char *logfile, *force_author;
91 static const char *template_file;
92 /*
93  * The _message variables are commit names from which to take
94  * the commit message and/or authorship.
95  */
96 static const char *author_message, *author_message_buffer;
97 static char *edit_message, *use_message;
98 static char *fixup_message, *squash_message;
99 static int all, also, interactive, patch_interactive, only, amend, signoff;
100 static int edit_flag = -1; /* unspecified */
101 static int quiet, verbose, no_verify, allow_empty, dry_run, renew_authorship;
102 static int no_post_rewrite, allow_empty_message;
103 static char *untracked_files_arg, *force_date, *ignore_submodule_arg;
104 static char *sign_commit;
105
106 /*
107  * The default commit message cleanup mode will remove the lines
108  * beginning with # (shell comments) and leading and trailing
109  * whitespaces (empty lines or containing only whitespaces)
110  * if editor is used, and only the whitespaces if the message
111  * is specified explicitly.
112  */
113 static enum {
114         CLEANUP_SPACE,
115         CLEANUP_NONE,
116         CLEANUP_ALL
117 } cleanup_mode;
118 static const char *cleanup_arg;
119
120 static enum commit_whence whence;
121 static int sequencer_in_use;
122 static int use_editor = 1, include_status = 1;
123 static int show_ignored_in_status, have_option_m;
124 static const char *only_include_assumed;
125 static struct strbuf message = STRBUF_INIT;
126
127 static enum status_format {
128         STATUS_FORMAT_NONE = 0,
129         STATUS_FORMAT_LONG,
130         STATUS_FORMAT_SHORT,
131         STATUS_FORMAT_PORCELAIN,
132
133         STATUS_FORMAT_UNSPECIFIED
134 } status_format = STATUS_FORMAT_UNSPECIFIED;
135
136 static int opt_parse_m(const struct option *opt, const char *arg, int unset)
137 {
138         struct strbuf *buf = opt->value;
139         if (unset) {
140                 have_option_m = 0;
141                 strbuf_setlen(buf, 0);
142         } else {
143                 have_option_m = 1;
144                 if (buf->len)
145                         strbuf_addch(buf, '\n');
146                 strbuf_addstr(buf, arg);
147                 strbuf_complete_line(buf);
148         }
149         return 0;
150 }
151
152 static void determine_whence(struct wt_status *s)
153 {
154         if (file_exists(git_path("MERGE_HEAD")))
155                 whence = FROM_MERGE;
156         else if (file_exists(git_path("CHERRY_PICK_HEAD"))) {
157                 whence = FROM_CHERRY_PICK;
158                 if (file_exists(git_path("sequencer")))
159                         sequencer_in_use = 1;
160         }
161         else
162                 whence = FROM_COMMIT;
163         if (s)
164                 s->whence = whence;
165 }
166
167 static void status_init_config(struct wt_status *s, config_fn_t fn)
168 {
169         wt_status_prepare(s);
170         gitmodules_config();
171         git_config(fn, s);
172         determine_whence(s);
173         s->hints = advice_status_hints; /* must come after git_config() */
174 }
175
176 static void rollback_index_files(void)
177 {
178         switch (commit_style) {
179         case COMMIT_AS_IS:
180                 break; /* nothing to do */
181         case COMMIT_NORMAL:
182                 rollback_lock_file(&index_lock);
183                 break;
184         case COMMIT_PARTIAL:
185                 rollback_lock_file(&index_lock);
186                 rollback_lock_file(&false_lock);
187                 break;
188         }
189 }
190
191 static int commit_index_files(void)
192 {
193         int err = 0;
194
195         switch (commit_style) {
196         case COMMIT_AS_IS:
197                 break; /* nothing to do */
198         case COMMIT_NORMAL:
199                 err = commit_lock_file(&index_lock);
200                 break;
201         case COMMIT_PARTIAL:
202                 err = commit_lock_file(&index_lock);
203                 rollback_lock_file(&false_lock);
204                 break;
205         }
206
207         return err;
208 }
209
210 /*
211  * Take a union of paths in the index and the named tree (typically, "HEAD"),
212  * and return the paths that match the given pattern in list.
213  */
214 static int list_paths(struct string_list *list, const char *with_tree,
215                       const char *prefix, const struct pathspec *pattern)
216 {
217         int i;
218         char *m;
219
220         if (!pattern->nr)
221                 return 0;
222
223         m = xcalloc(1, pattern->nr);
224
225         if (with_tree) {
226                 char *max_prefix = common_prefix(pattern);
227                 overlay_tree_on_cache(with_tree, max_prefix ? max_prefix : prefix);
228                 free(max_prefix);
229         }
230
231         for (i = 0; i < active_nr; i++) {
232                 const struct cache_entry *ce = active_cache[i];
233                 struct string_list_item *item;
234
235                 if (ce->ce_flags & CE_UPDATE)
236                         continue;
237                 if (!ce_path_match(ce, pattern, m))
238                         continue;
239                 item = string_list_insert(list, ce->name);
240                 if (ce_skip_worktree(ce))
241                         item->util = item; /* better a valid pointer than a fake one */
242         }
243
244         return report_path_error(m, pattern, prefix);
245 }
246
247 static void add_remove_files(struct string_list *list)
248 {
249         int i;
250         for (i = 0; i < list->nr; i++) {
251                 struct stat st;
252                 struct string_list_item *p = &(list->items[i]);
253
254                 /* p->util is skip-worktree */
255                 if (p->util)
256                         continue;
257
258                 if (!lstat(p->string, &st)) {
259                         if (add_to_cache(p->string, &st, 0))
260                                 die(_("updating files failed"));
261                 } else
262                         remove_file_from_cache(p->string);
263         }
264 }
265
266 static void create_base_index(const struct commit *current_head)
267 {
268         struct tree *tree;
269         struct unpack_trees_options opts;
270         struct tree_desc t;
271
272         if (!current_head) {
273                 discard_cache();
274                 return;
275         }
276
277         memset(&opts, 0, sizeof(opts));
278         opts.head_idx = 1;
279         opts.index_only = 1;
280         opts.merge = 1;
281         opts.src_index = &the_index;
282         opts.dst_index = &the_index;
283
284         opts.fn = oneway_merge;
285         tree = parse_tree_indirect(current_head->object.sha1);
286         if (!tree)
287                 die(_("failed to unpack HEAD tree object"));
288         parse_tree(tree);
289         init_tree_desc(&t, tree->buffer, tree->size);
290         if (unpack_trees(1, &t, &opts))
291                 exit(128); /* We've already reported the error, finish dying */
292 }
293
294 static void refresh_cache_or_die(int refresh_flags)
295 {
296         /*
297          * refresh_flags contains REFRESH_QUIET, so the only errors
298          * are for unmerged entries.
299          */
300         if (refresh_cache(refresh_flags | REFRESH_IN_PORCELAIN))
301                 die_resolve_conflict("commit");
302 }
303
304 static char *prepare_index(int argc, const char **argv, const char *prefix,
305                            const struct commit *current_head, int is_status)
306 {
307         int fd;
308         struct string_list partial;
309         struct pathspec pathspec;
310         int refresh_flags = REFRESH_QUIET;
311
312         if (is_status)
313                 refresh_flags |= REFRESH_UNMERGED;
314         parse_pathspec(&pathspec, 0,
315                        PATHSPEC_PREFER_FULL,
316                        prefix, argv);
317
318         if (read_cache_preload(&pathspec) < 0)
319                 die(_("index file corrupt"));
320
321         if (interactive) {
322                 char *old_index_env = NULL;
323                 fd = hold_locked_index(&index_lock, 1);
324
325                 refresh_cache_or_die(refresh_flags);
326
327                 if (write_cache(fd, active_cache, active_nr) ||
328                     close_lock_file(&index_lock))
329                         die(_("unable to create temporary index"));
330
331                 old_index_env = getenv(INDEX_ENVIRONMENT);
332                 setenv(INDEX_ENVIRONMENT, index_lock.filename, 1);
333
334                 if (interactive_add(argc, argv, prefix, patch_interactive) != 0)
335                         die(_("interactive add failed"));
336
337                 if (old_index_env && *old_index_env)
338                         setenv(INDEX_ENVIRONMENT, old_index_env, 1);
339                 else
340                         unsetenv(INDEX_ENVIRONMENT);
341
342                 discard_cache();
343                 read_cache_from(index_lock.filename);
344
345                 commit_style = COMMIT_NORMAL;
346                 return index_lock.filename;
347         }
348
349         /*
350          * Non partial, non as-is commit.
351          *
352          * (1) get the real index;
353          * (2) update the_index as necessary;
354          * (3) write the_index out to the real index (still locked);
355          * (4) return the name of the locked index file.
356          *
357          * The caller should run hooks on the locked real index, and
358          * (A) if all goes well, commit the real index;
359          * (B) on failure, rollback the real index.
360          */
361         if (all || (also && pathspec.nr)) {
362                 fd = hold_locked_index(&index_lock, 1);
363                 add_files_to_cache(also ? prefix : NULL, &pathspec, 0);
364                 refresh_cache_or_die(refresh_flags);
365                 update_main_cache_tree(WRITE_TREE_SILENT);
366                 if (write_cache(fd, active_cache, active_nr) ||
367                     close_lock_file(&index_lock))
368                         die(_("unable to write new_index file"));
369                 commit_style = COMMIT_NORMAL;
370                 return index_lock.filename;
371         }
372
373         /*
374          * As-is commit.
375          *
376          * (1) return the name of the real index file.
377          *
378          * The caller should run hooks on the real index,
379          * and create commit from the_index.
380          * We still need to refresh the index here.
381          */
382         if (!only && !pathspec.nr) {
383                 fd = hold_locked_index(&index_lock, 1);
384                 refresh_cache_or_die(refresh_flags);
385                 if (active_cache_changed) {
386                         update_main_cache_tree(WRITE_TREE_SILENT);
387                         if (write_cache(fd, active_cache, active_nr) ||
388                             commit_locked_index(&index_lock))
389                                 die(_("unable to write new_index file"));
390                 } else {
391                         rollback_lock_file(&index_lock);
392                 }
393                 commit_style = COMMIT_AS_IS;
394                 return get_index_file();
395         }
396
397         /*
398          * A partial commit.
399          *
400          * (0) find the set of affected paths;
401          * (1) get lock on the real index file;
402          * (2) update the_index with the given paths;
403          * (3) write the_index out to the real index (still locked);
404          * (4) get lock on the false index file;
405          * (5) reset the_index from HEAD;
406          * (6) update the_index the same way as (2);
407          * (7) write the_index out to the false index file;
408          * (8) return the name of the false index file (still locked);
409          *
410          * The caller should run hooks on the locked false index, and
411          * create commit from it.  Then
412          * (A) if all goes well, commit the real index;
413          * (B) on failure, rollback the real index;
414          * In either case, rollback the false index.
415          */
416         commit_style = COMMIT_PARTIAL;
417
418         if (whence != FROM_COMMIT) {
419                 if (whence == FROM_MERGE)
420                         die(_("cannot do a partial commit during a merge."));
421                 else if (whence == FROM_CHERRY_PICK)
422                         die(_("cannot do a partial commit during a cherry-pick."));
423         }
424
425         memset(&partial, 0, sizeof(partial));
426         partial.strdup_strings = 1;
427         if (list_paths(&partial, !current_head ? NULL : "HEAD", prefix, &pathspec))
428                 exit(1);
429
430         discard_cache();
431         if (read_cache() < 0)
432                 die(_("cannot read the index"));
433
434         fd = hold_locked_index(&index_lock, 1);
435         add_remove_files(&partial);
436         refresh_cache(REFRESH_QUIET);
437         if (write_cache(fd, active_cache, active_nr) ||
438             close_lock_file(&index_lock))
439                 die(_("unable to write new_index file"));
440
441         fd = hold_lock_file_for_update(&false_lock,
442                                        git_path("next-index-%"PRIuMAX,
443                                                 (uintmax_t) getpid()),
444                                        LOCK_DIE_ON_ERROR);
445
446         create_base_index(current_head);
447         add_remove_files(&partial);
448         refresh_cache(REFRESH_QUIET);
449
450         if (write_cache(fd, active_cache, active_nr) ||
451             close_lock_file(&false_lock))
452                 die(_("unable to write temporary index file"));
453
454         discard_cache();
455         read_cache_from(false_lock.filename);
456
457         return false_lock.filename;
458 }
459
460 static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn,
461                       struct wt_status *s)
462 {
463         unsigned char sha1[20];
464
465         if (s->relative_paths)
466                 s->prefix = prefix;
467
468         if (amend) {
469                 s->amend = 1;
470                 s->reference = "HEAD^1";
471         }
472         s->verbose = verbose;
473         s->index_file = index_file;
474         s->fp = fp;
475         s->nowarn = nowarn;
476         s->is_initial = get_sha1(s->reference, sha1) ? 1 : 0;
477
478         wt_status_collect(s);
479
480         switch (status_format) {
481         case STATUS_FORMAT_SHORT:
482                 wt_shortstatus_print(s);
483                 break;
484         case STATUS_FORMAT_PORCELAIN:
485                 wt_porcelain_print(s);
486                 break;
487         case STATUS_FORMAT_UNSPECIFIED:
488                 die("BUG: finalize_deferred_config() should have been called");
489                 break;
490         case STATUS_FORMAT_NONE:
491         case STATUS_FORMAT_LONG:
492                 wt_status_print(s);
493                 break;
494         }
495
496         return s->commitable;
497 }
498
499 static int is_a_merge(const struct commit *current_head)
500 {
501         return !!(current_head->parents && current_head->parents->next);
502 }
503
504 static void export_one(const char *var, const char *s, const char *e, int hack)
505 {
506         struct strbuf buf = STRBUF_INIT;
507         if (hack)
508                 strbuf_addch(&buf, hack);
509         strbuf_addf(&buf, "%.*s", (int)(e - s), s);
510         setenv(var, buf.buf, 1);
511         strbuf_release(&buf);
512 }
513
514 static int sane_ident_split(struct ident_split *person)
515 {
516         if (!person->name_begin || !person->name_end ||
517             person->name_begin == person->name_end)
518                 return 0; /* no human readable name */
519         if (!person->mail_begin || !person->mail_end ||
520             person->mail_begin == person->mail_end)
521                 return 0; /* no usable mail */
522         if (!person->date_begin || !person->date_end ||
523             !person->tz_begin || !person->tz_end)
524                 return 0;
525         return 1;
526 }
527
528 static void determine_author_info(struct strbuf *author_ident)
529 {
530         char *name, *email, *date;
531         struct ident_split author;
532
533         name = getenv("GIT_AUTHOR_NAME");
534         email = getenv("GIT_AUTHOR_EMAIL");
535         date = getenv("GIT_AUTHOR_DATE");
536
537         if (author_message) {
538                 const char *a, *lb, *rb, *eol;
539                 size_t len;
540
541                 a = strstr(author_message_buffer, "\nauthor ");
542                 if (!a)
543                         die(_("invalid commit: %s"), author_message);
544
545                 lb = strchrnul(a + strlen("\nauthor "), '<');
546                 rb = strchrnul(lb, '>');
547                 eol = strchrnul(rb, '\n');
548                 if (!*lb || !*rb || !*eol)
549                         die(_("invalid commit: %s"), author_message);
550
551                 if (lb == a + strlen("\nauthor "))
552                         /* \nauthor <foo@example.com> */
553                         name = xcalloc(1, 1);
554                 else
555                         name = xmemdupz(a + strlen("\nauthor "),
556                                         (lb - strlen(" ") -
557                                          (a + strlen("\nauthor "))));
558                 email = xmemdupz(lb + strlen("<"), rb - (lb + strlen("<")));
559                 len = eol - (rb + strlen("> "));
560                 date = xmalloc(len + 2);
561                 *date = '@';
562                 memcpy(date + 1, rb + strlen("> "), len);
563                 date[len + 1] = '\0';
564         }
565
566         if (force_author) {
567                 const char *lb = strstr(force_author, " <");
568                 const char *rb = strchr(force_author, '>');
569
570                 if (!lb || !rb)
571                         die(_("malformed --author parameter"));
572                 name = xstrndup(force_author, lb - force_author);
573                 email = xstrndup(lb + 2, rb - (lb + 2));
574         }
575
576         if (force_date)
577                 date = force_date;
578         strbuf_addstr(author_ident, fmt_ident(name, email, date, IDENT_STRICT));
579         if (!split_ident_line(&author, author_ident->buf, author_ident->len) &&
580             sane_ident_split(&author)) {
581                 export_one("GIT_AUTHOR_NAME", author.name_begin, author.name_end, 0);
582                 export_one("GIT_AUTHOR_EMAIL", author.mail_begin, author.mail_end, 0);
583                 export_one("GIT_AUTHOR_DATE", author.date_begin, author.tz_end, '@');
584         }
585 }
586
587 static char *cut_ident_timestamp_part(char *string)
588 {
589         char *ket = strrchr(string, '>');
590         if (!ket || ket[1] != ' ')
591                 die(_("Malformed ident string: '%s'"), string);
592         *++ket = '\0';
593         return ket;
594 }
595
596 static int prepare_to_commit(const char *index_file, const char *prefix,
597                              struct commit *current_head,
598                              struct wt_status *s,
599                              struct strbuf *author_ident)
600 {
601         struct stat statbuf;
602         struct strbuf committer_ident = STRBUF_INIT;
603         int commitable;
604         struct strbuf sb = STRBUF_INIT;
605         const char *hook_arg1 = NULL;
606         const char *hook_arg2 = NULL;
607         int clean_message_contents = (cleanup_mode != CLEANUP_NONE);
608         int old_display_comment_prefix;
609
610         /* This checks and barfs if author is badly specified */
611         determine_author_info(author_ident);
612
613         if (!no_verify && run_hook(index_file, "pre-commit", NULL))
614                 return 0;
615
616         if (squash_message) {
617                 /*
618                  * Insert the proper subject line before other commit
619                  * message options add their content.
620                  */
621                 if (use_message && !strcmp(use_message, squash_message))
622                         strbuf_addstr(&sb, "squash! ");
623                 else {
624                         struct pretty_print_context ctx = {0};
625                         struct commit *c;
626                         c = lookup_commit_reference_by_name(squash_message);
627                         if (!c)
628                                 die(_("could not lookup commit %s"), squash_message);
629                         ctx.output_encoding = get_commit_output_encoding();
630                         format_commit_message(c, "squash! %s\n\n", &sb,
631                                               &ctx);
632                 }
633         }
634
635         if (message.len) {
636                 strbuf_addbuf(&sb, &message);
637                 hook_arg1 = "message";
638         } else if (logfile && !strcmp(logfile, "-")) {
639                 if (isatty(0))
640                         fprintf(stderr, _("(reading log message from standard input)\n"));
641                 if (strbuf_read(&sb, 0, 0) < 0)
642                         die_errno(_("could not read log from standard input"));
643                 hook_arg1 = "message";
644         } else if (logfile) {
645                 if (strbuf_read_file(&sb, logfile, 0) < 0)
646                         die_errno(_("could not read log file '%s'"),
647                                   logfile);
648                 hook_arg1 = "message";
649         } else if (use_message) {
650                 char *buffer;
651                 buffer = strstr(use_message_buffer, "\n\n");
652                 if (!use_editor && (!buffer || buffer[2] == '\0'))
653                         die(_("commit has empty message"));
654                 strbuf_add(&sb, buffer + 2, strlen(buffer + 2));
655                 hook_arg1 = "commit";
656                 hook_arg2 = use_message;
657         } else if (fixup_message) {
658                 struct pretty_print_context ctx = {0};
659                 struct commit *commit;
660                 commit = lookup_commit_reference_by_name(fixup_message);
661                 if (!commit)
662                         die(_("could not lookup commit %s"), fixup_message);
663                 ctx.output_encoding = get_commit_output_encoding();
664                 format_commit_message(commit, "fixup! %s\n\n",
665                                       &sb, &ctx);
666                 hook_arg1 = "message";
667         } else if (!stat(git_path("MERGE_MSG"), &statbuf)) {
668                 if (strbuf_read_file(&sb, git_path("MERGE_MSG"), 0) < 0)
669                         die_errno(_("could not read MERGE_MSG"));
670                 hook_arg1 = "merge";
671         } else if (!stat(git_path("SQUASH_MSG"), &statbuf)) {
672                 if (strbuf_read_file(&sb, git_path("SQUASH_MSG"), 0) < 0)
673                         die_errno(_("could not read SQUASH_MSG"));
674                 hook_arg1 = "squash";
675         } else if (template_file) {
676                 if (strbuf_read_file(&sb, template_file, 0) < 0)
677                         die_errno(_("could not read '%s'"), template_file);
678                 hook_arg1 = "template";
679                 clean_message_contents = 0;
680         }
681
682         /*
683          * The remaining cases don't modify the template message, but
684          * just set the argument(s) to the prepare-commit-msg hook.
685          */
686         else if (whence == FROM_MERGE)
687                 hook_arg1 = "merge";
688         else if (whence == FROM_CHERRY_PICK) {
689                 hook_arg1 = "commit";
690                 hook_arg2 = "CHERRY_PICK_HEAD";
691         }
692
693         if (squash_message) {
694                 /*
695                  * If squash_commit was used for the commit subject,
696                  * then we're possibly hijacking other commit log options.
697                  * Reset the hook args to tell the real story.
698                  */
699                 hook_arg1 = "message";
700                 hook_arg2 = "";
701         }
702
703         s->fp = fopen(git_path(commit_editmsg), "w");
704         if (s->fp == NULL)
705                 die_errno(_("could not open '%s'"), git_path(commit_editmsg));
706
707         /* Ignore status.displayCommentPrefix: we do need comments in COMMIT_EDITMSG. */
708         old_display_comment_prefix = s->display_comment_prefix;
709         s->display_comment_prefix = 1;
710
711         /*
712          * Most hints are counter-productive when the commit has
713          * already started.
714          */
715         s->hints = 0;
716
717         if (clean_message_contents)
718                 stripspace(&sb, 0);
719
720         if (signoff) {
721                 /*
722                  * See if we have a Conflicts: block at the end. If yes, count
723                  * its size, so we can ignore it.
724                  */
725                 int ignore_footer = 0;
726                 int i, eol, previous = 0;
727                 const char *nl;
728
729                 for (i = 0; i < sb.len; i++) {
730                         nl = memchr(sb.buf + i, '\n', sb.len - i);
731                         if (nl)
732                                 eol = nl - sb.buf;
733                         else
734                                 eol = sb.len;
735                         if (starts_with(sb.buf + previous, "\nConflicts:\n")) {
736                                 ignore_footer = sb.len - previous;
737                                 break;
738                         }
739                         while (i < eol)
740                                 i++;
741                         previous = eol;
742                 }
743
744                 append_signoff(&sb, ignore_footer, 0);
745         }
746
747         if (fwrite(sb.buf, 1, sb.len, s->fp) < sb.len)
748                 die_errno(_("could not write commit template"));
749
750         strbuf_release(&sb);
751
752         /* This checks if committer ident is explicitly given */
753         strbuf_addstr(&committer_ident, git_committer_info(IDENT_STRICT));
754         if (use_editor && include_status) {
755                 int ident_shown = 0;
756                 int saved_color_setting;
757                 char *ai_tmp, *ci_tmp;
758                 if (whence != FROM_COMMIT)
759                         status_printf_ln(s, GIT_COLOR_NORMAL,
760                             whence == FROM_MERGE
761                                 ? _("\n"
762                                         "It looks like you may be committing a merge.\n"
763                                         "If this is not correct, please remove the file\n"
764                                         "       %s\n"
765                                         "and try again.\n")
766                                 : _("\n"
767                                         "It looks like you may be committing a cherry-pick.\n"
768                                         "If this is not correct, please remove the file\n"
769                                         "       %s\n"
770                                         "and try again.\n"),
771                                 git_path(whence == FROM_MERGE
772                                          ? "MERGE_HEAD"
773                                          : "CHERRY_PICK_HEAD"));
774
775                 fprintf(s->fp, "\n");
776                 if (cleanup_mode == CLEANUP_ALL)
777                         status_printf(s, GIT_COLOR_NORMAL,
778                                 _("Please enter the commit message for your changes."
779                                   " Lines starting\nwith '%c' will be ignored, and an empty"
780                                   " message aborts the commit.\n"), comment_line_char);
781                 else /* CLEANUP_SPACE, that is. */
782                         status_printf(s, GIT_COLOR_NORMAL,
783                                 _("Please enter the commit message for your changes."
784                                   " Lines starting\n"
785                                   "with '%c' will be kept; you may remove them"
786                                   " yourself if you want to.\n"
787                                   "An empty message aborts the commit.\n"), comment_line_char);
788                 if (only_include_assumed)
789                         status_printf_ln(s, GIT_COLOR_NORMAL,
790                                         "%s", only_include_assumed);
791
792                 ai_tmp = cut_ident_timestamp_part(author_ident->buf);
793                 ci_tmp = cut_ident_timestamp_part(committer_ident.buf);
794                 if (strcmp(author_ident->buf, committer_ident.buf))
795                         status_printf_ln(s, GIT_COLOR_NORMAL,
796                                 _("%s"
797                                 "Author:    %s"),
798                                 ident_shown++ ? "" : "\n",
799                                 author_ident->buf);
800
801                 if (!committer_ident_sufficiently_given())
802                         status_printf_ln(s, GIT_COLOR_NORMAL,
803                                 _("%s"
804                                 "Committer: %s"),
805                                 ident_shown++ ? "" : "\n",
806                                 committer_ident.buf);
807
808                 if (ident_shown)
809                         status_printf_ln(s, GIT_COLOR_NORMAL, "");
810
811                 saved_color_setting = s->use_color;
812                 s->use_color = 0;
813                 commitable = run_status(s->fp, index_file, prefix, 1, s);
814                 s->use_color = saved_color_setting;
815
816                 *ai_tmp = ' ';
817                 *ci_tmp = ' ';
818         } else {
819                 unsigned char sha1[20];
820                 const char *parent = "HEAD";
821
822                 if (!active_nr && read_cache() < 0)
823                         die(_("Cannot read index"));
824
825                 if (amend)
826                         parent = "HEAD^1";
827
828                 if (get_sha1(parent, sha1))
829                         commitable = !!active_nr;
830                 else
831                         commitable = index_differs_from(parent, 0);
832         }
833         strbuf_release(&committer_ident);
834
835         fclose(s->fp);
836
837         /*
838          * Reject an attempt to record a non-merge empty commit without
839          * explicit --allow-empty. In the cherry-pick case, it may be
840          * empty due to conflict resolution, which the user should okay.
841          */
842         if (!commitable && whence != FROM_MERGE && !allow_empty &&
843             !(amend && is_a_merge(current_head))) {
844                 s->display_comment_prefix = old_display_comment_prefix;
845                 run_status(stdout, index_file, prefix, 0, s);
846                 if (amend)
847                         fputs(_(empty_amend_advice), stderr);
848                 else if (whence == FROM_CHERRY_PICK) {
849                         fputs(_(empty_cherry_pick_advice), stderr);
850                         if (!sequencer_in_use)
851                                 fputs(_(empty_cherry_pick_advice_single), stderr);
852                         else
853                                 fputs(_(empty_cherry_pick_advice_multi), stderr);
854                 }
855                 return 0;
856         }
857
858         /*
859          * Re-read the index as pre-commit hook could have updated it,
860          * and write it out as a tree.  We must do this before we invoke
861          * the editor and after we invoke run_status above.
862          */
863         discard_cache();
864         read_cache_from(index_file);
865         if (update_main_cache_tree(0)) {
866                 error(_("Error building trees"));
867                 return 0;
868         }
869
870         if (run_hook(index_file, "prepare-commit-msg",
871                      git_path(commit_editmsg), hook_arg1, hook_arg2, NULL))
872                 return 0;
873
874         if (use_editor) {
875                 char index[PATH_MAX];
876                 const char *env[2] = { NULL };
877                 env[0] =  index;
878                 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
879                 if (launch_editor(git_path(commit_editmsg), NULL, env)) {
880                         fprintf(stderr,
881                         _("Please supply the message using either -m or -F option.\n"));
882                         exit(1);
883                 }
884         }
885
886         if (!no_verify &&
887             run_hook(index_file, "commit-msg", git_path(commit_editmsg), NULL)) {
888                 return 0;
889         }
890
891         return 1;
892 }
893
894 static int rest_is_empty(struct strbuf *sb, int start)
895 {
896         int i, eol;
897         const char *nl;
898
899         /* Check if the rest is just whitespace and Signed-of-by's. */
900         for (i = start; i < sb->len; i++) {
901                 nl = memchr(sb->buf + i, '\n', sb->len - i);
902                 if (nl)
903                         eol = nl - sb->buf;
904                 else
905                         eol = sb->len;
906
907                 if (strlen(sign_off_header) <= eol - i &&
908                     starts_with(sb->buf + i, sign_off_header)) {
909                         i = eol;
910                         continue;
911                 }
912                 while (i < eol)
913                         if (!isspace(sb->buf[i++]))
914                                 return 0;
915         }
916
917         return 1;
918 }
919
920 /*
921  * Find out if the message in the strbuf contains only whitespace and
922  * Signed-off-by lines.
923  */
924 static int message_is_empty(struct strbuf *sb)
925 {
926         if (cleanup_mode == CLEANUP_NONE && sb->len)
927                 return 0;
928         return rest_is_empty(sb, 0);
929 }
930
931 /*
932  * See if the user edited the message in the editor or left what
933  * was in the template intact
934  */
935 static int template_untouched(struct strbuf *sb)
936 {
937         struct strbuf tmpl = STRBUF_INIT;
938         char *start;
939
940         if (cleanup_mode == CLEANUP_NONE && sb->len)
941                 return 0;
942
943         if (!template_file || strbuf_read_file(&tmpl, template_file, 0) <= 0)
944                 return 0;
945
946         stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
947         start = (char *)skip_prefix(sb->buf, tmpl.buf);
948         if (!start)
949                 start = sb->buf;
950         strbuf_release(&tmpl);
951         return rest_is_empty(sb, start - sb->buf);
952 }
953
954 static const char *find_author_by_nickname(const char *name)
955 {
956         struct rev_info revs;
957         struct commit *commit;
958         struct strbuf buf = STRBUF_INIT;
959         struct string_list mailmap = STRING_LIST_INIT_NODUP;
960         const char *av[20];
961         int ac = 0;
962
963         init_revisions(&revs, NULL);
964         strbuf_addf(&buf, "--author=%s", name);
965         av[++ac] = "--all";
966         av[++ac] = "-i";
967         av[++ac] = buf.buf;
968         av[++ac] = NULL;
969         setup_revisions(ac, av, &revs, NULL);
970         revs.mailmap = &mailmap;
971         read_mailmap(revs.mailmap, NULL);
972
973         prepare_revision_walk(&revs);
974         commit = get_revision(&revs);
975         if (commit) {
976                 struct pretty_print_context ctx = {0};
977                 ctx.date_mode = DATE_NORMAL;
978                 strbuf_release(&buf);
979                 format_commit_message(commit, "%aN <%aE>", &buf, &ctx);
980                 clear_mailmap(&mailmap);
981                 return strbuf_detach(&buf, NULL);
982         }
983         die(_("No existing author found with '%s'"), name);
984 }
985
986
987 static void handle_untracked_files_arg(struct wt_status *s)
988 {
989         if (!untracked_files_arg)
990                 ; /* default already initialized */
991         else if (!strcmp(untracked_files_arg, "no"))
992                 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
993         else if (!strcmp(untracked_files_arg, "normal"))
994                 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
995         else if (!strcmp(untracked_files_arg, "all"))
996                 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
997         else
998                 die(_("Invalid untracked files mode '%s'"), untracked_files_arg);
999 }
1000
1001 static const char *read_commit_message(const char *name)
1002 {
1003         const char *out_enc;
1004         struct commit *commit;
1005
1006         commit = lookup_commit_reference_by_name(name);
1007         if (!commit)
1008                 die(_("could not lookup commit %s"), name);
1009         out_enc = get_commit_output_encoding();
1010         return logmsg_reencode(commit, NULL, out_enc);
1011 }
1012
1013 /*
1014  * Enumerate what needs to be propagated when --porcelain
1015  * is not in effect here.
1016  */
1017 static struct status_deferred_config {
1018         enum status_format status_format;
1019         int show_branch;
1020 } status_deferred_config = {
1021         STATUS_FORMAT_UNSPECIFIED,
1022         -1 /* unspecified */
1023 };
1024
1025 static void finalize_deferred_config(struct wt_status *s)
1026 {
1027         int use_deferred_config = (status_format != STATUS_FORMAT_PORCELAIN &&
1028                                    !s->null_termination);
1029
1030         if (s->null_termination) {
1031                 if (status_format == STATUS_FORMAT_NONE ||
1032                     status_format == STATUS_FORMAT_UNSPECIFIED)
1033                         status_format = STATUS_FORMAT_PORCELAIN;
1034                 else if (status_format == STATUS_FORMAT_LONG)
1035                         die(_("--long and -z are incompatible"));
1036         }
1037
1038         if (use_deferred_config && status_format == STATUS_FORMAT_UNSPECIFIED)
1039                 status_format = status_deferred_config.status_format;
1040         if (status_format == STATUS_FORMAT_UNSPECIFIED)
1041                 status_format = STATUS_FORMAT_NONE;
1042
1043         if (use_deferred_config && s->show_branch < 0)
1044                 s->show_branch = status_deferred_config.show_branch;
1045         if (s->show_branch < 0)
1046                 s->show_branch = 0;
1047 }
1048
1049 static int parse_and_validate_options(int argc, const char *argv[],
1050                                       const struct option *options,
1051                                       const char * const usage[],
1052                                       const char *prefix,
1053                                       struct commit *current_head,
1054                                       struct wt_status *s)
1055 {
1056         int f = 0;
1057
1058         argc = parse_options(argc, argv, prefix, options, usage, 0);
1059         finalize_deferred_config(s);
1060
1061         if (force_author && !strchr(force_author, '>'))
1062                 force_author = find_author_by_nickname(force_author);
1063
1064         if (force_author && renew_authorship)
1065                 die(_("Using both --reset-author and --author does not make sense"));
1066
1067         if (logfile || have_option_m || use_message || fixup_message)
1068                 use_editor = 0;
1069         if (0 <= edit_flag)
1070                 use_editor = edit_flag;
1071         if (!use_editor)
1072                 setenv("GIT_EDITOR", ":", 1);
1073
1074         /* Sanity check options */
1075         if (amend && !current_head)
1076                 die(_("You have nothing to amend."));
1077         if (amend && whence != FROM_COMMIT) {
1078                 if (whence == FROM_MERGE)
1079                         die(_("You are in the middle of a merge -- cannot amend."));
1080                 else if (whence == FROM_CHERRY_PICK)
1081                         die(_("You are in the middle of a cherry-pick -- cannot amend."));
1082         }
1083         if (fixup_message && squash_message)
1084                 die(_("Options --squash and --fixup cannot be used together"));
1085         if (use_message)
1086                 f++;
1087         if (edit_message)
1088                 f++;
1089         if (fixup_message)
1090                 f++;
1091         if (logfile)
1092                 f++;
1093         if (f > 1)
1094                 die(_("Only one of -c/-C/-F/--fixup can be used."));
1095         if (message.len && f > 0)
1096                 die((_("Option -m cannot be combined with -c/-C/-F/--fixup.")));
1097         if (f || message.len)
1098                 template_file = NULL;
1099         if (edit_message)
1100                 use_message = edit_message;
1101         if (amend && !use_message && !fixup_message)
1102                 use_message = "HEAD";
1103         if (!use_message && whence != FROM_CHERRY_PICK && renew_authorship)
1104                 die(_("--reset-author can be used only with -C, -c or --amend."));
1105         if (use_message) {
1106                 use_message_buffer = read_commit_message(use_message);
1107                 if (!renew_authorship) {
1108                         author_message = use_message;
1109                         author_message_buffer = use_message_buffer;
1110                 }
1111         }
1112         if (whence == FROM_CHERRY_PICK && !renew_authorship) {
1113                 author_message = "CHERRY_PICK_HEAD";
1114                 author_message_buffer = read_commit_message(author_message);
1115         }
1116
1117         if (patch_interactive)
1118                 interactive = 1;
1119
1120         if (also + only + all + interactive > 1)
1121                 die(_("Only one of --include/--only/--all/--interactive/--patch can be used."));
1122         if (argc == 0 && (also || (only && !amend)))
1123                 die(_("No paths with --include/--only does not make sense."));
1124         if (argc == 0 && only && amend)
1125                 only_include_assumed = _("Clever... amending the last one with dirty index.");
1126         if (argc > 0 && !also && !only)
1127                 only_include_assumed = _("Explicit paths specified without -i nor -o; assuming --only paths...");
1128         if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
1129                 cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
1130         else if (!strcmp(cleanup_arg, "verbatim"))
1131                 cleanup_mode = CLEANUP_NONE;
1132         else if (!strcmp(cleanup_arg, "whitespace"))
1133                 cleanup_mode = CLEANUP_SPACE;
1134         else if (!strcmp(cleanup_arg, "strip"))
1135                 cleanup_mode = CLEANUP_ALL;
1136         else
1137                 die(_("Invalid cleanup mode %s"), cleanup_arg);
1138
1139         handle_untracked_files_arg(s);
1140
1141         if (all && argc > 0)
1142                 die(_("Paths with -a does not make sense."));
1143
1144         if (status_format != STATUS_FORMAT_NONE)
1145                 dry_run = 1;
1146
1147         return argc;
1148 }
1149
1150 static int dry_run_commit(int argc, const char **argv, const char *prefix,
1151                           const struct commit *current_head, struct wt_status *s)
1152 {
1153         int commitable;
1154         const char *index_file;
1155
1156         index_file = prepare_index(argc, argv, prefix, current_head, 1);
1157         commitable = run_status(stdout, index_file, prefix, 0, s);
1158         rollback_index_files();
1159
1160         return commitable ? 0 : 1;
1161 }
1162
1163 static int parse_status_slot(const char *var, int offset)
1164 {
1165         if (!strcasecmp(var+offset, "header"))
1166                 return WT_STATUS_HEADER;
1167         if (!strcasecmp(var+offset, "branch"))
1168                 return WT_STATUS_ONBRANCH;
1169         if (!strcasecmp(var+offset, "updated")
1170                 || !strcasecmp(var+offset, "added"))
1171                 return WT_STATUS_UPDATED;
1172         if (!strcasecmp(var+offset, "changed"))
1173                 return WT_STATUS_CHANGED;
1174         if (!strcasecmp(var+offset, "untracked"))
1175                 return WT_STATUS_UNTRACKED;
1176         if (!strcasecmp(var+offset, "nobranch"))
1177                 return WT_STATUS_NOBRANCH;
1178         if (!strcasecmp(var+offset, "unmerged"))
1179                 return WT_STATUS_UNMERGED;
1180         return -1;
1181 }
1182
1183 static int git_status_config(const char *k, const char *v, void *cb)
1184 {
1185         struct wt_status *s = cb;
1186
1187         if (starts_with(k, "column."))
1188                 return git_column_config(k, v, "status", &s->colopts);
1189         if (!strcmp(k, "status.submodulesummary")) {
1190                 int is_bool;
1191                 s->submodule_summary = git_config_bool_or_int(k, v, &is_bool);
1192                 if (is_bool && s->submodule_summary)
1193                         s->submodule_summary = -1;
1194                 return 0;
1195         }
1196         if (!strcmp(k, "status.short")) {
1197                 if (git_config_bool(k, v))
1198                         status_deferred_config.status_format = STATUS_FORMAT_SHORT;
1199                 else
1200                         status_deferred_config.status_format = STATUS_FORMAT_NONE;
1201                 return 0;
1202         }
1203         if (!strcmp(k, "status.branch")) {
1204                 status_deferred_config.show_branch = git_config_bool(k, v);
1205                 return 0;
1206         }
1207         if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
1208                 s->use_color = git_config_colorbool(k, v);
1209                 return 0;
1210         }
1211         if (!strcmp(k, "status.displaycommentprefix")) {
1212                 s->display_comment_prefix = git_config_bool(k, v);
1213                 return 0;
1214         }
1215         if (starts_with(k, "status.color.") || starts_with(k, "color.status.")) {
1216                 int slot = parse_status_slot(k, 13);
1217                 if (slot < 0)
1218                         return 0;
1219                 if (!v)
1220                         return config_error_nonbool(k);
1221                 color_parse(v, k, s->color_palette[slot]);
1222                 return 0;
1223         }
1224         if (!strcmp(k, "status.relativepaths")) {
1225                 s->relative_paths = git_config_bool(k, v);
1226                 return 0;
1227         }
1228         if (!strcmp(k, "status.showuntrackedfiles")) {
1229                 if (!v)
1230                         return config_error_nonbool(k);
1231                 else if (!strcmp(v, "no"))
1232                         s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1233                 else if (!strcmp(v, "normal"))
1234                         s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1235                 else if (!strcmp(v, "all"))
1236                         s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1237                 else
1238                         return error(_("Invalid untracked files mode '%s'"), v);
1239                 return 0;
1240         }
1241         return git_diff_ui_config(k, v, NULL);
1242 }
1243
1244 int cmd_status(int argc, const char **argv, const char *prefix)
1245 {
1246         static struct wt_status s;
1247         int fd;
1248         unsigned char sha1[20];
1249         static struct option builtin_status_options[] = {
1250                 OPT__VERBOSE(&verbose, N_("be verbose")),
1251                 OPT_SET_INT('s', "short", &status_format,
1252                             N_("show status concisely"), STATUS_FORMAT_SHORT),
1253                 OPT_BOOL('b', "branch", &s.show_branch,
1254                          N_("show branch information")),
1255                 OPT_SET_INT(0, "porcelain", &status_format,
1256                             N_("machine-readable output"),
1257                             STATUS_FORMAT_PORCELAIN),
1258                 OPT_SET_INT(0, "long", &status_format,
1259                             N_("show status in long format (default)"),
1260                             STATUS_FORMAT_LONG),
1261                 OPT_BOOL('z', "null", &s.null_termination,
1262                          N_("terminate entries with NUL")),
1263                 { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg,
1264                   N_("mode"),
1265                   N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1266                   PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1267                 OPT_BOOL(0, "ignored", &show_ignored_in_status,
1268                          N_("show ignored files")),
1269                 { OPTION_STRING, 0, "ignore-submodules", &ignore_submodule_arg, N_("when"),
1270                   N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
1271                   PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1272                 OPT_COLUMN(0, "column", &s.colopts, N_("list untracked files in columns")),
1273                 OPT_END(),
1274         };
1275
1276         if (argc == 2 && !strcmp(argv[1], "-h"))
1277                 usage_with_options(builtin_status_usage, builtin_status_options);
1278
1279         status_init_config(&s, git_status_config);
1280         argc = parse_options(argc, argv, prefix,
1281                              builtin_status_options,
1282                              builtin_status_usage, 0);
1283         finalize_colopts(&s.colopts, -1);
1284         finalize_deferred_config(&s);
1285
1286         handle_untracked_files_arg(&s);
1287         if (show_ignored_in_status)
1288                 s.show_ignored_files = 1;
1289         parse_pathspec(&s.pathspec, 0,
1290                        PATHSPEC_PREFER_FULL,
1291                        prefix, argv);
1292
1293         read_cache_preload(&s.pathspec);
1294         refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, &s.pathspec, NULL, NULL);
1295
1296         fd = hold_locked_index(&index_lock, 0);
1297         if (0 <= fd)
1298                 update_index_if_able(&the_index, &index_lock);
1299
1300         s.is_initial = get_sha1(s.reference, sha1) ? 1 : 0;
1301         s.ignore_submodule_arg = ignore_submodule_arg;
1302         wt_status_collect(&s);
1303
1304         if (s.relative_paths)
1305                 s.prefix = prefix;
1306
1307         switch (status_format) {
1308         case STATUS_FORMAT_SHORT:
1309                 wt_shortstatus_print(&s);
1310                 break;
1311         case STATUS_FORMAT_PORCELAIN:
1312                 wt_porcelain_print(&s);
1313                 break;
1314         case STATUS_FORMAT_UNSPECIFIED:
1315                 die("BUG: finalize_deferred_config() should have been called");
1316                 break;
1317         case STATUS_FORMAT_NONE:
1318         case STATUS_FORMAT_LONG:
1319                 s.verbose = verbose;
1320                 s.ignore_submodule_arg = ignore_submodule_arg;
1321                 wt_status_print(&s);
1322                 break;
1323         }
1324         return 0;
1325 }
1326
1327 static void print_summary(const char *prefix, const unsigned char *sha1,
1328                           int initial_commit)
1329 {
1330         struct rev_info rev;
1331         struct commit *commit;
1332         struct strbuf format = STRBUF_INIT;
1333         unsigned char junk_sha1[20];
1334         const char *head;
1335         struct pretty_print_context pctx = {0};
1336         struct strbuf author_ident = STRBUF_INIT;
1337         struct strbuf committer_ident = STRBUF_INIT;
1338
1339         commit = lookup_commit(sha1);
1340         if (!commit)
1341                 die(_("couldn't look up newly created commit"));
1342         if (parse_commit(commit))
1343                 die(_("could not parse newly created commit"));
1344
1345         strbuf_addstr(&format, "format:%h] %s");
1346
1347         format_commit_message(commit, "%an <%ae>", &author_ident, &pctx);
1348         format_commit_message(commit, "%cn <%ce>", &committer_ident, &pctx);
1349         if (strbuf_cmp(&author_ident, &committer_ident)) {
1350                 strbuf_addstr(&format, "\n Author: ");
1351                 strbuf_addbuf_percentquote(&format, &author_ident);
1352         }
1353         if (!committer_ident_sufficiently_given()) {
1354                 strbuf_addstr(&format, "\n Committer: ");
1355                 strbuf_addbuf_percentquote(&format, &committer_ident);
1356                 if (advice_implicit_identity) {
1357                         strbuf_addch(&format, '\n');
1358                         strbuf_addstr(&format, _(implicit_ident_advice));
1359                 }
1360         }
1361         strbuf_release(&author_ident);
1362         strbuf_release(&committer_ident);
1363
1364         init_revisions(&rev, prefix);
1365         setup_revisions(0, NULL, &rev, NULL);
1366
1367         rev.diff = 1;
1368         rev.diffopt.output_format =
1369                 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
1370
1371         rev.verbose_header = 1;
1372         rev.show_root_diff = 1;
1373         get_commit_format(format.buf, &rev);
1374         rev.always_show_header = 0;
1375         rev.diffopt.detect_rename = 1;
1376         rev.diffopt.break_opt = 0;
1377         diff_setup_done(&rev.diffopt);
1378
1379         head = resolve_ref_unsafe("HEAD", junk_sha1, 0, NULL);
1380         printf("[%s%s ",
1381                 starts_with(head, "refs/heads/") ?
1382                         head + 11 :
1383                         !strcmp(head, "HEAD") ?
1384                                 _("detached HEAD") :
1385                                 head,
1386                 initial_commit ? _(" (root-commit)") : "");
1387
1388         if (!log_tree_commit(&rev, commit)) {
1389                 rev.always_show_header = 1;
1390                 rev.use_terminator = 1;
1391                 log_tree_commit(&rev, commit);
1392         }
1393
1394         strbuf_release(&format);
1395 }
1396
1397 static int git_commit_config(const char *k, const char *v, void *cb)
1398 {
1399         struct wt_status *s = cb;
1400         int status;
1401
1402         if (!strcmp(k, "commit.template"))
1403                 return git_config_pathname(&template_file, k, v);
1404         if (!strcmp(k, "commit.status")) {
1405                 include_status = git_config_bool(k, v);
1406                 return 0;
1407         }
1408         if (!strcmp(k, "commit.cleanup"))
1409                 return git_config_string(&cleanup_arg, k, v);
1410         if (!strcmp(k, "commit.gpgsign")) {
1411                 sign_commit = git_config_bool(k, v) ? "" : NULL;
1412                 return 0;
1413         }
1414
1415         status = git_gpg_config(k, v, NULL);
1416         if (status)
1417                 return status;
1418         return git_status_config(k, v, s);
1419 }
1420
1421 static int run_rewrite_hook(const unsigned char *oldsha1,
1422                             const unsigned char *newsha1)
1423 {
1424         /* oldsha1 SP newsha1 LF NUL */
1425         static char buf[2*40 + 3];
1426         struct child_process proc;
1427         const char *argv[3];
1428         int code;
1429         size_t n;
1430
1431         argv[0] = find_hook("post-rewrite");
1432         if (!argv[0])
1433                 return 0;
1434
1435         argv[1] = "amend";
1436         argv[2] = NULL;
1437
1438         memset(&proc, 0, sizeof(proc));
1439         proc.argv = argv;
1440         proc.in = -1;
1441         proc.stdout_to_stderr = 1;
1442
1443         code = start_command(&proc);
1444         if (code)
1445                 return code;
1446         n = snprintf(buf, sizeof(buf), "%s %s\n",
1447                      sha1_to_hex(oldsha1), sha1_to_hex(newsha1));
1448         write_in_full(proc.in, buf, n);
1449         close(proc.in);
1450         return finish_command(&proc);
1451 }
1452
1453 int cmd_commit(int argc, const char **argv, const char *prefix)
1454 {
1455         static struct wt_status s;
1456         static struct option builtin_commit_options[] = {
1457                 OPT__QUIET(&quiet, N_("suppress summary after successful commit")),
1458                 OPT__VERBOSE(&verbose, N_("show diff in commit message template")),
1459
1460                 OPT_GROUP(N_("Commit message options")),
1461                 OPT_FILENAME('F', "file", &logfile, N_("read message from file")),
1462                 OPT_STRING(0, "author", &force_author, N_("author"), N_("override author for commit")),
1463                 OPT_STRING(0, "date", &force_date, N_("date"), N_("override date for commit")),
1464                 OPT_CALLBACK('m', "message", &message, N_("message"), N_("commit message"), opt_parse_m),
1465                 OPT_STRING('c', "reedit-message", &edit_message, N_("commit"), N_("reuse and edit message from specified commit")),
1466                 OPT_STRING('C', "reuse-message", &use_message, N_("commit"), N_("reuse message from specified commit")),
1467                 OPT_STRING(0, "fixup", &fixup_message, N_("commit"), N_("use autosquash formatted message to fixup specified commit")),
1468                 OPT_STRING(0, "squash", &squash_message, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
1469                 OPT_BOOL(0, "reset-author", &renew_authorship, N_("the commit is authored by me now (used with -C/-c/--amend)")),
1470                 OPT_BOOL('s', "signoff", &signoff, N_("add Signed-off-by:")),
1471                 OPT_FILENAME('t', "template", &template_file, N_("use specified template file")),
1472                 OPT_BOOL('e', "edit", &edit_flag, N_("force edit of commit")),
1473                 OPT_STRING(0, "cleanup", &cleanup_arg, N_("default"), N_("how to strip spaces and #comments from message")),
1474                 OPT_BOOL(0, "status", &include_status, N_("include status in commit message template")),
1475                 { OPTION_STRING, 'S', "gpg-sign", &sign_commit, N_("key id"),
1476                   N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
1477                 /* end commit message options */
1478
1479                 OPT_GROUP(N_("Commit contents options")),
1480                 OPT_BOOL('a', "all", &all, N_("commit all changed files")),
1481                 OPT_BOOL('i', "include", &also, N_("add specified files to index for commit")),
1482                 OPT_BOOL(0, "interactive", &interactive, N_("interactively add files")),
1483                 OPT_BOOL('p', "patch", &patch_interactive, N_("interactively add changes")),
1484                 OPT_BOOL('o', "only", &only, N_("commit only specified files")),
1485                 OPT_BOOL('n', "no-verify", &no_verify, N_("bypass pre-commit hook")),
1486                 OPT_BOOL(0, "dry-run", &dry_run, N_("show what would be committed")),
1487                 OPT_SET_INT(0, "short", &status_format, N_("show status concisely"),
1488                             STATUS_FORMAT_SHORT),
1489                 OPT_BOOL(0, "branch", &s.show_branch, N_("show branch information")),
1490                 OPT_SET_INT(0, "porcelain", &status_format,
1491                             N_("machine-readable output"), STATUS_FORMAT_PORCELAIN),
1492                 OPT_SET_INT(0, "long", &status_format,
1493                             N_("show status in long format (default)"),
1494                             STATUS_FORMAT_LONG),
1495                 OPT_BOOL('z', "null", &s.null_termination,
1496                          N_("terminate entries with NUL")),
1497                 OPT_BOOL(0, "amend", &amend, N_("amend previous commit")),
1498                 OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite, N_("bypass post-rewrite hook")),
1499                 { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg, N_("mode"), N_("show untracked files, optional modes: all, normal, no. (Default: all)"), PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1500                 /* end commit contents options */
1501
1502                 OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty,
1503                                 N_("ok to record an empty change")),
1504                 OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message,
1505                                 N_("ok to record a change with an empty message")),
1506
1507                 OPT_END()
1508         };
1509
1510         struct strbuf sb = STRBUF_INIT;
1511         struct strbuf author_ident = STRBUF_INIT;
1512         const char *index_file, *reflog_msg;
1513         char *nl;
1514         unsigned char sha1[20];
1515         struct ref_lock *ref_lock;
1516         struct commit_list *parents = NULL, **pptr = &parents;
1517         struct stat statbuf;
1518         struct commit *current_head = NULL;
1519         struct commit_extra_header *extra = NULL;
1520
1521         if (argc == 2 && !strcmp(argv[1], "-h"))
1522                 usage_with_options(builtin_commit_usage, builtin_commit_options);
1523
1524         status_init_config(&s, git_commit_config);
1525         status_format = STATUS_FORMAT_NONE; /* Ignore status.short */
1526         s.colopts = 0;
1527
1528         if (get_sha1("HEAD", sha1))
1529                 current_head = NULL;
1530         else {
1531                 current_head = lookup_commit_or_die(sha1, "HEAD");
1532                 if (parse_commit(current_head))
1533                         die(_("could not parse HEAD commit"));
1534         }
1535         argc = parse_and_validate_options(argc, argv, builtin_commit_options,
1536                                           builtin_commit_usage,
1537                                           prefix, current_head, &s);
1538         if (dry_run)
1539                 return dry_run_commit(argc, argv, prefix, current_head, &s);
1540         index_file = prepare_index(argc, argv, prefix, current_head, 0);
1541
1542         /* Set up everything for writing the commit object.  This includes
1543            running hooks, writing the trees, and interacting with the user.  */
1544         if (!prepare_to_commit(index_file, prefix,
1545                                current_head, &s, &author_ident)) {
1546                 rollback_index_files();
1547                 return 1;
1548         }
1549
1550         /* Determine parents */
1551         reflog_msg = getenv("GIT_REFLOG_ACTION");
1552         if (!current_head) {
1553                 if (!reflog_msg)
1554                         reflog_msg = "commit (initial)";
1555         } else if (amend) {
1556                 struct commit_list *c;
1557
1558                 if (!reflog_msg)
1559                         reflog_msg = "commit (amend)";
1560                 for (c = current_head->parents; c; c = c->next)
1561                         pptr = &commit_list_insert(c->item, pptr)->next;
1562         } else if (whence == FROM_MERGE) {
1563                 struct strbuf m = STRBUF_INIT;
1564                 FILE *fp;
1565                 int allow_fast_forward = 1;
1566
1567                 if (!reflog_msg)
1568                         reflog_msg = "commit (merge)";
1569                 pptr = &commit_list_insert(current_head, pptr)->next;
1570                 fp = fopen(git_path("MERGE_HEAD"), "r");
1571                 if (fp == NULL)
1572                         die_errno(_("could not open '%s' for reading"),
1573                                   git_path("MERGE_HEAD"));
1574                 while (strbuf_getline(&m, fp, '\n') != EOF) {
1575                         struct commit *parent;
1576
1577                         parent = get_merge_parent(m.buf);
1578                         if (!parent)
1579                                 die(_("Corrupt MERGE_HEAD file (%s)"), m.buf);
1580                         pptr = &commit_list_insert(parent, pptr)->next;
1581                 }
1582                 fclose(fp);
1583                 strbuf_release(&m);
1584                 if (!stat(git_path("MERGE_MODE"), &statbuf)) {
1585                         if (strbuf_read_file(&sb, git_path("MERGE_MODE"), 0) < 0)
1586                                 die_errno(_("could not read MERGE_MODE"));
1587                         if (!strcmp(sb.buf, "no-ff"))
1588                                 allow_fast_forward = 0;
1589                 }
1590                 if (allow_fast_forward)
1591                         parents = reduce_heads(parents);
1592         } else {
1593                 if (!reflog_msg)
1594                         reflog_msg = (whence == FROM_CHERRY_PICK)
1595                                         ? "commit (cherry-pick)"
1596                                         : "commit";
1597                 pptr = &commit_list_insert(current_head, pptr)->next;
1598         }
1599
1600         /* Finally, get the commit message */
1601         strbuf_reset(&sb);
1602         if (strbuf_read_file(&sb, git_path(commit_editmsg), 0) < 0) {
1603                 int saved_errno = errno;
1604                 rollback_index_files();
1605                 die(_("could not read commit message: %s"), strerror(saved_errno));
1606         }
1607
1608         /* Truncate the message just before the diff, if any. */
1609         if (verbose)
1610                 wt_status_truncate_message_at_cut_line(&sb);
1611
1612         if (cleanup_mode != CLEANUP_NONE)
1613                 stripspace(&sb, cleanup_mode == CLEANUP_ALL);
1614         if (template_untouched(&sb) && !allow_empty_message) {
1615                 rollback_index_files();
1616                 fprintf(stderr, _("Aborting commit; you did not edit the message.\n"));
1617                 exit(1);
1618         }
1619         if (message_is_empty(&sb) && !allow_empty_message) {
1620                 rollback_index_files();
1621                 fprintf(stderr, _("Aborting commit due to empty commit message.\n"));
1622                 exit(1);
1623         }
1624
1625         if (amend) {
1626                 const char *exclude_gpgsig[2] = { "gpgsig", NULL };
1627                 extra = read_commit_extra_headers(current_head, exclude_gpgsig);
1628         } else {
1629                 struct commit_extra_header **tail = &extra;
1630                 append_merge_tag_headers(parents, &tail);
1631         }
1632
1633         if (commit_tree_extended(&sb, active_cache_tree->sha1, parents, sha1,
1634                                  author_ident.buf, sign_commit, extra)) {
1635                 rollback_index_files();
1636                 die(_("failed to write commit object"));
1637         }
1638         strbuf_release(&author_ident);
1639         free_commit_extra_headers(extra);
1640
1641         ref_lock = lock_any_ref_for_update("HEAD",
1642                                            !current_head
1643                                            ? NULL
1644                                            : current_head->object.sha1,
1645                                            0, NULL);
1646
1647         nl = strchr(sb.buf, '\n');
1648         if (nl)
1649                 strbuf_setlen(&sb, nl + 1 - sb.buf);
1650         else
1651                 strbuf_addch(&sb, '\n');
1652         strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
1653         strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
1654
1655         if (!ref_lock) {
1656                 rollback_index_files();
1657                 die(_("cannot lock HEAD ref"));
1658         }
1659         if (write_ref_sha1(ref_lock, sha1, sb.buf) < 0) {
1660                 rollback_index_files();
1661                 die(_("cannot update HEAD ref"));
1662         }
1663
1664         unlink(git_path("CHERRY_PICK_HEAD"));
1665         unlink(git_path("REVERT_HEAD"));
1666         unlink(git_path("MERGE_HEAD"));
1667         unlink(git_path("MERGE_MSG"));
1668         unlink(git_path("MERGE_MODE"));
1669         unlink(git_path("SQUASH_MSG"));
1670
1671         if (commit_index_files())
1672                 die (_("Repository has been updated, but unable to write\n"
1673                      "new_index file. Check that disk is not full or quota is\n"
1674                      "not exceeded, and then \"git reset HEAD\" to recover."));
1675
1676         rerere(0);
1677         run_hook(get_index_file(), "post-commit", NULL);
1678         if (amend && !no_post_rewrite) {
1679                 struct notes_rewrite_cfg *cfg;
1680                 cfg = init_copy_notes_for_rewrite("amend");
1681                 if (cfg) {
1682                         /* we are amending, so current_head is not NULL */
1683                         copy_note_for_rewrite(cfg, current_head->object.sha1, sha1);
1684                         finish_copy_notes_for_rewrite(cfg, "Notes added by 'git commit --amend'");
1685                 }
1686                 run_rewrite_hook(current_head->object.sha1, sha1);
1687         }
1688         if (!quiet)
1689                 print_summary(prefix, sha1, !current_head);
1690
1691         return 0;
1692 }