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