4 * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>
5 * Based on git-commit.sh by Junio C Hamano and Linus Torvalds
8 #define USE_THE_INDEX_COMPATIBILITY_MACROS
12 #include "cache-tree.h"
20 #include "wt-status.h"
21 #include "run-command.h"
27 #include "parse-options.h"
28 #include "string-list.h"
30 #include "unpack-trees.h"
32 #include "submodule.h"
33 #include "gpg-interface.h"
35 #include "sequencer.h"
38 #include "commit-reach.h"
39 #include "commit-graph.h"
41 static const char * const builtin_commit_usage
[] = {
42 N_("git commit [<options>] [--] <pathspec>..."),
46 static const char * const builtin_status_usage
[] = {
47 N_("git status [<options>] [--] <pathspec>..."),
51 static const char empty_amend_advice
[] =
52 N_("You asked to amend the most recent commit, but doing so would make\n"
53 "it empty. You can repeat your command with --allow-empty, or you can\n"
54 "remove the commit entirely with \"git reset HEAD^\".\n");
56 static const char empty_cherry_pick_advice
[] =
57 N_("The previous cherry-pick is now empty, possibly due to conflict resolution.\n"
58 "If you wish to commit it anyway, use:\n"
60 " git commit --allow-empty\n"
63 static const char empty_rebase_pick_advice
[] =
64 N_("Otherwise, please use 'git rebase --skip'\n");
66 static const char empty_cherry_pick_advice_single
[] =
67 N_("Otherwise, please use 'git cherry-pick --skip'\n");
69 static const char empty_cherry_pick_advice_multi
[] =
72 " git cherry-pick --continue\n"
74 "to resume cherry-picking the remaining commits.\n"
75 "If you wish to skip this commit, use:\n"
77 " git cherry-pick --skip\n"
80 static const char *color_status_slots
[] = {
81 [WT_STATUS_HEADER
] = "header",
82 [WT_STATUS_UPDATED
] = "updated",
83 [WT_STATUS_CHANGED
] = "changed",
84 [WT_STATUS_UNTRACKED
] = "untracked",
85 [WT_STATUS_NOBRANCH
] = "noBranch",
86 [WT_STATUS_UNMERGED
] = "unmerged",
87 [WT_STATUS_LOCAL_BRANCH
] = "localBranch",
88 [WT_STATUS_REMOTE_BRANCH
] = "remoteBranch",
89 [WT_STATUS_ONBRANCH
] = "branch",
92 static const char *use_message_buffer
;
93 static struct lock_file index_lock
; /* real index */
94 static struct lock_file false_lock
; /* used only for partial commits */
101 static const char *logfile
, *force_author
;
102 static const char *template_file
;
104 * The _message variables are commit names from which to take
105 * the commit message and/or authorship.
107 static const char *author_message
, *author_message_buffer
;
108 static char *edit_message
, *use_message
;
109 static char *fixup_message
, *fixup_commit
, *squash_message
;
110 static const char *fixup_prefix
;
111 static int all
, also
, interactive
, patch_interactive
, only
, amend
, signoff
;
112 static int edit_flag
= -1; /* unspecified */
113 static int quiet
, verbose
, no_verify
, allow_empty
, dry_run
, renew_authorship
;
114 static int config_commit_verbose
= -1; /* unspecified */
115 static int no_post_rewrite
, allow_empty_message
, pathspec_file_nul
;
116 static char *untracked_files_arg
, *force_date
, *ignore_submodule_arg
, *ignored_arg
;
117 static char *sign_commit
, *pathspec_from_file
;
118 static struct strvec trailer_args
= STRVEC_INIT
;
121 * The default commit message cleanup mode will remove the lines
122 * beginning with # (shell comments) and leading and trailing
123 * whitespaces (empty lines or containing only whitespaces)
124 * if editor is used, and only the whitespaces if the message
125 * is specified explicitly.
127 static enum commit_msg_cleanup_mode cleanup_mode
;
128 static const char *cleanup_arg
;
130 static enum commit_whence whence
;
131 static int use_editor
= 1, include_status
= 1;
132 static int have_option_m
;
133 static struct strbuf message
= STRBUF_INIT
;
135 static enum wt_status_format status_format
= STATUS_FORMAT_UNSPECIFIED
;
137 static int opt_pass_trailer(const struct option
*opt
, const char *arg
, int unset
)
139 BUG_ON_OPT_NEG(unset
);
141 strvec_pushl(&trailer_args
, "--trailer", arg
, NULL
);
145 static int opt_parse_porcelain(const struct option
*opt
, const char *arg
, int unset
)
147 enum wt_status_format
*value
= (enum wt_status_format
*)opt
->value
;
149 *value
= STATUS_FORMAT_NONE
;
151 *value
= STATUS_FORMAT_PORCELAIN
;
152 else if (!strcmp(arg
, "v1") || !strcmp(arg
, "1"))
153 *value
= STATUS_FORMAT_PORCELAIN
;
154 else if (!strcmp(arg
, "v2") || !strcmp(arg
, "2"))
155 *value
= STATUS_FORMAT_PORCELAIN_V2
;
157 die("unsupported porcelain version '%s'", arg
);
162 static int opt_parse_m(const struct option
*opt
, const char *arg
, int unset
)
164 struct strbuf
*buf
= opt
->value
;
167 strbuf_setlen(buf
, 0);
171 strbuf_addch(buf
, '\n');
172 strbuf_addstr(buf
, arg
);
173 strbuf_complete_line(buf
);
178 static int opt_parse_rename_score(const struct option
*opt
, const char *arg
, int unset
)
180 const char **value
= opt
->value
;
182 BUG_ON_OPT_NEG(unset
);
184 if (arg
!= NULL
&& *arg
== '=')
191 static void determine_whence(struct wt_status
*s
)
193 if (file_exists(git_path_merge_head(the_repository
)))
195 else if (!sequencer_determine_whence(the_repository
, &whence
))
196 whence
= FROM_COMMIT
;
201 static void status_init_config(struct wt_status
*s
, config_fn_t fn
)
203 wt_status_prepare(the_repository
, s
);
204 init_diff_ui_defaults();
207 s
->hints
= advice_enabled(ADVICE_STATUS_HINTS
); /* must come after git_config() */
210 static void rollback_index_files(void)
212 switch (commit_style
) {
214 break; /* nothing to do */
216 rollback_lock_file(&index_lock
);
219 rollback_lock_file(&index_lock
);
220 rollback_lock_file(&false_lock
);
225 static int commit_index_files(void)
229 switch (commit_style
) {
231 break; /* nothing to do */
233 err
= commit_lock_file(&index_lock
);
236 err
= commit_lock_file(&index_lock
);
237 rollback_lock_file(&false_lock
);
245 * Take a union of paths in the index and the named tree (typically, "HEAD"),
246 * and return the paths that match the given pattern in list.
248 static int list_paths(struct string_list
*list
, const char *with_tree
,
249 const struct pathspec
*pattern
)
257 m
= xcalloc(1, pattern
->nr
);
260 char *max_prefix
= common_prefix(pattern
);
261 overlay_tree_on_index(&the_index
, with_tree
, max_prefix
);
265 /* TODO: audit for interaction with sparse-index. */
266 ensure_full_index(&the_index
);
267 for (i
= 0; i
< active_nr
; i
++) {
268 const struct cache_entry
*ce
= active_cache
[i
];
269 struct string_list_item
*item
;
271 if (ce
->ce_flags
& CE_UPDATE
)
273 if (!ce_path_match(&the_index
, ce
, pattern
, m
))
275 item
= string_list_insert(list
, ce
->name
);
276 if (ce_skip_worktree(ce
))
277 item
->util
= item
; /* better a valid pointer than a fake one */
280 ret
= report_path_error(m
, pattern
);
285 static void add_remove_files(struct string_list
*list
)
288 for (i
= 0; i
< list
->nr
; i
++) {
290 struct string_list_item
*p
= &(list
->items
[i
]);
292 /* p->util is skip-worktree */
296 if (!lstat(p
->string
, &st
)) {
297 if (add_to_cache(p
->string
, &st
, 0))
298 die(_("updating files failed"));
300 remove_file_from_cache(p
->string
);
304 static void create_base_index(const struct commit
*current_head
)
307 struct unpack_trees_options opts
;
315 memset(&opts
, 0, sizeof(opts
));
319 opts
.src_index
= &the_index
;
320 opts
.dst_index
= &the_index
;
322 opts
.fn
= oneway_merge
;
323 tree
= parse_tree_indirect(¤t_head
->object
.oid
);
325 die(_("failed to unpack HEAD tree object"));
327 init_tree_desc(&t
, tree
->buffer
, tree
->size
);
328 if (unpack_trees(1, &t
, &opts
))
329 exit(128); /* We've already reported the error, finish dying */
332 static void refresh_cache_or_die(int refresh_flags
)
335 * refresh_flags contains REFRESH_QUIET, so the only errors
336 * are for unmerged entries.
338 if (refresh_cache(refresh_flags
| REFRESH_IN_PORCELAIN
))
339 die_resolve_conflict("commit");
342 static const char *prepare_index(const char **argv
, const char *prefix
,
343 const struct commit
*current_head
, int is_status
)
345 struct string_list partial
= STRING_LIST_INIT_DUP
;
346 struct pathspec pathspec
;
347 int refresh_flags
= REFRESH_QUIET
;
351 refresh_flags
|= REFRESH_UNMERGED
;
352 parse_pathspec(&pathspec
, 0,
353 PATHSPEC_PREFER_FULL
,
356 if (pathspec_from_file
) {
358 die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "--interactive/--patch");
361 die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "-a");
364 die(_("'%s' and pathspec arguments cannot be used together"), "--pathspec-from-file");
366 parse_pathspec_file(&pathspec
, 0,
367 PATHSPEC_PREFER_FULL
,
368 prefix
, pathspec_from_file
, pathspec_file_nul
);
369 } else if (pathspec_file_nul
) {
370 die(_("the option '%s' requires '%s'"), "--pathspec-file-nul", "--pathspec-from-file");
373 if (!pathspec
.nr
&& (also
|| (only
&& !allow_empty
&&
374 (!amend
|| (fixup_message
&& strcmp(fixup_prefix
, "amend"))))))
375 die(_("No paths with --include/--only does not make sense."));
377 if (read_cache_preload(&pathspec
) < 0)
378 die(_("index file corrupt"));
381 char *old_index_env
= NULL
, *old_repo_index_file
;
382 hold_locked_index(&index_lock
, LOCK_DIE_ON_ERROR
);
384 refresh_cache_or_die(refresh_flags
);
386 if (write_locked_index(&the_index
, &index_lock
, 0))
387 die(_("unable to create temporary index"));
389 old_repo_index_file
= the_repository
->index_file
;
390 the_repository
->index_file
=
391 (char *)get_lock_file_path(&index_lock
);
392 old_index_env
= xstrdup_or_null(getenv(INDEX_ENVIRONMENT
));
393 setenv(INDEX_ENVIRONMENT
, the_repository
->index_file
, 1);
395 if (interactive_add(argv
, prefix
, patch_interactive
) != 0)
396 die(_("interactive add failed"));
398 the_repository
->index_file
= old_repo_index_file
;
399 if (old_index_env
&& *old_index_env
)
400 setenv(INDEX_ENVIRONMENT
, old_index_env
, 1);
402 unsetenv(INDEX_ENVIRONMENT
);
403 FREE_AND_NULL(old_index_env
);
406 read_cache_from(get_lock_file_path(&index_lock
));
407 if (update_main_cache_tree(WRITE_TREE_SILENT
) == 0) {
408 if (reopen_lock_file(&index_lock
) < 0)
409 die(_("unable to write index file"));
410 if (write_locked_index(&the_index
, &index_lock
, 0))
411 die(_("unable to update temporary index"));
413 warning(_("Failed to update main cache tree"));
415 commit_style
= COMMIT_NORMAL
;
416 ret
= get_lock_file_path(&index_lock
);
421 * Non partial, non as-is commit.
423 * (1) get the real index;
424 * (2) update the_index as necessary;
425 * (3) write the_index out to the real index (still locked);
426 * (4) return the name of the locked index file.
428 * The caller should run hooks on the locked real index, and
429 * (A) if all goes well, commit the real index;
430 * (B) on failure, rollback the real index.
432 if (all
|| (also
&& pathspec
.nr
)) {
433 hold_locked_index(&index_lock
, LOCK_DIE_ON_ERROR
);
434 add_files_to_cache(also
? prefix
: NULL
, &pathspec
, 0);
435 refresh_cache_or_die(refresh_flags
);
436 update_main_cache_tree(WRITE_TREE_SILENT
);
437 if (write_locked_index(&the_index
, &index_lock
, 0))
438 die(_("unable to write new_index file"));
439 commit_style
= COMMIT_NORMAL
;
440 ret
= get_lock_file_path(&index_lock
);
447 * (1) return the name of the real index file.
449 * The caller should run hooks on the real index,
450 * and create commit from the_index.
451 * We still need to refresh the index here.
453 if (!only
&& !pathspec
.nr
) {
454 hold_locked_index(&index_lock
, LOCK_DIE_ON_ERROR
);
455 refresh_cache_or_die(refresh_flags
);
456 if (active_cache_changed
457 || !cache_tree_fully_valid(active_cache_tree
))
458 update_main_cache_tree(WRITE_TREE_SILENT
);
459 if (write_locked_index(&the_index
, &index_lock
,
460 COMMIT_LOCK
| SKIP_IF_UNCHANGED
))
461 die(_("unable to write new_index file"));
462 commit_style
= COMMIT_AS_IS
;
463 ret
= get_index_file();
470 * (0) find the set of affected paths;
471 * (1) get lock on the real index file;
472 * (2) update the_index with the given paths;
473 * (3) write the_index out to the real index (still locked);
474 * (4) get lock on the false index file;
475 * (5) reset the_index from HEAD;
476 * (6) update the_index the same way as (2);
477 * (7) write the_index out to the false index file;
478 * (8) return the name of the false index file (still locked);
480 * The caller should run hooks on the locked false index, and
481 * create commit from it. Then
482 * (A) if all goes well, commit the real index;
483 * (B) on failure, rollback the real index;
484 * In either case, rollback the false index.
486 commit_style
= COMMIT_PARTIAL
;
488 if (whence
!= FROM_COMMIT
) {
489 if (whence
== FROM_MERGE
)
490 die(_("cannot do a partial commit during a merge."));
491 else if (is_from_cherry_pick(whence
))
492 die(_("cannot do a partial commit during a cherry-pick."));
493 else if (is_from_rebase(whence
))
494 die(_("cannot do a partial commit during a rebase."));
497 if (list_paths(&partial
, !current_head
? NULL
: "HEAD", &pathspec
))
501 if (read_cache() < 0)
502 die(_("cannot read the index"));
504 hold_locked_index(&index_lock
, LOCK_DIE_ON_ERROR
);
505 add_remove_files(&partial
);
506 refresh_cache(REFRESH_QUIET
);
507 update_main_cache_tree(WRITE_TREE_SILENT
);
508 if (write_locked_index(&the_index
, &index_lock
, 0))
509 die(_("unable to write new_index file"));
511 hold_lock_file_for_update(&false_lock
,
512 git_path("next-index-%"PRIuMAX
,
513 (uintmax_t) getpid()),
516 create_base_index(current_head
);
517 add_remove_files(&partial
);
518 refresh_cache(REFRESH_QUIET
);
520 if (write_locked_index(&the_index
, &false_lock
, 0))
521 die(_("unable to write temporary index file"));
524 ret
= get_lock_file_path(&false_lock
);
525 read_cache_from(ret
);
527 string_list_clear(&partial
, 0);
528 clear_pathspec(&pathspec
);
532 static int run_status(FILE *fp
, const char *index_file
, const char *prefix
, int nowarn
,
535 struct object_id oid
;
537 if (s
->relative_paths
)
542 s
->reference
= "HEAD^1";
544 s
->verbose
= verbose
;
545 s
->index_file
= index_file
;
548 s
->is_initial
= get_oid(s
->reference
, &oid
) ? 1 : 0;
550 oidcpy(&s
->oid_commit
, &oid
);
551 s
->status_format
= status_format
;
552 s
->ignore_submodule_arg
= ignore_submodule_arg
;
554 wt_status_collect(s
);
556 wt_status_collect_free_buffers(s
);
558 return s
->committable
;
561 static int is_a_merge(const struct commit
*current_head
)
563 return !!(current_head
->parents
&& current_head
->parents
->next
);
566 static void assert_split_ident(struct ident_split
*id
, const struct strbuf
*buf
)
568 if (split_ident_line(id
, buf
->buf
, buf
->len
) || !id
->date_begin
)
569 BUG("unable to parse our own ident: %s", buf
->buf
);
572 static void export_one(const char *var
, const char *s
, const char *e
, int hack
)
574 struct strbuf buf
= STRBUF_INIT
;
576 strbuf_addch(&buf
, hack
);
577 strbuf_add(&buf
, s
, e
- s
);
578 setenv(var
, buf
.buf
, 1);
579 strbuf_release(&buf
);
582 static int parse_force_date(const char *in
, struct strbuf
*out
)
584 strbuf_addch(out
, '@');
586 if (parse_date(in
, out
) < 0) {
588 unsigned long t
= approxidate_careful(in
, &errors
);
591 strbuf_addf(out
, "%lu", t
);
597 static void set_ident_var(char **buf
, char *val
)
603 static void determine_author_info(struct strbuf
*author_ident
)
605 char *name
, *email
, *date
;
606 struct ident_split author
;
608 name
= xstrdup_or_null(getenv("GIT_AUTHOR_NAME"));
609 email
= xstrdup_or_null(getenv("GIT_AUTHOR_EMAIL"));
610 date
= xstrdup_or_null(getenv("GIT_AUTHOR_DATE"));
612 if (author_message
) {
613 struct ident_split ident
;
617 a
= find_commit_header(author_message_buffer
, "author", &len
);
619 die(_("commit '%s' lacks author header"), author_message
);
620 if (split_ident_line(&ident
, a
, len
) < 0)
621 die(_("commit '%s' has malformed author line"), author_message
);
623 set_ident_var(&name
, xmemdupz(ident
.name_begin
, ident
.name_end
- ident
.name_begin
));
624 set_ident_var(&email
, xmemdupz(ident
.mail_begin
, ident
.mail_end
- ident
.mail_begin
));
626 if (ident
.date_begin
) {
627 struct strbuf date_buf
= STRBUF_INIT
;
628 strbuf_addch(&date_buf
, '@');
629 strbuf_add(&date_buf
, ident
.date_begin
, ident
.date_end
- ident
.date_begin
);
630 strbuf_addch(&date_buf
, ' ');
631 strbuf_add(&date_buf
, ident
.tz_begin
, ident
.tz_end
- ident
.tz_begin
);
632 set_ident_var(&date
, strbuf_detach(&date_buf
, NULL
));
637 struct ident_split ident
;
639 if (split_ident_line(&ident
, force_author
, strlen(force_author
)) < 0)
640 die(_("malformed --author parameter"));
641 set_ident_var(&name
, xmemdupz(ident
.name_begin
, ident
.name_end
- ident
.name_begin
));
642 set_ident_var(&email
, xmemdupz(ident
.mail_begin
, ident
.mail_end
- ident
.mail_begin
));
646 struct strbuf date_buf
= STRBUF_INIT
;
647 if (parse_force_date(force_date
, &date_buf
))
648 die(_("invalid date format: %s"), force_date
);
649 set_ident_var(&date
, strbuf_detach(&date_buf
, NULL
));
652 strbuf_addstr(author_ident
, fmt_ident(name
, email
, WANT_AUTHOR_IDENT
, date
,
654 assert_split_ident(&author
, author_ident
);
655 export_one("GIT_AUTHOR_NAME", author
.name_begin
, author
.name_end
, 0);
656 export_one("GIT_AUTHOR_EMAIL", author
.mail_begin
, author
.mail_end
, 0);
657 export_one("GIT_AUTHOR_DATE", author
.date_begin
, author
.tz_end
, '@');
663 static int author_date_is_interesting(void)
665 return author_message
|| force_date
;
668 static void adjust_comment_line_char(const struct strbuf
*sb
)
670 char candidates
[] = "#;@!$%^&|:";
674 comment_line_char
= candidates
[0];
675 if (!memchr(sb
->buf
, comment_line_char
, sb
->len
))
679 candidate
= strchr(candidates
, *p
);
682 for (p
= sb
->buf
; *p
; p
++) {
683 if ((p
[0] == '\n' || p
[0] == '\r') && p
[1]) {
684 candidate
= strchr(candidates
, p
[1]);
690 for (p
= candidates
; *p
== ' '; p
++)
693 die(_("unable to select a comment character that is not used\n"
694 "in the current commit message"));
695 comment_line_char
= *p
;
698 static void prepare_amend_commit(struct commit
*commit
, struct strbuf
*sb
,
699 struct pretty_print_context
*ctx
)
701 const char *buffer
, *subject
, *fmt
;
703 buffer
= get_commit_buffer(commit
, NULL
);
704 find_commit_subject(buffer
, &subject
);
706 * If we amend the 'amend!' commit then we don't want to
707 * duplicate the subject line.
709 fmt
= starts_with(subject
, "amend!") ? "%b" : "%B";
710 format_commit_message(commit
, fmt
, sb
, ctx
);
711 unuse_commit_buffer(commit
, buffer
);
714 static int prepare_to_commit(const char *index_file
, const char *prefix
,
715 struct commit
*current_head
,
717 struct strbuf
*author_ident
)
720 struct strbuf committer_ident
= STRBUF_INIT
;
722 struct strbuf sb
= STRBUF_INIT
;
723 const char *hook_arg1
= NULL
;
724 const char *hook_arg2
= NULL
;
725 int clean_message_contents
= (cleanup_mode
!= COMMIT_MSG_CLEANUP_NONE
);
726 int old_display_comment_prefix
;
727 int merge_contains_scissors
= 0;
729 /* This checks and barfs if author is badly specified */
730 determine_author_info(author_ident
);
732 if (!no_verify
&& run_commit_hook(use_editor
, index_file
, "pre-commit", NULL
))
735 if (squash_message
) {
737 * Insert the proper subject line before other commit
738 * message options add their content.
740 if (use_message
&& !strcmp(use_message
, squash_message
))
741 strbuf_addstr(&sb
, "squash! ");
743 struct pretty_print_context ctx
= {0};
745 c
= lookup_commit_reference_by_name(squash_message
);
747 die(_("could not lookup commit %s"), squash_message
);
748 ctx
.output_encoding
= get_commit_output_encoding();
749 format_commit_message(c
, "squash! %s\n\n", &sb
,
754 if (have_option_m
&& !fixup_message
) {
755 strbuf_addbuf(&sb
, &message
);
756 hook_arg1
= "message";
757 } else if (logfile
&& !strcmp(logfile
, "-")) {
759 fprintf(stderr
, _("(reading log message from standard input)\n"));
760 if (strbuf_read(&sb
, 0, 0) < 0)
761 die_errno(_("could not read log from standard input"));
762 hook_arg1
= "message";
763 } else if (logfile
) {
764 if (strbuf_read_file(&sb
, logfile
, 0) < 0)
765 die_errno(_("could not read log file '%s'"),
767 hook_arg1
= "message";
768 } else if (use_message
) {
770 buffer
= strstr(use_message_buffer
, "\n\n");
772 strbuf_addstr(&sb
, skip_blank_lines(buffer
+ 2));
773 hook_arg1
= "commit";
774 hook_arg2
= use_message
;
775 } else if (fixup_message
) {
776 struct pretty_print_context ctx
= {0};
777 struct commit
*commit
;
779 commit
= lookup_commit_reference_by_name(fixup_commit
);
781 die(_("could not lookup commit %s"), fixup_commit
);
782 ctx
.output_encoding
= get_commit_output_encoding();
783 fmt
= xstrfmt("%s! %%s\n\n", fixup_prefix
);
784 format_commit_message(commit
, fmt
, &sb
, &ctx
);
786 hook_arg1
= "message";
789 * Only `-m` commit message option is checked here, as
790 * it supports `--fixup` to append the commit message.
792 * The other commit message options `-c`/`-C`/`-F` are
793 * incompatible with all the forms of `--fixup` and
794 * have already errored out while parsing the `git commit`
797 if (have_option_m
&& !strcmp(fixup_prefix
, "fixup"))
798 strbuf_addbuf(&sb
, &message
);
800 if (!strcmp(fixup_prefix
, "amend")) {
802 die(_("options '%s' and '%s:%s' cannot be used together"), "-m", "--fixup", fixup_message
);
803 prepare_amend_commit(commit
, &sb
, &ctx
);
805 } else if (!stat(git_path_merge_msg(the_repository
), &statbuf
)) {
806 size_t merge_msg_start
;
809 * prepend SQUASH_MSG here if it exists and a
810 * "merge --squash" was originally performed
812 if (!stat(git_path_squash_msg(the_repository
), &statbuf
)) {
813 if (strbuf_read_file(&sb
, git_path_squash_msg(the_repository
), 0) < 0)
814 die_errno(_("could not read SQUASH_MSG"));
815 hook_arg1
= "squash";
819 merge_msg_start
= sb
.len
;
820 if (strbuf_read_file(&sb
, git_path_merge_msg(the_repository
), 0) < 0)
821 die_errno(_("could not read MERGE_MSG"));
823 if (cleanup_mode
== COMMIT_MSG_CLEANUP_SCISSORS
&&
824 wt_status_locate_end(sb
.buf
+ merge_msg_start
,
825 sb
.len
- merge_msg_start
) <
826 sb
.len
- merge_msg_start
)
827 merge_contains_scissors
= 1;
828 } else if (!stat(git_path_squash_msg(the_repository
), &statbuf
)) {
829 if (strbuf_read_file(&sb
, git_path_squash_msg(the_repository
), 0) < 0)
830 die_errno(_("could not read SQUASH_MSG"));
831 hook_arg1
= "squash";
832 } else if (template_file
) {
833 if (strbuf_read_file(&sb
, template_file
, 0) < 0)
834 die_errno(_("could not read '%s'"), template_file
);
835 hook_arg1
= "template";
836 clean_message_contents
= 0;
840 * The remaining cases don't modify the template message, but
841 * just set the argument(s) to the prepare-commit-msg hook.
843 else if (whence
== FROM_MERGE
)
845 else if (is_from_cherry_pick(whence
) || whence
== FROM_REBASE_PICK
) {
846 hook_arg1
= "commit";
847 hook_arg2
= "CHERRY_PICK_HEAD";
850 if (squash_message
) {
852 * If squash_commit was used for the commit subject,
853 * then we're possibly hijacking other commit log options.
854 * Reset the hook args to tell the real story.
856 hook_arg1
= "message";
860 s
->fp
= fopen_for_writing(git_path_commit_editmsg());
862 die_errno(_("could not open '%s'"), git_path_commit_editmsg());
864 /* Ignore status.displayCommentPrefix: we do need comments in COMMIT_EDITMSG. */
865 old_display_comment_prefix
= s
->display_comment_prefix
;
866 s
->display_comment_prefix
= 1;
869 * Most hints are counter-productive when the commit has
874 if (clean_message_contents
)
875 strbuf_stripspace(&sb
, 0);
878 append_signoff(&sb
, ignore_non_trailer(sb
.buf
, sb
.len
), 0);
880 if (fwrite(sb
.buf
, 1, sb
.len
, s
->fp
) < sb
.len
)
881 die_errno(_("could not write commit template"));
883 if (auto_comment_line_char
)
884 adjust_comment_line_char(&sb
);
887 /* This checks if committer ident is explicitly given */
888 strbuf_addstr(&committer_ident
, git_committer_info(IDENT_STRICT
));
889 if (use_editor
&& include_status
) {
891 int saved_color_setting
;
892 struct ident_split ci
, ai
;
893 const char *hint_cleanup_all
= allow_empty_message
?
894 _("Please enter the commit message for your changes."
895 " Lines starting\nwith '%c' will be ignored.\n") :
896 _("Please enter the commit message for your changes."
897 " Lines starting\nwith '%c' will be ignored, and an empty"
898 " message aborts the commit.\n");
899 const char *hint_cleanup_space
= allow_empty_message
?
900 _("Please enter the commit message for your changes."
902 "with '%c' will be kept; you may remove them"
903 " yourself if you want to.\n") :
904 _("Please enter the commit message for your changes."
906 "with '%c' will be kept; you may remove them"
907 " yourself if you want to.\n"
908 "An empty message aborts the commit.\n");
909 if (whence
!= FROM_COMMIT
) {
910 if (cleanup_mode
== COMMIT_MSG_CLEANUP_SCISSORS
&&
911 !merge_contains_scissors
)
912 wt_status_add_cut_line(s
->fp
);
915 whence
== FROM_MERGE
?
917 "It looks like you may be committing a merge.\n"
918 "If this is not correct, please run\n"
919 " git update-ref -d MERGE_HEAD\n"
920 "and try again.\n") :
922 "It looks like you may be committing a cherry-pick.\n"
923 "If this is not correct, please run\n"
924 " git update-ref -d CHERRY_PICK_HEAD\n"
925 "and try again.\n"));
928 fprintf(s
->fp
, "\n");
929 if (cleanup_mode
== COMMIT_MSG_CLEANUP_ALL
)
930 status_printf(s
, GIT_COLOR_NORMAL
, hint_cleanup_all
, comment_line_char
);
931 else if (cleanup_mode
== COMMIT_MSG_CLEANUP_SCISSORS
) {
932 if (whence
== FROM_COMMIT
&& !merge_contains_scissors
)
933 wt_status_add_cut_line(s
->fp
);
934 } else /* COMMIT_MSG_CLEANUP_SPACE, that is. */
935 status_printf(s
, GIT_COLOR_NORMAL
, hint_cleanup_space
, comment_line_char
);
938 * These should never fail because they come from our own
939 * fmt_ident. They may fail the sane_ident test, but we know
940 * that the name and mail pointers will at least be valid,
941 * which is enough for our tests and printing here.
943 assert_split_ident(&ai
, author_ident
);
944 assert_split_ident(&ci
, &committer_ident
);
946 if (ident_cmp(&ai
, &ci
))
947 status_printf_ln(s
, GIT_COLOR_NORMAL
,
949 "Author: %.*s <%.*s>"),
950 ident_shown
++ ? "" : "\n",
951 (int)(ai
.name_end
- ai
.name_begin
), ai
.name_begin
,
952 (int)(ai
.mail_end
- ai
.mail_begin
), ai
.mail_begin
);
954 if (author_date_is_interesting())
955 status_printf_ln(s
, GIT_COLOR_NORMAL
,
958 ident_shown
++ ? "" : "\n",
959 show_ident_date(&ai
, DATE_MODE(NORMAL
)));
961 if (!committer_ident_sufficiently_given())
962 status_printf_ln(s
, GIT_COLOR_NORMAL
,
964 "Committer: %.*s <%.*s>"),
965 ident_shown
++ ? "" : "\n",
966 (int)(ci
.name_end
- ci
.name_begin
), ci
.name_begin
,
967 (int)(ci
.mail_end
- ci
.mail_begin
), ci
.mail_begin
);
969 status_printf_ln(s
, GIT_COLOR_NORMAL
, "%s", ""); /* Add new line for clarity */
971 saved_color_setting
= s
->use_color
;
973 committable
= run_status(s
->fp
, index_file
, prefix
, 1, s
);
974 s
->use_color
= saved_color_setting
;
975 string_list_clear(&s
->change
, 1);
977 struct object_id oid
;
978 const char *parent
= "HEAD";
980 if (!active_nr
&& read_cache() < 0)
981 die(_("Cannot read index"));
986 if (get_oid(parent
, &oid
)) {
989 /* TODO: audit for interaction with sparse-index. */
990 ensure_full_index(&the_index
);
991 for (i
= 0; i
< active_nr
; i
++)
992 if (ce_intent_to_add(active_cache
[i
]))
994 committable
= active_nr
- ita_nr
> 0;
997 * Unless the user did explicitly request a submodule
998 * ignore mode by passing a command line option we do
999 * not ignore any changed submodule SHA-1s when
1000 * comparing index and parent, no matter what is
1001 * configured. Otherwise we won't commit any
1002 * submodules which were manually staged, which would
1003 * be really confusing.
1005 struct diff_flags flags
= DIFF_FLAGS_INIT
;
1006 flags
.override_submodule_config
= 1;
1007 if (ignore_submodule_arg
&&
1008 !strcmp(ignore_submodule_arg
, "all"))
1009 flags
.ignore_submodules
= 1;
1010 committable
= index_differs_from(the_repository
,
1014 strbuf_release(&committer_ident
);
1018 if (trailer_args
.nr
) {
1019 struct child_process run_trailer
= CHILD_PROCESS_INIT
;
1021 strvec_pushl(&run_trailer
.args
, "interpret-trailers",
1022 "--in-place", git_path_commit_editmsg(), NULL
);
1023 strvec_pushv(&run_trailer
.args
, trailer_args
.v
);
1024 run_trailer
.git_cmd
= 1;
1025 if (run_command(&run_trailer
))
1026 die(_("unable to pass trailers to --trailers"));
1027 strvec_clear(&trailer_args
);
1031 * Reject an attempt to record a non-merge empty commit without
1032 * explicit --allow-empty. In the cherry-pick case, it may be
1033 * empty due to conflict resolution, which the user should okay.
1035 if (!committable
&& whence
!= FROM_MERGE
&& !allow_empty
&&
1036 !(amend
&& is_a_merge(current_head
))) {
1037 s
->hints
= advice_enabled(ADVICE_STATUS_HINTS
);
1038 s
->display_comment_prefix
= old_display_comment_prefix
;
1039 run_status(stdout
, index_file
, prefix
, 0, s
);
1041 fputs(_(empty_amend_advice
), stderr
);
1042 else if (is_from_cherry_pick(whence
) ||
1043 whence
== FROM_REBASE_PICK
) {
1044 fputs(_(empty_cherry_pick_advice
), stderr
);
1045 if (whence
== FROM_CHERRY_PICK_SINGLE
)
1046 fputs(_(empty_cherry_pick_advice_single
), stderr
);
1047 else if (whence
== FROM_CHERRY_PICK_MULTI
)
1048 fputs(_(empty_cherry_pick_advice_multi
), stderr
);
1050 fputs(_(empty_rebase_pick_advice
), stderr
);
1055 if (!no_verify
&& hook_exists("pre-commit")) {
1057 * Re-read the index as pre-commit hook could have updated it,
1058 * and write it out as a tree. We must do this before we invoke
1059 * the editor and after we invoke run_status above.
1063 read_cache_from(index_file
);
1065 if (update_main_cache_tree(0)) {
1066 error(_("Error building trees"));
1070 if (run_commit_hook(use_editor
, index_file
, "prepare-commit-msg",
1071 git_path_commit_editmsg(), hook_arg1
, hook_arg2
, NULL
))
1075 struct strvec env
= STRVEC_INIT
;
1077 strvec_pushf(&env
, "GIT_INDEX_FILE=%s", index_file
);
1078 if (launch_editor(git_path_commit_editmsg(), NULL
, env
.v
)) {
1080 _("Please supply the message using either -m or -F option.\n"));
1087 run_commit_hook(use_editor
, index_file
, "commit-msg", git_path_commit_editmsg(), NULL
)) {
1094 static const char *find_author_by_nickname(const char *name
)
1096 struct rev_info revs
;
1097 struct commit
*commit
;
1098 struct strbuf buf
= STRBUF_INIT
;
1099 struct string_list mailmap
= STRING_LIST_INIT_NODUP
;
1103 repo_init_revisions(the_repository
, &revs
, NULL
);
1104 strbuf_addf(&buf
, "--author=%s", name
);
1109 setup_revisions(ac
, av
, &revs
, NULL
);
1110 revs
.mailmap
= &mailmap
;
1111 read_mailmap(revs
.mailmap
);
1113 if (prepare_revision_walk(&revs
))
1114 die(_("revision walk setup failed"));
1115 commit
= get_revision(&revs
);
1117 struct pretty_print_context ctx
= {0};
1118 ctx
.date_mode
.type
= DATE_NORMAL
;
1119 strbuf_release(&buf
);
1120 format_commit_message(commit
, "%aN <%aE>", &buf
, &ctx
);
1121 clear_mailmap(&mailmap
);
1122 return strbuf_detach(&buf
, NULL
);
1124 die(_("--author '%s' is not 'Name <email>' and matches no existing author"), name
);
1127 static void handle_ignored_arg(struct wt_status
*s
)
1130 ; /* default already initialized */
1131 else if (!strcmp(ignored_arg
, "traditional"))
1132 s
->show_ignored_mode
= SHOW_TRADITIONAL_IGNORED
;
1133 else if (!strcmp(ignored_arg
, "no"))
1134 s
->show_ignored_mode
= SHOW_NO_IGNORED
;
1135 else if (!strcmp(ignored_arg
, "matching"))
1136 s
->show_ignored_mode
= SHOW_MATCHING_IGNORED
;
1138 die(_("Invalid ignored mode '%s'"), ignored_arg
);
1141 static void handle_untracked_files_arg(struct wt_status
*s
)
1143 if (!untracked_files_arg
)
1144 ; /* default already initialized */
1145 else if (!strcmp(untracked_files_arg
, "no"))
1146 s
->show_untracked_files
= SHOW_NO_UNTRACKED_FILES
;
1147 else if (!strcmp(untracked_files_arg
, "normal"))
1148 s
->show_untracked_files
= SHOW_NORMAL_UNTRACKED_FILES
;
1149 else if (!strcmp(untracked_files_arg
, "all"))
1150 s
->show_untracked_files
= SHOW_ALL_UNTRACKED_FILES
;
1152 * Please update $__git_untracked_file_modes in
1153 * git-completion.bash when you add new options
1156 die(_("Invalid untracked files mode '%s'"), untracked_files_arg
);
1159 static const char *read_commit_message(const char *name
)
1161 const char *out_enc
;
1162 struct commit
*commit
;
1164 commit
= lookup_commit_reference_by_name(name
);
1166 die(_("could not lookup commit %s"), name
);
1167 out_enc
= get_commit_output_encoding();
1168 return logmsg_reencode(commit
, NULL
, out_enc
);
1172 * Enumerate what needs to be propagated when --porcelain
1173 * is not in effect here.
1175 static struct status_deferred_config
{
1176 enum wt_status_format status_format
;
1178 enum ahead_behind_flags ahead_behind
;
1179 } status_deferred_config
= {
1180 STATUS_FORMAT_UNSPECIFIED
,
1181 -1, /* unspecified */
1182 AHEAD_BEHIND_UNSPECIFIED
,
1185 static void finalize_deferred_config(struct wt_status
*s
)
1187 int use_deferred_config
= (status_format
!= STATUS_FORMAT_PORCELAIN
&&
1188 status_format
!= STATUS_FORMAT_PORCELAIN_V2
&&
1189 !s
->null_termination
);
1191 if (s
->null_termination
) {
1192 if (status_format
== STATUS_FORMAT_NONE
||
1193 status_format
== STATUS_FORMAT_UNSPECIFIED
)
1194 status_format
= STATUS_FORMAT_PORCELAIN
;
1195 else if (status_format
== STATUS_FORMAT_LONG
)
1196 die(_("options '%s' and '%s' cannot be used together"), "--long", "-z");
1199 if (use_deferred_config
&& status_format
== STATUS_FORMAT_UNSPECIFIED
)
1200 status_format
= status_deferred_config
.status_format
;
1201 if (status_format
== STATUS_FORMAT_UNSPECIFIED
)
1202 status_format
= STATUS_FORMAT_NONE
;
1204 if (use_deferred_config
&& s
->show_branch
< 0)
1205 s
->show_branch
= status_deferred_config
.show_branch
;
1206 if (s
->show_branch
< 0)
1210 * If the user did not give a "--[no]-ahead-behind" command
1211 * line argument *AND* we will print in a human-readable format
1212 * (short, long etc.) then we inherit from the status.aheadbehind
1213 * config setting. In all other cases (and porcelain V[12] formats
1214 * in particular), we inherit _FULL for backwards compatibility.
1216 if (use_deferred_config
&&
1217 s
->ahead_behind_flags
== AHEAD_BEHIND_UNSPECIFIED
)
1218 s
->ahead_behind_flags
= status_deferred_config
.ahead_behind
;
1220 if (s
->ahead_behind_flags
== AHEAD_BEHIND_UNSPECIFIED
)
1221 s
->ahead_behind_flags
= AHEAD_BEHIND_FULL
;
1224 static void check_fixup_reword_options(int argc
, const char *argv
[]) {
1225 if (whence
!= FROM_COMMIT
) {
1226 if (whence
== FROM_MERGE
)
1227 die(_("You are in the middle of a merge -- cannot reword."));
1228 else if (is_from_cherry_pick(whence
))
1229 die(_("You are in the middle of a cherry-pick -- cannot reword."));
1232 die(_("reword option of '%s' and path '%s' cannot be used together"), "--fixup", *argv
);
1233 if (patch_interactive
|| interactive
|| all
|| also
|| only
)
1234 die(_("reword option of '%s' and '%s' cannot be used together"),
1235 "--fixup", "--patch/--interactive/--all/--include/--only");
1238 static int parse_and_validate_options(int argc
, const char *argv
[],
1239 const struct option
*options
,
1240 const char * const usage
[],
1242 struct commit
*current_head
,
1243 struct wt_status
*s
)
1247 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
1248 finalize_deferred_config(s
);
1250 if (force_author
&& !strchr(force_author
, '>'))
1251 force_author
= find_author_by_nickname(force_author
);
1253 if (force_author
&& renew_authorship
)
1254 die(_("Using both --reset-author and --author does not make sense"));
1256 if (logfile
|| have_option_m
|| use_message
)
1259 /* Sanity check options */
1260 if (amend
&& !current_head
)
1261 die(_("You have nothing to amend."));
1262 if (amend
&& whence
!= FROM_COMMIT
) {
1263 if (whence
== FROM_MERGE
)
1264 die(_("You are in the middle of a merge -- cannot amend."));
1265 else if (is_from_cherry_pick(whence
))
1266 die(_("You are in the middle of a cherry-pick -- cannot amend."));
1267 else if (whence
== FROM_REBASE_PICK
)
1268 die(_("You are in the middle of a rebase -- cannot amend."));
1270 if (fixup_message
&& squash_message
)
1271 die(_("Options --squash and --fixup cannot be used together"));
1281 die(_("Only one of -c/-C/-F/--fixup can be used."));
1282 if (have_option_m
&& (edit_message
|| use_message
|| logfile
))
1283 die((_("Option -m cannot be combined with -c/-C/-F.")));
1284 if (f
|| have_option_m
)
1285 template_file
= NULL
;
1287 use_message
= edit_message
;
1288 if (amend
&& !use_message
&& !fixup_message
)
1289 use_message
= "HEAD";
1290 if (!use_message
&& !is_from_cherry_pick(whence
) &&
1291 !is_from_rebase(whence
) && renew_authorship
)
1292 die(_("--reset-author can be used only with -C, -c or --amend."));
1294 use_message_buffer
= read_commit_message(use_message
);
1295 if (!renew_authorship
) {
1296 author_message
= use_message
;
1297 author_message_buffer
= use_message_buffer
;
1300 if ((is_from_cherry_pick(whence
) || whence
== FROM_REBASE_PICK
) &&
1301 !renew_authorship
) {
1302 author_message
= "CHERRY_PICK_HEAD";
1303 author_message_buffer
= read_commit_message(author_message
);
1306 if (patch_interactive
)
1309 if (also
+ only
+ all
+ interactive
> 1)
1310 die(_("Only one of --include/--only/--all/--interactive/--patch can be used."));
1312 if (fixup_message
) {
1314 * We limit --fixup's suboptions to only alpha characters.
1315 * If the first character after a run of alpha is colon,
1316 * then the part before the colon may be a known suboption
1317 * name like `amend` or `reword`, or a misspelt suboption
1318 * name. In either case, we treat it as
1319 * --fixup=<suboption>:<arg>.
1321 * Otherwise, we are dealing with --fixup=<commit>.
1323 char *p
= fixup_message
;
1326 if (p
> fixup_message
&& *p
== ':') {
1328 fixup_commit
= p
+ 1;
1329 if (!strcmp("amend", fixup_message
) ||
1330 !strcmp("reword", fixup_message
)) {
1331 fixup_prefix
= "amend";
1333 if (*fixup_message
== 'r') {
1334 check_fixup_reword_options(argc
, argv
);
1338 die(_("unknown option: --fixup=%s:%s"), fixup_message
, fixup_commit
);
1341 fixup_commit
= fixup_message
;
1342 fixup_prefix
= "fixup";
1348 use_editor
= edit_flag
;
1350 cleanup_mode
= get_cleanup_mode(cleanup_arg
, use_editor
);
1352 handle_untracked_files_arg(s
);
1354 if (all
&& argc
> 0)
1355 die(_("paths '%s ...' with -a does not make sense"),
1358 if (status_format
!= STATUS_FORMAT_NONE
)
1364 static int dry_run_commit(const char **argv
, const char *prefix
,
1365 const struct commit
*current_head
, struct wt_status
*s
)
1368 const char *index_file
;
1370 index_file
= prepare_index(argv
, prefix
, current_head
, 1);
1371 committable
= run_status(stdout
, index_file
, prefix
, 0, s
);
1372 rollback_index_files();
1374 return committable
? 0 : 1;
1377 define_list_config_array_extra(color_status_slots
, {"added"});
1379 static int parse_status_slot(const char *slot
)
1381 if (!strcasecmp(slot
, "added"))
1382 return WT_STATUS_UPDATED
;
1384 return LOOKUP_CONFIG(color_status_slots
, slot
);
1387 static int git_status_config(const char *k
, const char *v
, void *cb
)
1389 struct wt_status
*s
= cb
;
1390 const char *slot_name
;
1392 if (starts_with(k
, "column."))
1393 return git_column_config(k
, v
, "status", &s
->colopts
);
1394 if (!strcmp(k
, "status.submodulesummary")) {
1396 s
->submodule_summary
= git_config_bool_or_int(k
, v
, &is_bool
);
1397 if (is_bool
&& s
->submodule_summary
)
1398 s
->submodule_summary
= -1;
1401 if (!strcmp(k
, "status.short")) {
1402 if (git_config_bool(k
, v
))
1403 status_deferred_config
.status_format
= STATUS_FORMAT_SHORT
;
1405 status_deferred_config
.status_format
= STATUS_FORMAT_NONE
;
1408 if (!strcmp(k
, "status.branch")) {
1409 status_deferred_config
.show_branch
= git_config_bool(k
, v
);
1412 if (!strcmp(k
, "status.aheadbehind")) {
1413 status_deferred_config
.ahead_behind
= git_config_bool(k
, v
);
1416 if (!strcmp(k
, "status.showstash")) {
1417 s
->show_stash
= git_config_bool(k
, v
);
1420 if (!strcmp(k
, "status.color") || !strcmp(k
, "color.status")) {
1421 s
->use_color
= git_config_colorbool(k
, v
);
1424 if (!strcmp(k
, "status.displaycommentprefix")) {
1425 s
->display_comment_prefix
= git_config_bool(k
, v
);
1428 if (skip_prefix(k
, "status.color.", &slot_name
) ||
1429 skip_prefix(k
, "color.status.", &slot_name
)) {
1430 int slot
= parse_status_slot(slot_name
);
1434 return config_error_nonbool(k
);
1435 return color_parse(v
, s
->color_palette
[slot
]);
1437 if (!strcmp(k
, "status.relativepaths")) {
1438 s
->relative_paths
= git_config_bool(k
, v
);
1441 if (!strcmp(k
, "status.showuntrackedfiles")) {
1443 return config_error_nonbool(k
);
1444 else if (!strcmp(v
, "no"))
1445 s
->show_untracked_files
= SHOW_NO_UNTRACKED_FILES
;
1446 else if (!strcmp(v
, "normal"))
1447 s
->show_untracked_files
= SHOW_NORMAL_UNTRACKED_FILES
;
1448 else if (!strcmp(v
, "all"))
1449 s
->show_untracked_files
= SHOW_ALL_UNTRACKED_FILES
;
1451 return error(_("Invalid untracked files mode '%s'"), v
);
1454 if (!strcmp(k
, "diff.renamelimit")) {
1455 if (s
->rename_limit
== -1)
1456 s
->rename_limit
= git_config_int(k
, v
);
1459 if (!strcmp(k
, "status.renamelimit")) {
1460 s
->rename_limit
= git_config_int(k
, v
);
1463 if (!strcmp(k
, "diff.renames")) {
1464 if (s
->detect_rename
== -1)
1465 s
->detect_rename
= git_config_rename(k
, v
);
1468 if (!strcmp(k
, "status.renames")) {
1469 s
->detect_rename
= git_config_rename(k
, v
);
1472 return git_diff_ui_config(k
, v
, NULL
);
1475 int cmd_status(int argc
, const char **argv
, const char *prefix
)
1477 static int no_renames
= -1;
1478 static const char *rename_score_arg
= (const char *)-1;
1479 static struct wt_status s
;
1480 unsigned int progress_flag
= 0;
1482 struct object_id oid
;
1483 static struct option builtin_status_options
[] = {
1484 OPT__VERBOSE(&verbose
, N_("be verbose")),
1485 OPT_SET_INT('s', "short", &status_format
,
1486 N_("show status concisely"), STATUS_FORMAT_SHORT
),
1487 OPT_BOOL('b', "branch", &s
.show_branch
,
1488 N_("show branch information")),
1489 OPT_BOOL(0, "show-stash", &s
.show_stash
,
1490 N_("show stash information")),
1491 OPT_BOOL(0, "ahead-behind", &s
.ahead_behind_flags
,
1492 N_("compute full ahead/behind values")),
1493 OPT_CALLBACK_F(0, "porcelain", &status_format
,
1494 N_("version"), N_("machine-readable output"),
1495 PARSE_OPT_OPTARG
, opt_parse_porcelain
),
1496 OPT_SET_INT(0, "long", &status_format
,
1497 N_("show status in long format (default)"),
1498 STATUS_FORMAT_LONG
),
1499 OPT_BOOL('z', "null", &s
.null_termination
,
1500 N_("terminate entries with NUL")),
1501 { OPTION_STRING
, 'u', "untracked-files", &untracked_files_arg
,
1503 N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1504 PARSE_OPT_OPTARG
, NULL
, (intptr_t)"all" },
1505 { OPTION_STRING
, 0, "ignored", &ignored_arg
,
1507 N_("show ignored files, optional modes: traditional, matching, no. (Default: traditional)"),
1508 PARSE_OPT_OPTARG
, NULL
, (intptr_t)"traditional" },
1509 { OPTION_STRING
, 0, "ignore-submodules", &ignore_submodule_arg
, N_("when"),
1510 N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
1511 PARSE_OPT_OPTARG
, NULL
, (intptr_t)"all" },
1512 OPT_COLUMN(0, "column", &s
.colopts
, N_("list untracked files in columns")),
1513 OPT_BOOL(0, "no-renames", &no_renames
, N_("do not detect renames")),
1514 OPT_CALLBACK_F('M', "find-renames", &rename_score_arg
,
1515 N_("n"), N_("detect renames, optionally set similarity index"),
1516 PARSE_OPT_OPTARG
| PARSE_OPT_NONEG
, opt_parse_rename_score
),
1520 if (argc
== 2 && !strcmp(argv
[1], "-h"))
1521 usage_with_options(builtin_status_usage
, builtin_status_options
);
1523 prepare_repo_settings(the_repository
);
1524 the_repository
->settings
.command_requires_full_index
= 0;
1526 status_init_config(&s
, git_status_config
);
1527 argc
= parse_options(argc
, argv
, prefix
,
1528 builtin_status_options
,
1529 builtin_status_usage
, 0);
1530 finalize_colopts(&s
.colopts
, -1);
1531 finalize_deferred_config(&s
);
1533 handle_untracked_files_arg(&s
);
1534 handle_ignored_arg(&s
);
1536 if (s
.show_ignored_mode
== SHOW_MATCHING_IGNORED
&&
1537 s
.show_untracked_files
== SHOW_NO_UNTRACKED_FILES
)
1538 die(_("Unsupported combination of ignored and untracked-files arguments"));
1540 parse_pathspec(&s
.pathspec
, 0,
1541 PATHSPEC_PREFER_FULL
,
1544 if (status_format
!= STATUS_FORMAT_PORCELAIN
&&
1545 status_format
!= STATUS_FORMAT_PORCELAIN_V2
)
1546 progress_flag
= REFRESH_PROGRESS
;
1547 repo_read_index(the_repository
);
1548 refresh_index(&the_index
,
1549 REFRESH_QUIET
|REFRESH_UNMERGED
|progress_flag
,
1550 &s
.pathspec
, NULL
, NULL
);
1552 if (use_optional_locks())
1553 fd
= hold_locked_index(&index_lock
, 0);
1557 s
.is_initial
= get_oid(s
.reference
, &oid
) ? 1 : 0;
1559 oidcpy(&s
.oid_commit
, &oid
);
1561 s
.ignore_submodule_arg
= ignore_submodule_arg
;
1562 s
.status_format
= status_format
;
1563 s
.verbose
= verbose
;
1564 if (no_renames
!= -1)
1565 s
.detect_rename
= !no_renames
;
1566 if ((intptr_t)rename_score_arg
!= -1) {
1567 if (s
.detect_rename
< DIFF_DETECT_RENAME
)
1568 s
.detect_rename
= DIFF_DETECT_RENAME
;
1569 if (rename_score_arg
)
1570 s
.rename_score
= parse_rename_score(&rename_score_arg
);
1573 wt_status_collect(&s
);
1576 repo_update_index_if_able(the_repository
, &index_lock
);
1578 if (s
.relative_paths
)
1581 wt_status_print(&s
);
1582 wt_status_collect_free_buffers(&s
);
1587 static int git_commit_config(const char *k
, const char *v
, void *cb
)
1589 struct wt_status
*s
= cb
;
1592 if (!strcmp(k
, "commit.template"))
1593 return git_config_pathname(&template_file
, k
, v
);
1594 if (!strcmp(k
, "commit.status")) {
1595 include_status
= git_config_bool(k
, v
);
1598 if (!strcmp(k
, "commit.cleanup"))
1599 return git_config_string(&cleanup_arg
, k
, v
);
1600 if (!strcmp(k
, "commit.gpgsign")) {
1601 sign_commit
= git_config_bool(k
, v
) ? "" : NULL
;
1604 if (!strcmp(k
, "commit.verbose")) {
1606 config_commit_verbose
= git_config_bool_or_int(k
, v
, &is_bool
);
1610 status
= git_gpg_config(k
, v
, NULL
);
1613 return git_status_config(k
, v
, s
);
1616 int cmd_commit(int argc
, const char **argv
, const char *prefix
)
1618 static struct wt_status s
;
1619 static struct option builtin_commit_options
[] = {
1620 OPT__QUIET(&quiet
, N_("suppress summary after successful commit")),
1621 OPT__VERBOSE(&verbose
, N_("show diff in commit message template")),
1623 OPT_GROUP(N_("Commit message options")),
1624 OPT_FILENAME('F', "file", &logfile
, N_("read message from file")),
1625 OPT_STRING(0, "author", &force_author
, N_("author"), N_("override author for commit")),
1626 OPT_STRING(0, "date", &force_date
, N_("date"), N_("override date for commit")),
1627 OPT_CALLBACK('m', "message", &message
, N_("message"), N_("commit message"), opt_parse_m
),
1628 OPT_STRING('c', "reedit-message", &edit_message
, N_("commit"), N_("reuse and edit message from specified commit")),
1629 OPT_STRING('C', "reuse-message", &use_message
, N_("commit"), N_("reuse message from specified commit")),
1631 * TRANSLATORS: Leave "[(amend|reword):]" as-is,
1632 * and only translate <commit>.
1634 OPT_STRING(0, "fixup", &fixup_message
, N_("[(amend|reword):]commit"), N_("use autosquash formatted message to fixup or amend/reword specified commit")),
1635 OPT_STRING(0, "squash", &squash_message
, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
1636 OPT_BOOL(0, "reset-author", &renew_authorship
, N_("the commit is authored by me now (used with -C/-c/--amend)")),
1637 OPT_CALLBACK_F(0, "trailer", NULL
, N_("trailer"), N_("add custom trailer(s)"), PARSE_OPT_NONEG
, opt_pass_trailer
),
1638 OPT_BOOL('s', "signoff", &signoff
, N_("add a Signed-off-by trailer")),
1639 OPT_FILENAME('t', "template", &template_file
, N_("use specified template file")),
1640 OPT_BOOL('e', "edit", &edit_flag
, N_("force edit of commit")),
1641 OPT_CLEANUP(&cleanup_arg
),
1642 OPT_BOOL(0, "status", &include_status
, N_("include status in commit message template")),
1643 { OPTION_STRING
, 'S', "gpg-sign", &sign_commit
, N_("key-id"),
1644 N_("GPG sign commit"), PARSE_OPT_OPTARG
, NULL
, (intptr_t) "" },
1645 /* end commit message options */
1647 OPT_GROUP(N_("Commit contents options")),
1648 OPT_BOOL('a', "all", &all
, N_("commit all changed files")),
1649 OPT_BOOL('i', "include", &also
, N_("add specified files to index for commit")),
1650 OPT_BOOL(0, "interactive", &interactive
, N_("interactively add files")),
1651 OPT_BOOL('p', "patch", &patch_interactive
, N_("interactively add changes")),
1652 OPT_BOOL('o', "only", &only
, N_("commit only specified files")),
1653 OPT_BOOL('n', "no-verify", &no_verify
, N_("bypass pre-commit and commit-msg hooks")),
1654 OPT_BOOL(0, "dry-run", &dry_run
, N_("show what would be committed")),
1655 OPT_SET_INT(0, "short", &status_format
, N_("show status concisely"),
1656 STATUS_FORMAT_SHORT
),
1657 OPT_BOOL(0, "branch", &s
.show_branch
, N_("show branch information")),
1658 OPT_BOOL(0, "ahead-behind", &s
.ahead_behind_flags
,
1659 N_("compute full ahead/behind values")),
1660 OPT_SET_INT(0, "porcelain", &status_format
,
1661 N_("machine-readable output"), STATUS_FORMAT_PORCELAIN
),
1662 OPT_SET_INT(0, "long", &status_format
,
1663 N_("show status in long format (default)"),
1664 STATUS_FORMAT_LONG
),
1665 OPT_BOOL('z', "null", &s
.null_termination
,
1666 N_("terminate entries with NUL")),
1667 OPT_BOOL(0, "amend", &amend
, N_("amend previous commit")),
1668 OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite
, N_("bypass post-rewrite hook")),
1669 { 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" },
1670 OPT_PATHSPEC_FROM_FILE(&pathspec_from_file
),
1671 OPT_PATHSPEC_FILE_NUL(&pathspec_file_nul
),
1672 /* end commit contents options */
1674 OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty
,
1675 N_("ok to record an empty change")),
1676 OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message
,
1677 N_("ok to record a change with an empty message")),
1682 struct strbuf sb
= STRBUF_INIT
;
1683 struct strbuf author_ident
= STRBUF_INIT
;
1684 const char *index_file
, *reflog_msg
;
1685 struct object_id oid
;
1686 struct commit_list
*parents
= NULL
;
1687 struct stat statbuf
;
1688 struct commit
*current_head
= NULL
;
1689 struct commit_extra_header
*extra
= NULL
;
1690 struct strbuf err
= STRBUF_INIT
;
1692 if (argc
== 2 && !strcmp(argv
[1], "-h"))
1693 usage_with_options(builtin_commit_usage
, builtin_commit_options
);
1695 prepare_repo_settings(the_repository
);
1696 the_repository
->settings
.command_requires_full_index
= 0;
1698 status_init_config(&s
, git_commit_config
);
1699 s
.commit_template
= 1;
1700 status_format
= STATUS_FORMAT_NONE
; /* Ignore status.short */
1703 if (get_oid("HEAD", &oid
))
1704 current_head
= NULL
;
1706 current_head
= lookup_commit_or_die(&oid
, "HEAD");
1707 if (parse_commit(current_head
))
1708 die(_("could not parse HEAD commit"));
1710 verbose
= -1; /* unspecified */
1711 argc
= parse_and_validate_options(argc
, argv
, builtin_commit_options
,
1712 builtin_commit_usage
,
1713 prefix
, current_head
, &s
);
1715 verbose
= (config_commit_verbose
< 0) ? 0 : config_commit_verbose
;
1718 return dry_run_commit(argv
, prefix
, current_head
, &s
);
1719 index_file
= prepare_index(argv
, prefix
, current_head
, 0);
1721 /* Set up everything for writing the commit object. This includes
1722 running hooks, writing the trees, and interacting with the user. */
1723 if (!prepare_to_commit(index_file
, prefix
,
1724 current_head
, &s
, &author_ident
)) {
1725 rollback_index_files();
1729 /* Determine parents */
1730 reflog_msg
= getenv("GIT_REFLOG_ACTION");
1731 if (!current_head
) {
1733 reflog_msg
= "commit (initial)";
1736 reflog_msg
= "commit (amend)";
1737 parents
= copy_commit_list(current_head
->parents
);
1738 } else if (whence
== FROM_MERGE
) {
1739 struct strbuf m
= STRBUF_INIT
;
1741 int allow_fast_forward
= 1;
1742 struct commit_list
**pptr
= &parents
;
1745 reflog_msg
= "commit (merge)";
1746 pptr
= commit_list_append(current_head
, pptr
);
1747 fp
= xfopen(git_path_merge_head(the_repository
), "r");
1748 while (strbuf_getline_lf(&m
, fp
) != EOF
) {
1749 struct commit
*parent
;
1751 parent
= get_merge_parent(m
.buf
);
1753 die(_("Corrupt MERGE_HEAD file (%s)"), m
.buf
);
1754 pptr
= commit_list_append(parent
, pptr
);
1758 if (!stat(git_path_merge_mode(the_repository
), &statbuf
)) {
1759 if (strbuf_read_file(&sb
, git_path_merge_mode(the_repository
), 0) < 0)
1760 die_errno(_("could not read MERGE_MODE"));
1761 if (!strcmp(sb
.buf
, "no-ff"))
1762 allow_fast_forward
= 0;
1764 if (allow_fast_forward
)
1765 reduce_heads_replace(&parents
);
1768 reflog_msg
= is_from_cherry_pick(whence
)
1769 ? "commit (cherry-pick)"
1770 : is_from_rebase(whence
)
1773 commit_list_insert(current_head
, &parents
);
1776 /* Finally, get the commit message */
1778 if (strbuf_read_file(&sb
, git_path_commit_editmsg(), 0) < 0) {
1779 int saved_errno
= errno
;
1780 rollback_index_files();
1781 die(_("could not read commit message: %s"), strerror(saved_errno
));
1784 cleanup_message(&sb
, cleanup_mode
, verbose
);
1786 if (message_is_empty(&sb
, cleanup_mode
) && !allow_empty_message
) {
1787 rollback_index_files();
1788 fprintf(stderr
, _("Aborting commit due to empty commit message.\n"));
1791 if (template_untouched(&sb
, template_file
, cleanup_mode
) && !allow_empty_message
) {
1792 rollback_index_files();
1793 fprintf(stderr
, _("Aborting commit; you did not edit the message.\n"));
1797 if (fixup_message
&& starts_with(sb
.buf
, "amend! ") &&
1798 !allow_empty_message
) {
1799 struct strbuf body
= STRBUF_INIT
;
1800 size_t len
= commit_subject_length(sb
.buf
);
1801 strbuf_addstr(&body
, sb
.buf
+ len
);
1802 if (message_is_empty(&body
, cleanup_mode
)) {
1803 rollback_index_files();
1804 fprintf(stderr
, _("Aborting commit due to empty commit message body.\n"));
1807 strbuf_release(&body
);
1811 const char *exclude_gpgsig
[3] = { "gpgsig", "gpgsig-sha256", NULL
};
1812 extra
= read_commit_extra_headers(current_head
, exclude_gpgsig
);
1814 struct commit_extra_header
**tail
= &extra
;
1815 append_merge_tag_headers(parents
, &tail
);
1818 if (commit_tree_extended(sb
.buf
, sb
.len
, &active_cache_tree
->oid
,
1819 parents
, &oid
, author_ident
.buf
, NULL
,
1820 sign_commit
, extra
)) {
1821 rollback_index_files();
1822 die(_("failed to write commit object"));
1824 strbuf_release(&author_ident
);
1825 free_commit_extra_headers(extra
);
1827 if (update_head_with_reflog(current_head
, &oid
, reflog_msg
, &sb
,
1829 rollback_index_files();
1833 sequencer_post_commit_cleanup(the_repository
, 0);
1834 unlink(git_path_merge_head(the_repository
));
1835 unlink(git_path_merge_msg(the_repository
));
1836 unlink(git_path_merge_mode(the_repository
));
1837 unlink(git_path_squash_msg(the_repository
));
1839 if (commit_index_files())
1840 die(_("repository has been updated, but unable to write\n"
1841 "new_index file. Check that disk is not full and quota is\n"
1842 "not exceeded, and then \"git restore --staged :/\" to recover."));
1844 git_test_write_commit_graph_or_die();
1846 repo_rerere(the_repository
, 0);
1847 run_auto_maintenance(quiet
);
1848 run_commit_hook(use_editor
, get_index_file(), "post-commit", NULL
);
1849 if (amend
&& !no_post_rewrite
) {
1850 commit_post_rewrite(the_repository
, current_head
, &oid
);
1853 unsigned int flags
= 0;
1856 flags
|= SUMMARY_INITIAL_COMMIT
;
1857 if (author_date_is_interesting())
1858 flags
|= SUMMARY_SHOW_AUTHOR_DATE
;
1859 print_commit_summary(the_repository
, prefix
,
1863 apply_autostash(git_path_merge_autostash(the_repository
));