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