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