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