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