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