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