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"
42 static const char * const builtin_commit_usage
[] = {
43 N_("git commit [<options>] [--] <pathspec>..."),
47 static const char * const builtin_status_usage
[] = {
48 N_("git status [<options>] [--] <pathspec>..."),
52 static const char empty_amend_advice
[] =
53 N_("You asked to amend the most recent commit, but doing so would make\n"
54 "it empty. You can repeat your command with --allow-empty, or you can\n"
55 "remove the commit entirely with \"git reset HEAD^\".\n");
57 static const char empty_cherry_pick_advice
[] =
58 N_("The previous cherry-pick is now empty, possibly due to conflict resolution.\n"
59 "If you wish to commit it anyway, use:\n"
61 " git commit --allow-empty\n"
64 static const char empty_rebase_pick_advice
[] =
65 N_("Otherwise, please use 'git rebase --skip'\n");
67 static const char empty_cherry_pick_advice_single
[] =
68 N_("Otherwise, please use 'git cherry-pick --skip'\n");
70 static const char empty_cherry_pick_advice_multi
[] =
73 " git cherry-pick --continue\n"
75 "to resume cherry-picking the remaining commits.\n"
76 "If you wish to skip this commit, use:\n"
78 " git cherry-pick --skip\n"
81 static const char *color_status_slots
[] = {
82 [WT_STATUS_HEADER
] = "header",
83 [WT_STATUS_UPDATED
] = "updated",
84 [WT_STATUS_CHANGED
] = "changed",
85 [WT_STATUS_UNTRACKED
] = "untracked",
86 [WT_STATUS_NOBRANCH
] = "noBranch",
87 [WT_STATUS_UNMERGED
] = "unmerged",
88 [WT_STATUS_LOCAL_BRANCH
] = "localBranch",
89 [WT_STATUS_REMOTE_BRANCH
] = "remoteBranch",
90 [WT_STATUS_ONBRANCH
] = "branch",
93 static const char *use_message_buffer
;
94 static struct lock_file index_lock
; /* real index */
95 static struct lock_file false_lock
; /* used only for partial commits */
102 static const char *logfile
, *force_author
;
103 static const char *template_file
;
105 * The _message variables are commit names from which to take
106 * the commit message and/or authorship.
108 static const char *author_message
, *author_message_buffer
;
109 static char *edit_message
, *use_message
;
110 static char *fixup_message
, *fixup_commit
, *squash_message
;
111 static const char *fixup_prefix
;
112 static int all
, also
, interactive
, patch_interactive
, only
, amend
, signoff
;
113 static int edit_flag
= -1; /* unspecified */
114 static int quiet
, verbose
, no_verify
, allow_empty
, dry_run
, renew_authorship
;
115 static int config_commit_verbose
= -1; /* unspecified */
116 static int no_post_rewrite
, allow_empty_message
, pathspec_file_nul
;
117 static char *untracked_files_arg
, *force_date
, *ignore_submodule_arg
, *ignored_arg
;
118 static char *sign_commit
, *pathspec_from_file
;
119 static struct strvec trailer_args
= STRVEC_INIT
;
122 * The default commit message cleanup mode will remove the lines
123 * beginning with # (shell comments) and leading and trailing
124 * whitespaces (empty lines or containing only whitespaces)
125 * if editor is used, and only the whitespaces if the message
126 * is specified explicitly.
128 static enum commit_msg_cleanup_mode cleanup_mode
;
129 static const char *cleanup_arg
;
131 static enum commit_whence whence
;
132 static int use_editor
= 1, include_status
= 1;
133 static int have_option_m
;
134 static struct strbuf message
= STRBUF_INIT
;
136 static enum wt_status_format status_format
= STATUS_FORMAT_UNSPECIFIED
;
138 static int opt_pass_trailer(const struct option
*opt
, const char *arg
, int unset
)
140 BUG_ON_OPT_NEG(unset
);
142 strvec_pushl(&trailer_args
, "--trailer", arg
, NULL
);
146 static int opt_parse_porcelain(const struct option
*opt
, const char *arg
, int unset
)
148 enum wt_status_format
*value
= (enum wt_status_format
*)opt
->value
;
150 *value
= STATUS_FORMAT_NONE
;
152 *value
= STATUS_FORMAT_PORCELAIN
;
153 else if (!strcmp(arg
, "v1") || !strcmp(arg
, "1"))
154 *value
= STATUS_FORMAT_PORCELAIN
;
155 else if (!strcmp(arg
, "v2") || !strcmp(arg
, "2"))
156 *value
= STATUS_FORMAT_PORCELAIN_V2
;
158 die("unsupported porcelain version '%s'", arg
);
163 static int opt_parse_m(const struct option
*opt
, const char *arg
, int unset
)
165 struct strbuf
*buf
= opt
->value
;
168 strbuf_setlen(buf
, 0);
172 strbuf_addch(buf
, '\n');
173 strbuf_addstr(buf
, arg
);
174 strbuf_complete_line(buf
);
179 static int opt_parse_rename_score(const struct option
*opt
, const char *arg
, int unset
)
181 const char **value
= opt
->value
;
183 BUG_ON_OPT_NEG(unset
);
185 if (arg
!= NULL
&& *arg
== '=')
192 static void determine_whence(struct wt_status
*s
)
194 if (file_exists(git_path_merge_head(the_repository
)))
196 else if (!sequencer_determine_whence(the_repository
, &whence
))
197 whence
= FROM_COMMIT
;
202 static void status_init_config(struct wt_status
*s
, config_fn_t fn
)
204 wt_status_prepare(the_repository
, s
);
205 init_diff_ui_defaults();
208 s
->hints
= advice_enabled(ADVICE_STATUS_HINTS
); /* must come after git_config() */
211 static void rollback_index_files(void)
213 switch (commit_style
) {
215 break; /* nothing to do */
217 rollback_lock_file(&index_lock
);
220 rollback_lock_file(&index_lock
);
221 rollback_lock_file(&false_lock
);
226 static int commit_index_files(void)
230 switch (commit_style
) {
232 break; /* nothing to do */
234 err
= commit_lock_file(&index_lock
);
237 err
= commit_lock_file(&index_lock
);
238 rollback_lock_file(&false_lock
);
246 * Take a union of paths in the index and the named tree (typically, "HEAD"),
247 * and return the paths that match the given pattern in list.
249 static int list_paths(struct string_list
*list
, const char *with_tree
,
250 const struct pathspec
*pattern
)
258 m
= xcalloc(1, pattern
->nr
);
261 char *max_prefix
= common_prefix(pattern
);
262 overlay_tree_on_index(&the_index
, with_tree
, max_prefix
);
266 /* TODO: audit for interaction with sparse-index. */
267 ensure_full_index(&the_index
);
268 for (i
= 0; i
< active_nr
; i
++) {
269 const struct cache_entry
*ce
= active_cache
[i
];
270 struct string_list_item
*item
;
272 if (ce
->ce_flags
& CE_UPDATE
)
274 if (!ce_path_match(&the_index
, ce
, pattern
, m
))
276 item
= string_list_insert(list
, ce
->name
);
277 if (ce_skip_worktree(ce
))
278 item
->util
= item
; /* better a valid pointer than a fake one */
281 ret
= report_path_error(m
, pattern
);
286 static void add_remove_files(struct string_list
*list
)
289 for (i
= 0; i
< list
->nr
; i
++) {
291 struct string_list_item
*p
= &(list
->items
[i
]);
293 /* p->util is skip-worktree */
297 if (!lstat(p
->string
, &st
)) {
298 if (add_to_cache(p
->string
, &st
, 0))
299 die(_("updating files failed"));
301 remove_file_from_cache(p
->string
);
305 static void create_base_index(const struct commit
*current_head
)
308 struct unpack_trees_options opts
;
316 memset(&opts
, 0, sizeof(opts
));
320 opts
.src_index
= &the_index
;
321 opts
.dst_index
= &the_index
;
323 opts
.fn
= oneway_merge
;
324 tree
= parse_tree_indirect(¤t_head
->object
.oid
);
326 die(_("failed to unpack HEAD tree object"));
328 init_tree_desc(&t
, tree
->buffer
, tree
->size
);
329 if (unpack_trees(1, &t
, &opts
))
330 exit(128); /* We've already reported the error, finish dying */
333 static void refresh_cache_or_die(int refresh_flags
)
336 * refresh_flags contains REFRESH_QUIET, so the only errors
337 * are for unmerged entries.
339 if (refresh_cache(refresh_flags
| REFRESH_IN_PORCELAIN
))
340 die_resolve_conflict("commit");
343 static const char *prepare_index(const char **argv
, const char *prefix
,
344 const struct commit
*current_head
, int is_status
)
346 struct string_list partial
= STRING_LIST_INIT_DUP
;
347 struct pathspec pathspec
;
348 int refresh_flags
= REFRESH_QUIET
;
352 refresh_flags
|= REFRESH_UNMERGED
;
353 parse_pathspec(&pathspec
, 0,
354 PATHSPEC_PREFER_FULL
,
357 if (pathspec_from_file
) {
359 die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "--interactive/--patch");
362 die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "-a");
365 die(_("'%s' and pathspec arguments cannot be used together"), "--pathspec-from-file");
367 parse_pathspec_file(&pathspec
, 0,
368 PATHSPEC_PREFER_FULL
,
369 prefix
, pathspec_from_file
, pathspec_file_nul
);
370 } else if (pathspec_file_nul
) {
371 die(_("the option '%s' requires '%s'"), "--pathspec-file-nul", "--pathspec-from-file");
374 if (!pathspec
.nr
&& (also
|| (only
&& !allow_empty
&&
375 (!amend
|| (fixup_message
&& strcmp(fixup_prefix
, "amend"))))))
376 die(_("No paths with --include/--only does not make sense."));
378 if (read_cache_preload(&pathspec
) < 0)
379 die(_("index file corrupt"));
382 char *old_index_env
= NULL
, *old_repo_index_file
;
383 hold_locked_index(&index_lock
, LOCK_DIE_ON_ERROR
);
385 refresh_cache_or_die(refresh_flags
);
387 if (write_locked_index(&the_index
, &index_lock
, 0))
388 die(_("unable to create temporary index"));
390 old_repo_index_file
= the_repository
->index_file
;
391 the_repository
->index_file
=
392 (char *)get_lock_file_path(&index_lock
);
393 old_index_env
= xstrdup_or_null(getenv(INDEX_ENVIRONMENT
));
394 setenv(INDEX_ENVIRONMENT
, the_repository
->index_file
, 1);
396 if (interactive_add(argv
, prefix
, patch_interactive
) != 0)
397 die(_("interactive add failed"));
399 the_repository
->index_file
= old_repo_index_file
;
400 if (old_index_env
&& *old_index_env
)
401 setenv(INDEX_ENVIRONMENT
, old_index_env
, 1);
403 unsetenv(INDEX_ENVIRONMENT
);
404 FREE_AND_NULL(old_index_env
);
407 read_cache_from(get_lock_file_path(&index_lock
));
408 if (update_main_cache_tree(WRITE_TREE_SILENT
) == 0) {
409 if (reopen_lock_file(&index_lock
) < 0)
410 die(_("unable to write index file"));
411 if (write_locked_index(&the_index
, &index_lock
, 0))
412 die(_("unable to update temporary index"));
414 warning(_("Failed to update main cache tree"));
416 commit_style
= COMMIT_NORMAL
;
417 ret
= get_lock_file_path(&index_lock
);
422 * Non partial, non as-is commit.
424 * (1) get the real index;
425 * (2) update the_index as necessary;
426 * (3) write the_index out to the real index (still locked);
427 * (4) return the name of the locked index file.
429 * The caller should run hooks on the locked real index, and
430 * (A) if all goes well, commit the real index;
431 * (B) on failure, rollback the real index.
433 if (all
|| (also
&& pathspec
.nr
)) {
434 hold_locked_index(&index_lock
, LOCK_DIE_ON_ERROR
);
435 add_files_to_cache(also
? prefix
: NULL
, &pathspec
, 0);
436 refresh_cache_or_die(refresh_flags
);
437 update_main_cache_tree(WRITE_TREE_SILENT
);
438 if (write_locked_index(&the_index
, &index_lock
, 0))
439 die(_("unable to write new_index file"));
440 commit_style
= COMMIT_NORMAL
;
441 ret
= get_lock_file_path(&index_lock
);
448 * (1) return the name of the real index file.
450 * The caller should run hooks on the real index,
451 * and create commit from the_index.
452 * We still need to refresh the index here.
454 if (!only
&& !pathspec
.nr
) {
455 hold_locked_index(&index_lock
, LOCK_DIE_ON_ERROR
);
456 refresh_cache_or_die(refresh_flags
);
457 if (active_cache_changed
458 || !cache_tree_fully_valid(active_cache_tree
))
459 update_main_cache_tree(WRITE_TREE_SILENT
);
460 if (write_locked_index(&the_index
, &index_lock
,
461 COMMIT_LOCK
| SKIP_IF_UNCHANGED
))
462 die(_("unable to write new_index file"));
463 commit_style
= COMMIT_AS_IS
;
464 ret
= get_index_file();
471 * (0) find the set of affected paths;
472 * (1) get lock on the real index file;
473 * (2) update the_index with the given paths;
474 * (3) write the_index out to the real index (still locked);
475 * (4) get lock on the false index file;
476 * (5) reset the_index from HEAD;
477 * (6) update the_index the same way as (2);
478 * (7) write the_index out to the false index file;
479 * (8) return the name of the false index file (still locked);
481 * The caller should run hooks on the locked false index, and
482 * create commit from it. Then
483 * (A) if all goes well, commit the real index;
484 * (B) on failure, rollback the real index;
485 * In either case, rollback the false index.
487 commit_style
= COMMIT_PARTIAL
;
489 if (whence
!= FROM_COMMIT
) {
490 if (whence
== FROM_MERGE
)
491 die(_("cannot do a partial commit during a merge."));
492 else if (is_from_cherry_pick(whence
))
493 die(_("cannot do a partial commit during a cherry-pick."));
494 else if (is_from_rebase(whence
))
495 die(_("cannot do a partial commit during a rebase."));
498 if (list_paths(&partial
, !current_head
? NULL
: "HEAD", &pathspec
))
502 if (read_cache() < 0)
503 die(_("cannot read the index"));
505 hold_locked_index(&index_lock
, LOCK_DIE_ON_ERROR
);
506 add_remove_files(&partial
);
507 refresh_cache(REFRESH_QUIET
);
508 update_main_cache_tree(WRITE_TREE_SILENT
);
509 if (write_locked_index(&the_index
, &index_lock
, 0))
510 die(_("unable to write new_index file"));
512 hold_lock_file_for_update(&false_lock
,
513 git_path("next-index-%"PRIuMAX
,
514 (uintmax_t) getpid()),
517 create_base_index(current_head
);
518 add_remove_files(&partial
);
519 refresh_cache(REFRESH_QUIET
);
521 if (write_locked_index(&the_index
, &false_lock
, 0))
522 die(_("unable to write temporary index file"));
525 ret
= get_lock_file_path(&false_lock
);
526 read_cache_from(ret
);
528 string_list_clear(&partial
, 0);
529 clear_pathspec(&pathspec
);
533 static int run_status(FILE *fp
, const char *index_file
, const char *prefix
, int nowarn
,
536 struct object_id oid
;
538 if (s
->relative_paths
)
543 s
->reference
= "HEAD^1";
545 s
->verbose
= verbose
;
546 s
->index_file
= index_file
;
549 s
->is_initial
= get_oid(s
->reference
, &oid
) ? 1 : 0;
551 oidcpy(&s
->oid_commit
, &oid
);
552 s
->status_format
= status_format
;
553 s
->ignore_submodule_arg
= ignore_submodule_arg
;
555 wt_status_collect(s
);
557 wt_status_collect_free_buffers(s
);
559 return s
->committable
;
562 static int is_a_merge(const struct commit
*current_head
)
564 return !!(current_head
->parents
&& current_head
->parents
->next
);
567 static void assert_split_ident(struct ident_split
*id
, const struct strbuf
*buf
)
569 if (split_ident_line(id
, buf
->buf
, buf
->len
) || !id
->date_begin
)
570 BUG("unable to parse our own ident: %s", buf
->buf
);
573 static void export_one(const char *var
, const char *s
, const char *e
, int hack
)
575 struct strbuf buf
= STRBUF_INIT
;
577 strbuf_addch(&buf
, hack
);
578 strbuf_add(&buf
, s
, e
- s
);
579 setenv(var
, buf
.buf
, 1);
580 strbuf_release(&buf
);
583 static int parse_force_date(const char *in
, struct strbuf
*out
)
585 strbuf_addch(out
, '@');
587 if (parse_date(in
, out
) < 0) {
589 unsigned long t
= approxidate_careful(in
, &errors
);
592 strbuf_addf(out
, "%lu", t
);
598 static void set_ident_var(char **buf
, char *val
)
604 static void determine_author_info(struct strbuf
*author_ident
)
606 char *name
, *email
, *date
;
607 struct ident_split author
;
609 name
= xstrdup_or_null(getenv("GIT_AUTHOR_NAME"));
610 email
= xstrdup_or_null(getenv("GIT_AUTHOR_EMAIL"));
611 date
= xstrdup_or_null(getenv("GIT_AUTHOR_DATE"));
613 if (author_message
) {
614 struct ident_split ident
;
618 a
= find_commit_header(author_message_buffer
, "author", &len
);
620 die(_("commit '%s' lacks author header"), author_message
);
621 if (split_ident_line(&ident
, a
, len
) < 0)
622 die(_("commit '%s' has malformed author line"), author_message
);
624 set_ident_var(&name
, xmemdupz(ident
.name_begin
, ident
.name_end
- ident
.name_begin
));
625 set_ident_var(&email
, xmemdupz(ident
.mail_begin
, ident
.mail_end
- ident
.mail_begin
));
627 if (ident
.date_begin
) {
628 struct strbuf date_buf
= STRBUF_INIT
;
629 strbuf_addch(&date_buf
, '@');
630 strbuf_add(&date_buf
, ident
.date_begin
, ident
.date_end
- ident
.date_begin
);
631 strbuf_addch(&date_buf
, ' ');
632 strbuf_add(&date_buf
, ident
.tz_begin
, ident
.tz_end
- ident
.tz_begin
);
633 set_ident_var(&date
, strbuf_detach(&date_buf
, NULL
));
638 struct ident_split ident
;
640 if (split_ident_line(&ident
, force_author
, strlen(force_author
)) < 0)
641 die(_("malformed --author parameter"));
642 set_ident_var(&name
, xmemdupz(ident
.name_begin
, ident
.name_end
- ident
.name_begin
));
643 set_ident_var(&email
, xmemdupz(ident
.mail_begin
, ident
.mail_end
- ident
.mail_begin
));
647 struct strbuf date_buf
= STRBUF_INIT
;
648 if (parse_force_date(force_date
, &date_buf
))
649 die(_("invalid date format: %s"), force_date
);
650 set_ident_var(&date
, strbuf_detach(&date_buf
, NULL
));
653 strbuf_addstr(author_ident
, fmt_ident(name
, email
, WANT_AUTHOR_IDENT
, date
,
655 assert_split_ident(&author
, author_ident
);
656 export_one("GIT_AUTHOR_NAME", author
.name_begin
, author
.name_end
, 0);
657 export_one("GIT_AUTHOR_EMAIL", author
.mail_begin
, author
.mail_end
, 0);
658 export_one("GIT_AUTHOR_DATE", author
.date_begin
, author
.tz_end
, '@');
664 static int author_date_is_interesting(void)
666 return author_message
|| force_date
;
669 static void adjust_comment_line_char(const struct strbuf
*sb
)
671 char candidates
[] = "#;@!$%^&|:";
675 comment_line_char
= candidates
[0];
676 if (!memchr(sb
->buf
, comment_line_char
, sb
->len
))
680 candidate
= strchr(candidates
, *p
);
683 for (p
= sb
->buf
; *p
; p
++) {
684 if ((p
[0] == '\n' || p
[0] == '\r') && p
[1]) {
685 candidate
= strchr(candidates
, p
[1]);
691 for (p
= candidates
; *p
== ' '; p
++)
694 die(_("unable to select a comment character that is not used\n"
695 "in the current commit message"));
696 comment_line_char
= *p
;
699 static void prepare_amend_commit(struct commit
*commit
, struct strbuf
*sb
,
700 struct pretty_print_context
*ctx
)
702 const char *buffer
, *subject
, *fmt
;
704 buffer
= get_commit_buffer(commit
, NULL
);
705 find_commit_subject(buffer
, &subject
);
707 * If we amend the 'amend!' commit then we don't want to
708 * duplicate the subject line.
710 fmt
= starts_with(subject
, "amend!") ? "%b" : "%B";
711 format_commit_message(commit
, fmt
, sb
, ctx
);
712 unuse_commit_buffer(commit
, buffer
);
715 static int prepare_to_commit(const char *index_file
, const char *prefix
,
716 struct commit
*current_head
,
718 struct strbuf
*author_ident
)
721 struct strbuf committer_ident
= STRBUF_INIT
;
723 struct strbuf sb
= STRBUF_INIT
;
724 const char *hook_arg1
= NULL
;
725 const char *hook_arg2
= NULL
;
726 int clean_message_contents
= (cleanup_mode
!= COMMIT_MSG_CLEANUP_NONE
);
727 int old_display_comment_prefix
;
728 int merge_contains_scissors
= 0;
731 /* This checks and barfs if author is badly specified */
732 determine_author_info(author_ident
);
734 if (!no_verify
&& run_commit_hook(use_editor
, index_file
, &invoked_hook
,
738 if (squash_message
) {
740 * Insert the proper subject line before other commit
741 * message options add their content.
743 if (use_message
&& !strcmp(use_message
, squash_message
))
744 strbuf_addstr(&sb
, "squash! ");
746 struct pretty_print_context ctx
= {0};
748 c
= lookup_commit_reference_by_name(squash_message
);
750 die(_("could not lookup commit %s"), squash_message
);
751 ctx
.output_encoding
= get_commit_output_encoding();
752 format_commit_message(c
, "squash! %s\n\n", &sb
,
757 if (have_option_m
&& !fixup_message
) {
758 strbuf_addbuf(&sb
, &message
);
759 hook_arg1
= "message";
760 } else if (logfile
&& !strcmp(logfile
, "-")) {
762 fprintf(stderr
, _("(reading log message from standard input)\n"));
763 if (strbuf_read(&sb
, 0, 0) < 0)
764 die_errno(_("could not read log from standard input"));
765 hook_arg1
= "message";
766 } else if (logfile
) {
767 if (strbuf_read_file(&sb
, logfile
, 0) < 0)
768 die_errno(_("could not read log file '%s'"),
770 hook_arg1
= "message";
771 } else if (use_message
) {
773 buffer
= strstr(use_message_buffer
, "\n\n");
775 strbuf_addstr(&sb
, skip_blank_lines(buffer
+ 2));
776 hook_arg1
= "commit";
777 hook_arg2
= use_message
;
778 } else if (fixup_message
) {
779 struct pretty_print_context ctx
= {0};
780 struct commit
*commit
;
782 commit
= lookup_commit_reference_by_name(fixup_commit
);
784 die(_("could not lookup commit %s"), fixup_commit
);
785 ctx
.output_encoding
= get_commit_output_encoding();
786 fmt
= xstrfmt("%s! %%s\n\n", fixup_prefix
);
787 format_commit_message(commit
, fmt
, &sb
, &ctx
);
789 hook_arg1
= "message";
792 * Only `-m` commit message option is checked here, as
793 * it supports `--fixup` to append the commit message.
795 * The other commit message options `-c`/`-C`/`-F` are
796 * incompatible with all the forms of `--fixup` and
797 * have already errored out while parsing the `git commit`
800 if (have_option_m
&& !strcmp(fixup_prefix
, "fixup"))
801 strbuf_addbuf(&sb
, &message
);
803 if (!strcmp(fixup_prefix
, "amend")) {
805 die(_("options '%s' and '%s:%s' cannot be used together"), "-m", "--fixup", fixup_message
);
806 prepare_amend_commit(commit
, &sb
, &ctx
);
808 } else if (!stat(git_path_merge_msg(the_repository
), &statbuf
)) {
809 size_t merge_msg_start
;
812 * prepend SQUASH_MSG here if it exists and a
813 * "merge --squash" was originally performed
815 if (!stat(git_path_squash_msg(the_repository
), &statbuf
)) {
816 if (strbuf_read_file(&sb
, git_path_squash_msg(the_repository
), 0) < 0)
817 die_errno(_("could not read SQUASH_MSG"));
818 hook_arg1
= "squash";
822 merge_msg_start
= sb
.len
;
823 if (strbuf_read_file(&sb
, git_path_merge_msg(the_repository
), 0) < 0)
824 die_errno(_("could not read MERGE_MSG"));
826 if (cleanup_mode
== COMMIT_MSG_CLEANUP_SCISSORS
&&
827 wt_status_locate_end(sb
.buf
+ merge_msg_start
,
828 sb
.len
- merge_msg_start
) <
829 sb
.len
- merge_msg_start
)
830 merge_contains_scissors
= 1;
831 } else if (!stat(git_path_squash_msg(the_repository
), &statbuf
)) {
832 if (strbuf_read_file(&sb
, git_path_squash_msg(the_repository
), 0) < 0)
833 die_errno(_("could not read SQUASH_MSG"));
834 hook_arg1
= "squash";
835 } else if (template_file
) {
836 if (strbuf_read_file(&sb
, template_file
, 0) < 0)
837 die_errno(_("could not read '%s'"), template_file
);
838 hook_arg1
= "template";
839 clean_message_contents
= 0;
843 * The remaining cases don't modify the template message, but
844 * just set the argument(s) to the prepare-commit-msg hook.
846 else if (whence
== FROM_MERGE
)
848 else if (is_from_cherry_pick(whence
) || whence
== FROM_REBASE_PICK
) {
849 hook_arg1
= "commit";
850 hook_arg2
= "CHERRY_PICK_HEAD";
853 if (squash_message
) {
855 * If squash_commit was used for the commit subject,
856 * then we're possibly hijacking other commit log options.
857 * Reset the hook args to tell the real story.
859 hook_arg1
= "message";
863 s
->fp
= fopen_for_writing(git_path_commit_editmsg());
865 die_errno(_("could not open '%s'"), git_path_commit_editmsg());
867 /* Ignore status.displayCommentPrefix: we do need comments in COMMIT_EDITMSG. */
868 old_display_comment_prefix
= s
->display_comment_prefix
;
869 s
->display_comment_prefix
= 1;
872 * Most hints are counter-productive when the commit has
877 if (clean_message_contents
)
878 strbuf_stripspace(&sb
, 0);
881 append_signoff(&sb
, ignore_non_trailer(sb
.buf
, sb
.len
), 0);
883 if (fwrite(sb
.buf
, 1, sb
.len
, s
->fp
) < sb
.len
)
884 die_errno(_("could not write commit template"));
886 if (auto_comment_line_char
)
887 adjust_comment_line_char(&sb
);
890 /* This checks if committer ident is explicitly given */
891 strbuf_addstr(&committer_ident
, git_committer_info(IDENT_STRICT
));
892 if (use_editor
&& include_status
) {
894 int saved_color_setting
;
895 struct ident_split ci
, ai
;
896 const char *hint_cleanup_all
= allow_empty_message
?
897 _("Please enter the commit message for your changes."
898 " Lines starting\nwith '%c' will be ignored.\n") :
899 _("Please enter the commit message for your changes."
900 " Lines starting\nwith '%c' will be ignored, and an empty"
901 " message aborts the commit.\n");
902 const char *hint_cleanup_space
= allow_empty_message
?
903 _("Please enter the commit message for your changes."
905 "with '%c' will be kept; you may remove them"
906 " yourself if you want to.\n") :
907 _("Please enter the commit message for your changes."
909 "with '%c' will be kept; you may remove them"
910 " yourself if you want to.\n"
911 "An empty message aborts the commit.\n");
912 if (whence
!= FROM_COMMIT
) {
913 if (cleanup_mode
== COMMIT_MSG_CLEANUP_SCISSORS
&&
914 !merge_contains_scissors
)
915 wt_status_add_cut_line(s
->fp
);
918 whence
== FROM_MERGE
?
920 "It looks like you may be committing a merge.\n"
921 "If this is not correct, please run\n"
922 " git update-ref -d MERGE_HEAD\n"
923 "and try again.\n") :
925 "It looks like you may be committing a cherry-pick.\n"
926 "If this is not correct, please run\n"
927 " git update-ref -d CHERRY_PICK_HEAD\n"
928 "and try again.\n"));
931 fprintf(s
->fp
, "\n");
932 if (cleanup_mode
== COMMIT_MSG_CLEANUP_ALL
)
933 status_printf(s
, GIT_COLOR_NORMAL
, hint_cleanup_all
, comment_line_char
);
934 else if (cleanup_mode
== COMMIT_MSG_CLEANUP_SCISSORS
) {
935 if (whence
== FROM_COMMIT
&& !merge_contains_scissors
)
936 wt_status_add_cut_line(s
->fp
);
937 } else /* COMMIT_MSG_CLEANUP_SPACE, that is. */
938 status_printf(s
, GIT_COLOR_NORMAL
, hint_cleanup_space
, comment_line_char
);
941 * These should never fail because they come from our own
942 * fmt_ident. They may fail the sane_ident test, but we know
943 * that the name and mail pointers will at least be valid,
944 * which is enough for our tests and printing here.
946 assert_split_ident(&ai
, author_ident
);
947 assert_split_ident(&ci
, &committer_ident
);
949 if (ident_cmp(&ai
, &ci
))
950 status_printf_ln(s
, GIT_COLOR_NORMAL
,
952 "Author: %.*s <%.*s>"),
953 ident_shown
++ ? "" : "\n",
954 (int)(ai
.name_end
- ai
.name_begin
), ai
.name_begin
,
955 (int)(ai
.mail_end
- ai
.mail_begin
), ai
.mail_begin
);
957 if (author_date_is_interesting())
958 status_printf_ln(s
, GIT_COLOR_NORMAL
,
961 ident_shown
++ ? "" : "\n",
962 show_ident_date(&ai
, DATE_MODE(NORMAL
)));
964 if (!committer_ident_sufficiently_given())
965 status_printf_ln(s
, GIT_COLOR_NORMAL
,
967 "Committer: %.*s <%.*s>"),
968 ident_shown
++ ? "" : "\n",
969 (int)(ci
.name_end
- ci
.name_begin
), ci
.name_begin
,
970 (int)(ci
.mail_end
- ci
.mail_begin
), ci
.mail_begin
);
972 status_printf_ln(s
, GIT_COLOR_NORMAL
, "%s", ""); /* Add new line for clarity */
974 saved_color_setting
= s
->use_color
;
976 committable
= run_status(s
->fp
, index_file
, prefix
, 1, s
);
977 s
->use_color
= saved_color_setting
;
978 string_list_clear(&s
->change
, 1);
980 struct object_id oid
;
981 const char *parent
= "HEAD";
983 if (!active_nr
&& read_cache() < 0)
984 die(_("Cannot read index"));
989 if (get_oid(parent
, &oid
)) {
992 /* TODO: audit for interaction with sparse-index. */
993 ensure_full_index(&the_index
);
994 for (i
= 0; i
< active_nr
; i
++)
995 if (ce_intent_to_add(active_cache
[i
]))
997 committable
= active_nr
- ita_nr
> 0;
1000 * Unless the user did explicitly request a submodule
1001 * ignore mode by passing a command line option we do
1002 * not ignore any changed submodule SHA-1s when
1003 * comparing index and parent, no matter what is
1004 * configured. Otherwise we won't commit any
1005 * submodules which were manually staged, which would
1006 * be really confusing.
1008 struct diff_flags flags
= DIFF_FLAGS_INIT
;
1009 flags
.override_submodule_config
= 1;
1010 if (ignore_submodule_arg
&&
1011 !strcmp(ignore_submodule_arg
, "all"))
1012 flags
.ignore_submodules
= 1;
1013 committable
= index_differs_from(the_repository
,
1017 strbuf_release(&committer_ident
);
1021 if (trailer_args
.nr
) {
1022 struct child_process run_trailer
= CHILD_PROCESS_INIT
;
1024 strvec_pushl(&run_trailer
.args
, "interpret-trailers",
1025 "--in-place", git_path_commit_editmsg(), NULL
);
1026 strvec_pushv(&run_trailer
.args
, trailer_args
.v
);
1027 run_trailer
.git_cmd
= 1;
1028 if (run_command(&run_trailer
))
1029 die(_("unable to pass trailers to --trailers"));
1030 strvec_clear(&trailer_args
);
1034 * Reject an attempt to record a non-merge empty commit without
1035 * explicit --allow-empty. In the cherry-pick case, it may be
1036 * empty due to conflict resolution, which the user should okay.
1038 if (!committable
&& whence
!= FROM_MERGE
&& !allow_empty
&&
1039 !(amend
&& is_a_merge(current_head
))) {
1040 s
->hints
= advice_enabled(ADVICE_STATUS_HINTS
);
1041 s
->display_comment_prefix
= old_display_comment_prefix
;
1042 run_status(stdout
, index_file
, prefix
, 0, s
);
1044 fputs(_(empty_amend_advice
), stderr
);
1045 else if (is_from_cherry_pick(whence
) ||
1046 whence
== FROM_REBASE_PICK
) {
1047 fputs(_(empty_cherry_pick_advice
), stderr
);
1048 if (whence
== FROM_CHERRY_PICK_SINGLE
)
1049 fputs(_(empty_cherry_pick_advice_single
), stderr
);
1050 else if (whence
== FROM_CHERRY_PICK_MULTI
)
1051 fputs(_(empty_cherry_pick_advice_multi
), stderr
);
1053 fputs(_(empty_rebase_pick_advice
), stderr
);
1058 if (!no_verify
&& invoked_hook
) {
1060 * Re-read the index as the pre-commit-commit hook was invoked
1061 * and could have updated it. We must do this before we invoke
1062 * the editor and after we invoke run_status above.
1066 read_cache_from(index_file
);
1068 if (update_main_cache_tree(0)) {
1069 error(_("Error building trees"));
1073 if (run_commit_hook(use_editor
, index_file
, NULL
, "prepare-commit-msg",
1074 git_path_commit_editmsg(), hook_arg1
, hook_arg2
, NULL
))
1078 struct strvec env
= STRVEC_INIT
;
1080 strvec_pushf(&env
, "GIT_INDEX_FILE=%s", index_file
);
1081 if (launch_editor(git_path_commit_editmsg(), NULL
, env
.v
)) {
1083 _("Please supply the message using either -m or -F option.\n"));
1090 run_commit_hook(use_editor
, index_file
, NULL
, "commit-msg",
1091 git_path_commit_editmsg(), NULL
)) {
1098 static const char *find_author_by_nickname(const char *name
)
1100 struct rev_info revs
;
1101 struct commit
*commit
;
1102 struct strbuf buf
= STRBUF_INIT
;
1106 repo_init_revisions(the_repository
, &revs
, NULL
);
1107 strbuf_addf(&buf
, "--author=%s", name
);
1112 setup_revisions(ac
, av
, &revs
, NULL
);
1113 revs
.mailmap
= xmalloc(sizeof(struct string_list
));
1114 string_list_init_nodup(revs
.mailmap
);
1115 read_mailmap(revs
.mailmap
);
1117 if (prepare_revision_walk(&revs
))
1118 die(_("revision walk setup failed"));
1119 commit
= get_revision(&revs
);
1121 struct pretty_print_context ctx
= {0};
1122 ctx
.date_mode
.type
= DATE_NORMAL
;
1123 strbuf_release(&buf
);
1124 format_commit_message(commit
, "%aN <%aE>", &buf
, &ctx
);
1125 release_revisions(&revs
);
1126 return strbuf_detach(&buf
, NULL
);
1128 die(_("--author '%s' is not 'Name <email>' and matches no existing author"), name
);
1131 static void handle_ignored_arg(struct wt_status
*s
)
1134 ; /* default already initialized */
1135 else if (!strcmp(ignored_arg
, "traditional"))
1136 s
->show_ignored_mode
= SHOW_TRADITIONAL_IGNORED
;
1137 else if (!strcmp(ignored_arg
, "no"))
1138 s
->show_ignored_mode
= SHOW_NO_IGNORED
;
1139 else if (!strcmp(ignored_arg
, "matching"))
1140 s
->show_ignored_mode
= SHOW_MATCHING_IGNORED
;
1142 die(_("Invalid ignored mode '%s'"), ignored_arg
);
1145 static void handle_untracked_files_arg(struct wt_status
*s
)
1147 if (!untracked_files_arg
)
1148 ; /* default already initialized */
1149 else if (!strcmp(untracked_files_arg
, "no"))
1150 s
->show_untracked_files
= SHOW_NO_UNTRACKED_FILES
;
1151 else if (!strcmp(untracked_files_arg
, "normal"))
1152 s
->show_untracked_files
= SHOW_NORMAL_UNTRACKED_FILES
;
1153 else if (!strcmp(untracked_files_arg
, "all"))
1154 s
->show_untracked_files
= SHOW_ALL_UNTRACKED_FILES
;
1156 * Please update $__git_untracked_file_modes in
1157 * git-completion.bash when you add new options
1160 die(_("Invalid untracked files mode '%s'"), untracked_files_arg
);
1163 static const char *read_commit_message(const char *name
)
1165 const char *out_enc
;
1166 struct commit
*commit
;
1168 commit
= lookup_commit_reference_by_name(name
);
1170 die(_("could not lookup commit %s"), name
);
1171 out_enc
= get_commit_output_encoding();
1172 return logmsg_reencode(commit
, NULL
, out_enc
);
1176 * Enumerate what needs to be propagated when --porcelain
1177 * is not in effect here.
1179 static struct status_deferred_config
{
1180 enum wt_status_format status_format
;
1182 enum ahead_behind_flags ahead_behind
;
1183 } status_deferred_config
= {
1184 STATUS_FORMAT_UNSPECIFIED
,
1185 -1, /* unspecified */
1186 AHEAD_BEHIND_UNSPECIFIED
,
1189 static void finalize_deferred_config(struct wt_status
*s
)
1191 int use_deferred_config
= (status_format
!= STATUS_FORMAT_PORCELAIN
&&
1192 status_format
!= STATUS_FORMAT_PORCELAIN_V2
&&
1193 !s
->null_termination
);
1195 if (s
->null_termination
) {
1196 if (status_format
== STATUS_FORMAT_NONE
||
1197 status_format
== STATUS_FORMAT_UNSPECIFIED
)
1198 status_format
= STATUS_FORMAT_PORCELAIN
;
1199 else if (status_format
== STATUS_FORMAT_LONG
)
1200 die(_("options '%s' and '%s' cannot be used together"), "--long", "-z");
1203 if (use_deferred_config
&& status_format
== STATUS_FORMAT_UNSPECIFIED
)
1204 status_format
= status_deferred_config
.status_format
;
1205 if (status_format
== STATUS_FORMAT_UNSPECIFIED
)
1206 status_format
= STATUS_FORMAT_NONE
;
1208 if (use_deferred_config
&& s
->show_branch
< 0)
1209 s
->show_branch
= status_deferred_config
.show_branch
;
1210 if (s
->show_branch
< 0)
1214 * If the user did not give a "--[no]-ahead-behind" command
1215 * line argument *AND* we will print in a human-readable format
1216 * (short, long etc.) then we inherit from the status.aheadbehind
1217 * config setting. In all other cases (and porcelain V[12] formats
1218 * in particular), we inherit _FULL for backwards compatibility.
1220 if (use_deferred_config
&&
1221 s
->ahead_behind_flags
== AHEAD_BEHIND_UNSPECIFIED
)
1222 s
->ahead_behind_flags
= status_deferred_config
.ahead_behind
;
1224 if (s
->ahead_behind_flags
== AHEAD_BEHIND_UNSPECIFIED
)
1225 s
->ahead_behind_flags
= AHEAD_BEHIND_FULL
;
1228 static void check_fixup_reword_options(int argc
, const char *argv
[]) {
1229 if (whence
!= FROM_COMMIT
) {
1230 if (whence
== FROM_MERGE
)
1231 die(_("You are in the middle of a merge -- cannot reword."));
1232 else if (is_from_cherry_pick(whence
))
1233 die(_("You are in the middle of a cherry-pick -- cannot reword."));
1236 die(_("reword option of '%s' and path '%s' cannot be used together"), "--fixup", *argv
);
1237 if (patch_interactive
|| interactive
|| all
|| also
|| only
)
1238 die(_("reword option of '%s' and '%s' cannot be used together"),
1239 "--fixup", "--patch/--interactive/--all/--include/--only");
1242 static int parse_and_validate_options(int argc
, const char *argv
[],
1243 const struct option
*options
,
1244 const char * const usage
[],
1246 struct commit
*current_head
,
1247 struct wt_status
*s
)
1249 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
1250 finalize_deferred_config(s
);
1252 if (force_author
&& !strchr(force_author
, '>'))
1253 force_author
= find_author_by_nickname(force_author
);
1255 if (force_author
&& renew_authorship
)
1256 die(_("options '%s' and '%s' cannot be used together"), "--reset-author", "--author");
1258 if (logfile
|| have_option_m
|| use_message
)
1261 /* Sanity check options */
1262 if (amend
&& !current_head
)
1263 die(_("You have nothing to amend."));
1264 if (amend
&& whence
!= FROM_COMMIT
) {
1265 if (whence
== FROM_MERGE
)
1266 die(_("You are in the middle of a merge -- cannot amend."));
1267 else if (is_from_cherry_pick(whence
))
1268 die(_("You are in the middle of a cherry-pick -- cannot amend."));
1269 else if (whence
== FROM_REBASE_PICK
)
1270 die(_("You are in the middle of a rebase -- cannot amend."));
1272 if (fixup_message
&& squash_message
)
1273 die(_("options '%s' and '%s' cannot be used together"), "--squash", "--fixup");
1274 die_for_incompatible_opt4(!!use_message
, "-C",
1275 !!edit_message
, "-c",
1277 !!fixup_message
, "--fixup");
1278 die_for_incompatible_opt4(have_option_m
, "-m",
1279 !!edit_message
, "-c",
1280 !!use_message
, "-C",
1282 if (use_message
|| edit_message
|| logfile
||fixup_message
|| have_option_m
)
1283 template_file
= NULL
;
1285 use_message
= edit_message
;
1286 if (amend
&& !use_message
&& !fixup_message
)
1287 use_message
= "HEAD";
1288 if (!use_message
&& !is_from_cherry_pick(whence
) &&
1289 !is_from_rebase(whence
) && renew_authorship
)
1290 die(_("--reset-author can be used only with -C, -c or --amend."));
1292 use_message_buffer
= read_commit_message(use_message
);
1293 if (!renew_authorship
) {
1294 author_message
= use_message
;
1295 author_message_buffer
= use_message_buffer
;
1298 if ((is_from_cherry_pick(whence
) || whence
== FROM_REBASE_PICK
) &&
1299 !renew_authorship
) {
1300 author_message
= "CHERRY_PICK_HEAD";
1301 author_message_buffer
= read_commit_message(author_message
);
1304 if (patch_interactive
)
1307 die_for_incompatible_opt4(also
, "-i/--include",
1310 interactive
, "--interactive/-p/--patch");
1311 if (fixup_message
) {
1313 * We limit --fixup's suboptions to only alpha characters.
1314 * If the first character after a run of alpha is colon,
1315 * then the part before the colon may be a known suboption
1316 * name like `amend` or `reword`, or a misspelt suboption
1317 * name. In either case, we treat it as
1318 * --fixup=<suboption>:<arg>.
1320 * Otherwise, we are dealing with --fixup=<commit>.
1322 char *p
= fixup_message
;
1325 if (p
> fixup_message
&& *p
== ':') {
1327 fixup_commit
= p
+ 1;
1328 if (!strcmp("amend", fixup_message
) ||
1329 !strcmp("reword", fixup_message
)) {
1330 fixup_prefix
= "amend";
1332 if (*fixup_message
== 'r') {
1333 check_fixup_reword_options(argc
, argv
);
1337 die(_("unknown option: --fixup=%s:%s"), fixup_message
, fixup_commit
);
1340 fixup_commit
= fixup_message
;
1341 fixup_prefix
= "fixup";
1347 use_editor
= edit_flag
;
1349 cleanup_mode
= get_cleanup_mode(cleanup_arg
, use_editor
);
1351 handle_untracked_files_arg(s
);
1353 if (all
&& argc
> 0)
1354 die(_("paths '%s ...' with -a does not make sense"),
1357 if (status_format
!= STATUS_FORMAT_NONE
)
1363 static int dry_run_commit(const char **argv
, const char *prefix
,
1364 const struct commit
*current_head
, struct wt_status
*s
)
1367 const char *index_file
;
1369 index_file
= prepare_index(argv
, prefix
, current_head
, 1);
1370 committable
= run_status(stdout
, index_file
, prefix
, 0, s
);
1371 rollback_index_files();
1373 return committable
? 0 : 1;
1376 define_list_config_array_extra(color_status_slots
, {"added"});
1378 static int parse_status_slot(const char *slot
)
1380 if (!strcasecmp(slot
, "added"))
1381 return WT_STATUS_UPDATED
;
1383 return LOOKUP_CONFIG(color_status_slots
, slot
);
1386 static int git_status_config(const char *k
, const char *v
, void *cb
)
1388 struct wt_status
*s
= cb
;
1389 const char *slot_name
;
1391 if (starts_with(k
, "column."))
1392 return git_column_config(k
, v
, "status", &s
->colopts
);
1393 if (!strcmp(k
, "status.submodulesummary")) {
1395 s
->submodule_summary
= git_config_bool_or_int(k
, v
, &is_bool
);
1396 if (is_bool
&& s
->submodule_summary
)
1397 s
->submodule_summary
= -1;
1400 if (!strcmp(k
, "status.short")) {
1401 if (git_config_bool(k
, v
))
1402 status_deferred_config
.status_format
= STATUS_FORMAT_SHORT
;
1404 status_deferred_config
.status_format
= STATUS_FORMAT_NONE
;
1407 if (!strcmp(k
, "status.branch")) {
1408 status_deferred_config
.show_branch
= git_config_bool(k
, v
);
1411 if (!strcmp(k
, "status.aheadbehind")) {
1412 status_deferred_config
.ahead_behind
= git_config_bool(k
, v
);
1415 if (!strcmp(k
, "status.showstash")) {
1416 s
->show_stash
= git_config_bool(k
, v
);
1419 if (!strcmp(k
, "status.color") || !strcmp(k
, "color.status")) {
1420 s
->use_color
= git_config_colorbool(k
, v
);
1423 if (!strcmp(k
, "status.displaycommentprefix")) {
1424 s
->display_comment_prefix
= git_config_bool(k
, v
);
1427 if (skip_prefix(k
, "status.color.", &slot_name
) ||
1428 skip_prefix(k
, "color.status.", &slot_name
)) {
1429 int slot
= parse_status_slot(slot_name
);
1433 return config_error_nonbool(k
);
1434 return color_parse(v
, s
->color_palette
[slot
]);
1436 if (!strcmp(k
, "status.relativepaths")) {
1437 s
->relative_paths
= git_config_bool(k
, v
);
1440 if (!strcmp(k
, "status.showuntrackedfiles")) {
1442 return config_error_nonbool(k
);
1443 else if (!strcmp(v
, "no"))
1444 s
->show_untracked_files
= SHOW_NO_UNTRACKED_FILES
;
1445 else if (!strcmp(v
, "normal"))
1446 s
->show_untracked_files
= SHOW_NORMAL_UNTRACKED_FILES
;
1447 else if (!strcmp(v
, "all"))
1448 s
->show_untracked_files
= SHOW_ALL_UNTRACKED_FILES
;
1450 return error(_("Invalid untracked files mode '%s'"), v
);
1453 if (!strcmp(k
, "diff.renamelimit")) {
1454 if (s
->rename_limit
== -1)
1455 s
->rename_limit
= git_config_int(k
, v
);
1458 if (!strcmp(k
, "status.renamelimit")) {
1459 s
->rename_limit
= git_config_int(k
, v
);
1462 if (!strcmp(k
, "diff.renames")) {
1463 if (s
->detect_rename
== -1)
1464 s
->detect_rename
= git_config_rename(k
, v
);
1467 if (!strcmp(k
, "status.renames")) {
1468 s
->detect_rename
= git_config_rename(k
, v
);
1471 return git_diff_ui_config(k
, v
, NULL
);
1474 int cmd_status(int argc
, const char **argv
, const char *prefix
)
1476 static int no_renames
= -1;
1477 static const char *rename_score_arg
= (const char *)-1;
1478 static struct wt_status s
;
1479 unsigned int progress_flag
= 0;
1481 struct object_id oid
;
1482 static struct option builtin_status_options
[] = {
1483 OPT__VERBOSE(&verbose
, N_("be verbose")),
1484 OPT_SET_INT('s', "short", &status_format
,
1485 N_("show status concisely"), STATUS_FORMAT_SHORT
),
1486 OPT_BOOL('b', "branch", &s
.show_branch
,
1487 N_("show branch information")),
1488 OPT_BOOL(0, "show-stash", &s
.show_stash
,
1489 N_("show stash information")),
1490 OPT_BOOL(0, "ahead-behind", &s
.ahead_behind_flags
,
1491 N_("compute full ahead/behind values")),
1492 OPT_CALLBACK_F(0, "porcelain", &status_format
,
1493 N_("version"), N_("machine-readable output"),
1494 PARSE_OPT_OPTARG
, opt_parse_porcelain
),
1495 OPT_SET_INT(0, "long", &status_format
,
1496 N_("show status in long format (default)"),
1497 STATUS_FORMAT_LONG
),
1498 OPT_BOOL('z', "null", &s
.null_termination
,
1499 N_("terminate entries with NUL")),
1500 { OPTION_STRING
, 'u', "untracked-files", &untracked_files_arg
,
1502 N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1503 PARSE_OPT_OPTARG
, NULL
, (intptr_t)"all" },
1504 { OPTION_STRING
, 0, "ignored", &ignored_arg
,
1506 N_("show ignored files, optional modes: traditional, matching, no. (Default: traditional)"),
1507 PARSE_OPT_OPTARG
, NULL
, (intptr_t)"traditional" },
1508 { OPTION_STRING
, 0, "ignore-submodules", &ignore_submodule_arg
, N_("when"),
1509 N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
1510 PARSE_OPT_OPTARG
, NULL
, (intptr_t)"all" },
1511 OPT_COLUMN(0, "column", &s
.colopts
, N_("list untracked files in columns")),
1512 OPT_BOOL(0, "no-renames", &no_renames
, N_("do not detect renames")),
1513 OPT_CALLBACK_F('M', "find-renames", &rename_score_arg
,
1514 N_("n"), N_("detect renames, optionally set similarity index"),
1515 PARSE_OPT_OPTARG
| PARSE_OPT_NONEG
, opt_parse_rename_score
),
1519 if (argc
== 2 && !strcmp(argv
[1], "-h"))
1520 usage_with_options(builtin_status_usage
, builtin_status_options
);
1522 prepare_repo_settings(the_repository
);
1523 the_repository
->settings
.command_requires_full_index
= 0;
1525 status_init_config(&s
, git_status_config
);
1526 argc
= parse_options(argc
, argv
, prefix
,
1527 builtin_status_options
,
1528 builtin_status_usage
, 0);
1529 finalize_colopts(&s
.colopts
, -1);
1530 finalize_deferred_config(&s
);
1532 handle_untracked_files_arg(&s
);
1533 handle_ignored_arg(&s
);
1535 if (s
.show_ignored_mode
== SHOW_MATCHING_IGNORED
&&
1536 s
.show_untracked_files
== SHOW_NO_UNTRACKED_FILES
)
1537 die(_("Unsupported combination of ignored and untracked-files arguments"));
1539 parse_pathspec(&s
.pathspec
, 0,
1540 PATHSPEC_PREFER_FULL
,
1543 if (status_format
!= STATUS_FORMAT_PORCELAIN
&&
1544 status_format
!= STATUS_FORMAT_PORCELAIN_V2
)
1545 progress_flag
= REFRESH_PROGRESS
;
1546 repo_read_index(the_repository
);
1547 refresh_index(&the_index
,
1548 REFRESH_QUIET
|REFRESH_UNMERGED
|progress_flag
,
1549 &s
.pathspec
, NULL
, NULL
);
1551 if (use_optional_locks())
1552 fd
= hold_locked_index(&index_lock
, 0);
1556 s
.is_initial
= get_oid(s
.reference
, &oid
) ? 1 : 0;
1558 oidcpy(&s
.oid_commit
, &oid
);
1560 s
.ignore_submodule_arg
= ignore_submodule_arg
;
1561 s
.status_format
= status_format
;
1562 s
.verbose
= verbose
;
1563 if (no_renames
!= -1)
1564 s
.detect_rename
= !no_renames
;
1565 if ((intptr_t)rename_score_arg
!= -1) {
1566 if (s
.detect_rename
< DIFF_DETECT_RENAME
)
1567 s
.detect_rename
= DIFF_DETECT_RENAME
;
1568 if (rename_score_arg
)
1569 s
.rename_score
= parse_rename_score(&rename_score_arg
);
1572 wt_status_collect(&s
);
1575 repo_update_index_if_able(the_repository
, &index_lock
);
1577 if (s
.relative_paths
)
1580 wt_status_print(&s
);
1581 wt_status_collect_free_buffers(&s
);
1586 static int git_commit_config(const char *k
, const char *v
, void *cb
)
1588 struct wt_status
*s
= cb
;
1591 if (!strcmp(k
, "commit.template"))
1592 return git_config_pathname(&template_file
, k
, v
);
1593 if (!strcmp(k
, "commit.status")) {
1594 include_status
= git_config_bool(k
, v
);
1597 if (!strcmp(k
, "commit.cleanup"))
1598 return git_config_string(&cleanup_arg
, k
, v
);
1599 if (!strcmp(k
, "commit.gpgsign")) {
1600 sign_commit
= git_config_bool(k
, v
) ? "" : NULL
;
1603 if (!strcmp(k
, "commit.verbose")) {
1605 config_commit_verbose
= git_config_bool_or_int(k
, v
, &is_bool
);
1609 status
= git_gpg_config(k
, v
, NULL
);
1612 return git_status_config(k
, v
, s
);
1615 int cmd_commit(int argc
, const char **argv
, const char *prefix
)
1617 static struct wt_status s
;
1618 static struct option builtin_commit_options
[] = {
1619 OPT__QUIET(&quiet
, N_("suppress summary after successful commit")),
1620 OPT__VERBOSE(&verbose
, N_("show diff in commit message template")),
1622 OPT_GROUP(N_("Commit message options")),
1623 OPT_FILENAME('F', "file", &logfile
, N_("read message from file")),
1624 OPT_STRING(0, "author", &force_author
, N_("author"), N_("override author for commit")),
1625 OPT_STRING(0, "date", &force_date
, N_("date"), N_("override date for commit")),
1626 OPT_CALLBACK('m', "message", &message
, N_("message"), N_("commit message"), opt_parse_m
),
1627 OPT_STRING('c', "reedit-message", &edit_message
, N_("commit"), N_("reuse and edit message from specified commit")),
1628 OPT_STRING('C', "reuse-message", &use_message
, N_("commit"), N_("reuse message from specified commit")),
1630 * TRANSLATORS: Leave "[(amend|reword):]" as-is,
1631 * and only translate <commit>.
1633 OPT_STRING(0, "fixup", &fixup_message
, N_("[(amend|reword):]commit"), N_("use autosquash formatted message to fixup or amend/reword specified commit")),
1634 OPT_STRING(0, "squash", &squash_message
, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
1635 OPT_BOOL(0, "reset-author", &renew_authorship
, N_("the commit is authored by me now (used with -C/-c/--amend)")),
1636 OPT_CALLBACK_F(0, "trailer", NULL
, N_("trailer"), N_("add custom trailer(s)"), PARSE_OPT_NONEG
, opt_pass_trailer
),
1637 OPT_BOOL('s', "signoff", &signoff
, N_("add a Signed-off-by trailer")),
1638 OPT_FILENAME('t', "template", &template_file
, N_("use specified template file")),
1639 OPT_BOOL('e', "edit", &edit_flag
, N_("force edit of commit")),
1640 OPT_CLEANUP(&cleanup_arg
),
1641 OPT_BOOL(0, "status", &include_status
, N_("include status in commit message template")),
1642 { OPTION_STRING
, 'S', "gpg-sign", &sign_commit
, N_("key-id"),
1643 N_("GPG sign commit"), PARSE_OPT_OPTARG
, NULL
, (intptr_t) "" },
1644 /* end commit message options */
1646 OPT_GROUP(N_("Commit contents options")),
1647 OPT_BOOL('a', "all", &all
, N_("commit all changed files")),
1648 OPT_BOOL('i', "include", &also
, N_("add specified files to index for commit")),
1649 OPT_BOOL(0, "interactive", &interactive
, N_("interactively add files")),
1650 OPT_BOOL('p', "patch", &patch_interactive
, N_("interactively add changes")),
1651 OPT_BOOL('o', "only", &only
, N_("commit only specified files")),
1652 OPT_BOOL('n', "no-verify", &no_verify
, N_("bypass pre-commit and commit-msg hooks")),
1653 OPT_BOOL(0, "dry-run", &dry_run
, N_("show what would be committed")),
1654 OPT_SET_INT(0, "short", &status_format
, N_("show status concisely"),
1655 STATUS_FORMAT_SHORT
),
1656 OPT_BOOL(0, "branch", &s
.show_branch
, N_("show branch information")),
1657 OPT_BOOL(0, "ahead-behind", &s
.ahead_behind_flags
,
1658 N_("compute full ahead/behind values")),
1659 OPT_SET_INT(0, "porcelain", &status_format
,
1660 N_("machine-readable output"), STATUS_FORMAT_PORCELAIN
),
1661 OPT_SET_INT(0, "long", &status_format
,
1662 N_("show status in long format (default)"),
1663 STATUS_FORMAT_LONG
),
1664 OPT_BOOL('z', "null", &s
.null_termination
,
1665 N_("terminate entries with NUL")),
1666 OPT_BOOL(0, "amend", &amend
, N_("amend previous commit")),
1667 OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite
, N_("bypass post-rewrite hook")),
1668 { 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" },
1669 OPT_PATHSPEC_FROM_FILE(&pathspec_from_file
),
1670 OPT_PATHSPEC_FILE_NUL(&pathspec_file_nul
),
1671 /* end commit contents options */
1673 OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty
,
1674 N_("ok to record an empty change")),
1675 OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message
,
1676 N_("ok to record a change with an empty message")),
1681 struct strbuf sb
= STRBUF_INIT
;
1682 struct strbuf author_ident
= STRBUF_INIT
;
1683 const char *index_file
, *reflog_msg
;
1684 struct object_id oid
;
1685 struct commit_list
*parents
= NULL
;
1686 struct stat statbuf
;
1687 struct commit
*current_head
= NULL
;
1688 struct commit_extra_header
*extra
= NULL
;
1689 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
)) {
1726 rollback_index_files();
1730 /* Determine parents */
1731 reflog_msg
= getenv("GIT_REFLOG_ACTION");
1732 if (!current_head
) {
1734 reflog_msg
= "commit (initial)";
1737 reflog_msg
= "commit (amend)";
1738 parents
= copy_commit_list(current_head
->parents
);
1739 } else if (whence
== FROM_MERGE
) {
1740 struct strbuf m
= STRBUF_INIT
;
1742 int allow_fast_forward
= 1;
1743 struct commit_list
**pptr
= &parents
;
1746 reflog_msg
= "commit (merge)";
1747 pptr
= commit_list_append(current_head
, pptr
);
1748 fp
= xfopen(git_path_merge_head(the_repository
), "r");
1749 while (strbuf_getline_lf(&m
, fp
) != EOF
) {
1750 struct commit
*parent
;
1752 parent
= get_merge_parent(m
.buf
);
1754 die(_("Corrupt MERGE_HEAD file (%s)"), m
.buf
);
1755 pptr
= commit_list_append(parent
, pptr
);
1759 if (!stat(git_path_merge_mode(the_repository
), &statbuf
)) {
1760 if (strbuf_read_file(&sb
, git_path_merge_mode(the_repository
), 0) < 0)
1761 die_errno(_("could not read MERGE_MODE"));
1762 if (!strcmp(sb
.buf
, "no-ff"))
1763 allow_fast_forward
= 0;
1765 if (allow_fast_forward
)
1766 reduce_heads_replace(&parents
);
1769 reflog_msg
= is_from_cherry_pick(whence
)
1770 ? "commit (cherry-pick)"
1771 : is_from_rebase(whence
)
1774 commit_list_insert(current_head
, &parents
);
1777 /* Finally, get the commit message */
1779 if (strbuf_read_file(&sb
, git_path_commit_editmsg(), 0) < 0) {
1780 int saved_errno
= errno
;
1781 rollback_index_files();
1782 die(_("could not read commit message: %s"), strerror(saved_errno
));
1785 cleanup_message(&sb
, cleanup_mode
, verbose
);
1787 if (message_is_empty(&sb
, cleanup_mode
) && !allow_empty_message
) {
1788 rollback_index_files();
1789 fprintf(stderr
, _("Aborting commit due to empty commit message.\n"));
1792 if (template_untouched(&sb
, template_file
, cleanup_mode
) && !allow_empty_message
) {
1793 rollback_index_files();
1794 fprintf(stderr
, _("Aborting commit; you did not edit the message.\n"));
1798 if (fixup_message
&& starts_with(sb
.buf
, "amend! ") &&
1799 !allow_empty_message
) {
1800 struct strbuf body
= STRBUF_INIT
;
1801 size_t len
= commit_subject_length(sb
.buf
);
1802 strbuf_addstr(&body
, sb
.buf
+ len
);
1803 if (message_is_empty(&body
, cleanup_mode
)) {
1804 rollback_index_files();
1805 fprintf(stderr
, _("Aborting commit due to empty commit message body.\n"));
1808 strbuf_release(&body
);
1812 const char *exclude_gpgsig
[3] = { "gpgsig", "gpgsig-sha256", NULL
};
1813 extra
= read_commit_extra_headers(current_head
, exclude_gpgsig
);
1815 struct commit_extra_header
**tail
= &extra
;
1816 append_merge_tag_headers(parents
, &tail
);
1819 if (commit_tree_extended(sb
.buf
, sb
.len
, &active_cache_tree
->oid
,
1820 parents
, &oid
, author_ident
.buf
, NULL
,
1821 sign_commit
, extra
)) {
1822 rollback_index_files();
1823 die(_("failed to write commit object"));
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(), NULL
, "post-commit",
1850 if (amend
&& !no_post_rewrite
) {
1851 commit_post_rewrite(the_repository
, current_head
, &oid
);
1854 unsigned int flags
= 0;
1857 flags
|= SUMMARY_INITIAL_COMMIT
;
1858 if (author_date_is_interesting())
1859 flags
|= SUMMARY_SHOW_AUTHOR_DATE
;
1860 print_commit_summary(the_repository
, prefix
,
1864 apply_autostash(git_path_merge_autostash(the_repository
));
1867 UNLEAK(author_ident
);