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