4 * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>
5 * Based on git-commit.sh by Junio C Hamano and Linus Torvalds
11 #include "cache-tree.h"
19 #include "wt-status.h"
20 #include "run-command.h"
25 #include "parse-options.h"
26 #include "string-list.h"
28 #include "unpack-trees.h"
30 #include "submodule.h"
31 #include "gpg-interface.h"
33 #include "sequencer.h"
37 static const char * const builtin_commit_usage
[] = {
38 N_("git commit [<options>] [--] <pathspec>..."),
42 static const char * const builtin_status_usage
[] = {
43 N_("git status [<options>] [--] <pathspec>..."),
47 static const char empty_amend_advice
[] =
48 N_("You asked to amend the most recent commit, but doing so would make\n"
49 "it empty. You can repeat your command with --allow-empty, or you can\n"
50 "remove the commit entirely with \"git reset HEAD^\".\n");
52 static const char empty_cherry_pick_advice
[] =
53 N_("The previous cherry-pick is now empty, possibly due to conflict resolution.\n"
54 "If you wish to commit it anyway, use:\n"
56 " git commit --allow-empty\n"
59 static const char empty_cherry_pick_advice_single
[] =
60 N_("Otherwise, please use 'git reset'\n");
62 static const char empty_cherry_pick_advice_multi
[] =
63 N_("If you wish to skip this commit, use:\n"
67 "Then \"git cherry-pick --continue\" will resume cherry-picking\n"
68 "the remaining commits.\n");
70 static const char *color_status_slots
[] = {
71 [WT_STATUS_HEADER
] = "header",
72 [WT_STATUS_UPDATED
] = "updated",
73 [WT_STATUS_CHANGED
] = "changed",
74 [WT_STATUS_UNTRACKED
] = "untracked",
75 [WT_STATUS_NOBRANCH
] = "noBranch",
76 [WT_STATUS_UNMERGED
] = "unmerged",
77 [WT_STATUS_LOCAL_BRANCH
] = "localBranch",
78 [WT_STATUS_REMOTE_BRANCH
] = "remoteBranch",
79 [WT_STATUS_ONBRANCH
] = "branch",
82 static const char *use_message_buffer
;
83 static struct lock_file index_lock
; /* real index */
84 static struct lock_file false_lock
; /* used only for partial commits */
91 static const char *logfile
, *force_author
;
92 static const char *template_file
;
94 * The _message variables are commit names from which to take
95 * the commit message and/or authorship.
97 static const char *author_message
, *author_message_buffer
;
98 static char *edit_message
, *use_message
;
99 static char *fixup_message
, *squash_message
;
100 static int all
, also
, interactive
, patch_interactive
, only
, amend
, signoff
;
101 static int edit_flag
= -1; /* unspecified */
102 static int quiet
, verbose
, no_verify
, allow_empty
, dry_run
, renew_authorship
;
103 static int config_commit_verbose
= -1; /* unspecified */
104 static int no_post_rewrite
, allow_empty_message
;
105 static char *untracked_files_arg
, *force_date
, *ignore_submodule_arg
, *ignored_arg
;
106 static char *sign_commit
;
109 * The default commit message cleanup mode will remove the lines
110 * beginning with # (shell comments) and leading and trailing
111 * whitespaces (empty lines or containing only whitespaces)
112 * if editor is used, and only the whitespaces if the message
113 * is specified explicitly.
115 static enum commit_msg_cleanup_mode cleanup_mode
;
116 static const char *cleanup_arg
;
118 static enum commit_whence whence
;
119 static int sequencer_in_use
;
120 static int use_editor
= 1, include_status
= 1;
121 static int have_option_m
;
122 static struct strbuf message
= STRBUF_INIT
;
124 static enum wt_status_format status_format
= STATUS_FORMAT_UNSPECIFIED
;
126 static int opt_parse_porcelain(const struct option
*opt
, const char *arg
, int unset
)
128 enum wt_status_format
*value
= (enum wt_status_format
*)opt
->value
;
130 *value
= STATUS_FORMAT_NONE
;
132 *value
= STATUS_FORMAT_PORCELAIN
;
133 else if (!strcmp(arg
, "v1") || !strcmp(arg
, "1"))
134 *value
= STATUS_FORMAT_PORCELAIN
;
135 else if (!strcmp(arg
, "v2") || !strcmp(arg
, "2"))
136 *value
= STATUS_FORMAT_PORCELAIN_V2
;
138 die("unsupported porcelain version '%s'", arg
);
143 static int opt_parse_m(const struct option
*opt
, const char *arg
, int unset
)
145 struct strbuf
*buf
= opt
->value
;
148 strbuf_setlen(buf
, 0);
152 strbuf_addch(buf
, '\n');
153 strbuf_addstr(buf
, arg
);
154 strbuf_complete_line(buf
);
159 static int opt_parse_rename_score(const struct option
*opt
, const char *arg
, int unset
)
161 const char **value
= opt
->value
;
162 if (arg
!= NULL
&& *arg
== '=')
169 static void determine_whence(struct wt_status
*s
)
171 if (file_exists(git_path_merge_head(the_repository
)))
173 else if (file_exists(git_path_cherry_pick_head(the_repository
))) {
174 whence
= FROM_CHERRY_PICK
;
175 if (file_exists(git_path_seq_dir()))
176 sequencer_in_use
= 1;
179 whence
= FROM_COMMIT
;
184 static void status_init_config(struct wt_status
*s
, config_fn_t fn
)
186 wt_status_prepare(s
);
187 init_diff_ui_defaults();
190 s
->hints
= advice_status_hints
; /* must come after git_config() */
193 static void rollback_index_files(void)
195 switch (commit_style
) {
197 break; /* nothing to do */
199 rollback_lock_file(&index_lock
);
202 rollback_lock_file(&index_lock
);
203 rollback_lock_file(&false_lock
);
208 static int commit_index_files(void)
212 switch (commit_style
) {
214 break; /* nothing to do */
216 err
= commit_lock_file(&index_lock
);
219 err
= commit_lock_file(&index_lock
);
220 rollback_lock_file(&false_lock
);
228 * Take a union of paths in the index and the named tree (typically, "HEAD"),
229 * and return the paths that match the given pattern in list.
231 static int list_paths(struct string_list
*list
, const char *with_tree
,
232 const char *prefix
, const struct pathspec
*pattern
)
240 m
= xcalloc(1, pattern
->nr
);
243 char *max_prefix
= common_prefix(pattern
);
244 overlay_tree_on_index(&the_index
, with_tree
, max_prefix
);
248 for (i
= 0; i
< active_nr
; i
++) {
249 const struct cache_entry
*ce
= active_cache
[i
];
250 struct string_list_item
*item
;
252 if (ce
->ce_flags
& CE_UPDATE
)
254 if (!ce_path_match(&the_index
, ce
, pattern
, m
))
256 item
= string_list_insert(list
, ce
->name
);
257 if (ce_skip_worktree(ce
))
258 item
->util
= item
; /* better a valid pointer than a fake one */
261 ret
= report_path_error(m
, pattern
, prefix
);
266 static void add_remove_files(struct string_list
*list
)
269 for (i
= 0; i
< list
->nr
; i
++) {
271 struct string_list_item
*p
= &(list
->items
[i
]);
273 /* p->util is skip-worktree */
277 if (!lstat(p
->string
, &st
)) {
278 if (add_to_cache(p
->string
, &st
, 0))
279 die(_("updating files failed"));
281 remove_file_from_cache(p
->string
);
285 static void create_base_index(const struct commit
*current_head
)
288 struct unpack_trees_options opts
;
296 memset(&opts
, 0, sizeof(opts
));
300 opts
.src_index
= &the_index
;
301 opts
.dst_index
= &the_index
;
303 opts
.fn
= oneway_merge
;
304 tree
= parse_tree_indirect(¤t_head
->object
.oid
);
306 die(_("failed to unpack HEAD tree object"));
308 init_tree_desc(&t
, tree
->buffer
, tree
->size
);
309 if (unpack_trees(1, &t
, &opts
))
310 exit(128); /* We've already reported the error, finish dying */
313 static void refresh_cache_or_die(int refresh_flags
)
316 * refresh_flags contains REFRESH_QUIET, so the only errors
317 * are for unmerged entries.
319 if (refresh_cache(refresh_flags
| REFRESH_IN_PORCELAIN
))
320 die_resolve_conflict("commit");
323 static const char *prepare_index(int argc
, const char **argv
, const char *prefix
,
324 const struct commit
*current_head
, int is_status
)
326 struct string_list partial
= STRING_LIST_INIT_DUP
;
327 struct pathspec pathspec
;
328 int refresh_flags
= REFRESH_QUIET
;
332 refresh_flags
|= REFRESH_UNMERGED
;
333 parse_pathspec(&pathspec
, 0,
334 PATHSPEC_PREFER_FULL
,
337 if (read_cache_preload(&pathspec
) < 0)
338 die(_("index file corrupt"));
341 char *old_index_env
= NULL
;
342 hold_locked_index(&index_lock
, LOCK_DIE_ON_ERROR
);
344 refresh_cache_or_die(refresh_flags
);
346 if (write_locked_index(&the_index
, &index_lock
, 0))
347 die(_("unable to create temporary index"));
349 old_index_env
= getenv(INDEX_ENVIRONMENT
);
350 setenv(INDEX_ENVIRONMENT
, get_lock_file_path(&index_lock
), 1);
352 if (interactive_add(argc
, argv
, prefix
, patch_interactive
) != 0)
353 die(_("interactive add failed"));
355 if (old_index_env
&& *old_index_env
)
356 setenv(INDEX_ENVIRONMENT
, old_index_env
, 1);
358 unsetenv(INDEX_ENVIRONMENT
);
361 read_cache_from(get_lock_file_path(&index_lock
));
362 if (update_main_cache_tree(WRITE_TREE_SILENT
) == 0) {
363 if (reopen_lock_file(&index_lock
) < 0)
364 die(_("unable to write index file"));
365 if (write_locked_index(&the_index
, &index_lock
, 0))
366 die(_("unable to update temporary index"));
368 warning(_("Failed to update main cache tree"));
370 commit_style
= COMMIT_NORMAL
;
371 ret
= get_lock_file_path(&index_lock
);
376 * Non partial, non as-is commit.
378 * (1) get the real index;
379 * (2) update the_index as necessary;
380 * (3) write the_index out to the real index (still locked);
381 * (4) return the name of the locked index file.
383 * The caller should run hooks on the locked real index, and
384 * (A) if all goes well, commit the real index;
385 * (B) on failure, rollback the real index.
387 if (all
|| (also
&& pathspec
.nr
)) {
388 hold_locked_index(&index_lock
, LOCK_DIE_ON_ERROR
);
389 add_files_to_cache(also
? prefix
: NULL
, &pathspec
, 0);
390 refresh_cache_or_die(refresh_flags
);
391 update_main_cache_tree(WRITE_TREE_SILENT
);
392 if (write_locked_index(&the_index
, &index_lock
, 0))
393 die(_("unable to write new_index file"));
394 commit_style
= COMMIT_NORMAL
;
395 ret
= get_lock_file_path(&index_lock
);
402 * (1) return the name of the real index file.
404 * The caller should run hooks on the real index,
405 * and create commit from the_index.
406 * We still need to refresh the index here.
408 if (!only
&& !pathspec
.nr
) {
409 hold_locked_index(&index_lock
, LOCK_DIE_ON_ERROR
);
410 refresh_cache_or_die(refresh_flags
);
411 if (active_cache_changed
412 || !cache_tree_fully_valid(active_cache_tree
))
413 update_main_cache_tree(WRITE_TREE_SILENT
);
414 if (write_locked_index(&the_index
, &index_lock
,
415 COMMIT_LOCK
| SKIP_IF_UNCHANGED
))
416 die(_("unable to write new_index file"));
417 commit_style
= COMMIT_AS_IS
;
418 ret
= get_index_file();
425 * (0) find the set of affected paths;
426 * (1) get lock on the real index file;
427 * (2) update the_index with the given paths;
428 * (3) write the_index out to the real index (still locked);
429 * (4) get lock on the false index file;
430 * (5) reset the_index from HEAD;
431 * (6) update the_index the same way as (2);
432 * (7) write the_index out to the false index file;
433 * (8) return the name of the false index file (still locked);
435 * The caller should run hooks on the locked false index, and
436 * create commit from it. Then
437 * (A) if all goes well, commit the real index;
438 * (B) on failure, rollback the real index;
439 * In either case, rollback the false index.
441 commit_style
= COMMIT_PARTIAL
;
443 if (whence
!= FROM_COMMIT
) {
444 if (whence
== FROM_MERGE
)
445 die(_("cannot do a partial commit during a merge."));
446 else if (whence
== FROM_CHERRY_PICK
)
447 die(_("cannot do a partial commit during a cherry-pick."));
450 if (list_paths(&partial
, !current_head
? NULL
: "HEAD", prefix
, &pathspec
))
454 if (read_cache() < 0)
455 die(_("cannot read the index"));
457 hold_locked_index(&index_lock
, LOCK_DIE_ON_ERROR
);
458 add_remove_files(&partial
);
459 refresh_cache(REFRESH_QUIET
);
460 update_main_cache_tree(WRITE_TREE_SILENT
);
461 if (write_locked_index(&the_index
, &index_lock
, 0))
462 die(_("unable to write new_index file"));
464 hold_lock_file_for_update(&false_lock
,
465 git_path("next-index-%"PRIuMAX
,
466 (uintmax_t) getpid()),
469 create_base_index(current_head
);
470 add_remove_files(&partial
);
471 refresh_cache(REFRESH_QUIET
);
473 if (write_locked_index(&the_index
, &false_lock
, 0))
474 die(_("unable to write temporary index file"));
477 ret
= get_lock_file_path(&false_lock
);
478 read_cache_from(ret
);
480 string_list_clear(&partial
, 0);
481 clear_pathspec(&pathspec
);
485 static int run_status(FILE *fp
, const char *index_file
, const char *prefix
, int nowarn
,
488 struct object_id oid
;
490 if (s
->relative_paths
)
495 s
->reference
= "HEAD^1";
497 s
->verbose
= verbose
;
498 s
->index_file
= index_file
;
501 s
->is_initial
= get_oid(s
->reference
, &oid
) ? 1 : 0;
503 hashcpy(s
->sha1_commit
, oid
.hash
);
504 s
->status_format
= status_format
;
505 s
->ignore_submodule_arg
= ignore_submodule_arg
;
507 wt_status_collect(s
);
510 return s
->commitable
;
513 static int is_a_merge(const struct commit
*current_head
)
515 return !!(current_head
->parents
&& current_head
->parents
->next
);
518 static void assert_split_ident(struct ident_split
*id
, const struct strbuf
*buf
)
520 if (split_ident_line(id
, buf
->buf
, buf
->len
) || !id
->date_begin
)
521 BUG("unable to parse our own ident: %s", buf
->buf
);
524 static void export_one(const char *var
, const char *s
, const char *e
, int hack
)
526 struct strbuf buf
= STRBUF_INIT
;
528 strbuf_addch(&buf
, hack
);
529 strbuf_addf(&buf
, "%.*s", (int)(e
- s
), s
);
530 setenv(var
, buf
.buf
, 1);
531 strbuf_release(&buf
);
534 static int parse_force_date(const char *in
, struct strbuf
*out
)
536 strbuf_addch(out
, '@');
538 if (parse_date(in
, out
) < 0) {
540 unsigned long t
= approxidate_careful(in
, &errors
);
543 strbuf_addf(out
, "%lu", t
);
549 static void set_ident_var(char **buf
, char *val
)
555 static void determine_author_info(struct strbuf
*author_ident
)
557 char *name
, *email
, *date
;
558 struct ident_split author
;
560 name
= xstrdup_or_null(getenv("GIT_AUTHOR_NAME"));
561 email
= xstrdup_or_null(getenv("GIT_AUTHOR_EMAIL"));
562 date
= xstrdup_or_null(getenv("GIT_AUTHOR_DATE"));
564 if (author_message
) {
565 struct ident_split ident
;
569 a
= find_commit_header(author_message_buffer
, "author", &len
);
571 die(_("commit '%s' lacks author header"), author_message
);
572 if (split_ident_line(&ident
, a
, len
) < 0)
573 die(_("commit '%s' has malformed author line"), author_message
);
575 set_ident_var(&name
, xmemdupz(ident
.name_begin
, ident
.name_end
- ident
.name_begin
));
576 set_ident_var(&email
, xmemdupz(ident
.mail_begin
, ident
.mail_end
- ident
.mail_begin
));
578 if (ident
.date_begin
) {
579 struct strbuf date_buf
= STRBUF_INIT
;
580 strbuf_addch(&date_buf
, '@');
581 strbuf_add(&date_buf
, ident
.date_begin
, ident
.date_end
- ident
.date_begin
);
582 strbuf_addch(&date_buf
, ' ');
583 strbuf_add(&date_buf
, ident
.tz_begin
, ident
.tz_end
- ident
.tz_begin
);
584 set_ident_var(&date
, strbuf_detach(&date_buf
, NULL
));
589 struct ident_split ident
;
591 if (split_ident_line(&ident
, force_author
, strlen(force_author
)) < 0)
592 die(_("malformed --author parameter"));
593 set_ident_var(&name
, xmemdupz(ident
.name_begin
, ident
.name_end
- ident
.name_begin
));
594 set_ident_var(&email
, xmemdupz(ident
.mail_begin
, ident
.mail_end
- ident
.mail_begin
));
598 struct strbuf date_buf
= STRBUF_INIT
;
599 if (parse_force_date(force_date
, &date_buf
))
600 die(_("invalid date format: %s"), force_date
);
601 set_ident_var(&date
, strbuf_detach(&date_buf
, NULL
));
604 strbuf_addstr(author_ident
, fmt_ident(name
, email
, date
, IDENT_STRICT
));
605 assert_split_ident(&author
, author_ident
);
606 export_one("GIT_AUTHOR_NAME", author
.name_begin
, author
.name_end
, 0);
607 export_one("GIT_AUTHOR_EMAIL", author
.mail_begin
, author
.mail_end
, 0);
608 export_one("GIT_AUTHOR_DATE", author
.date_begin
, author
.tz_end
, '@');
614 static int author_date_is_interesting(void)
616 return author_message
|| force_date
;
619 static void adjust_comment_line_char(const struct strbuf
*sb
)
621 char candidates
[] = "#;@!$%^&|:";
625 comment_line_char
= candidates
[0];
626 if (!memchr(sb
->buf
, comment_line_char
, sb
->len
))
630 candidate
= strchr(candidates
, *p
);
633 for (p
= sb
->buf
; *p
; p
++) {
634 if ((p
[0] == '\n' || p
[0] == '\r') && p
[1]) {
635 candidate
= strchr(candidates
, p
[1]);
641 for (p
= candidates
; *p
== ' '; p
++)
644 die(_("unable to select a comment character that is not used\n"
645 "in the current commit message"));
646 comment_line_char
= *p
;
649 static int prepare_to_commit(const char *index_file
, const char *prefix
,
650 struct commit
*current_head
,
652 struct strbuf
*author_ident
)
655 struct strbuf committer_ident
= STRBUF_INIT
;
657 struct strbuf sb
= STRBUF_INIT
;
658 const char *hook_arg1
= NULL
;
659 const char *hook_arg2
= NULL
;
660 int clean_message_contents
= (cleanup_mode
!= COMMIT_MSG_CLEANUP_NONE
);
661 int old_display_comment_prefix
;
663 /* This checks and barfs if author is badly specified */
664 determine_author_info(author_ident
);
666 if (!no_verify
&& run_commit_hook(use_editor
, index_file
, "pre-commit", NULL
))
669 if (squash_message
) {
671 * Insert the proper subject line before other commit
672 * message options add their content.
674 if (use_message
&& !strcmp(use_message
, squash_message
))
675 strbuf_addstr(&sb
, "squash! ");
677 struct pretty_print_context ctx
= {0};
679 c
= lookup_commit_reference_by_name(squash_message
);
681 die(_("could not lookup commit %s"), squash_message
);
682 ctx
.output_encoding
= get_commit_output_encoding();
683 format_commit_message(c
, "squash! %s\n\n", &sb
,
688 if (have_option_m
&& !fixup_message
) {
689 strbuf_addbuf(&sb
, &message
);
690 hook_arg1
= "message";
691 } else if (logfile
&& !strcmp(logfile
, "-")) {
693 fprintf(stderr
, _("(reading log message from standard input)\n"));
694 if (strbuf_read(&sb
, 0, 0) < 0)
695 die_errno(_("could not read log from standard input"));
696 hook_arg1
= "message";
697 } else if (logfile
) {
698 if (strbuf_read_file(&sb
, logfile
, 0) < 0)
699 die_errno(_("could not read log file '%s'"),
701 hook_arg1
= "message";
702 } else if (use_message
) {
704 buffer
= strstr(use_message_buffer
, "\n\n");
706 strbuf_addstr(&sb
, skip_blank_lines(buffer
+ 2));
707 hook_arg1
= "commit";
708 hook_arg2
= use_message
;
709 } else if (fixup_message
) {
710 struct pretty_print_context ctx
= {0};
711 struct commit
*commit
;
712 commit
= lookup_commit_reference_by_name(fixup_message
);
714 die(_("could not lookup commit %s"), fixup_message
);
715 ctx
.output_encoding
= get_commit_output_encoding();
716 format_commit_message(commit
, "fixup! %s\n\n",
719 strbuf_addbuf(&sb
, &message
);
720 hook_arg1
= "message";
721 } else if (!stat(git_path_merge_msg(the_repository
), &statbuf
)) {
723 * prepend SQUASH_MSG here if it exists and a
724 * "merge --squash" was originally performed
726 if (!stat(git_path_squash_msg(the_repository
), &statbuf
)) {
727 if (strbuf_read_file(&sb
, git_path_squash_msg(the_repository
), 0) < 0)
728 die_errno(_("could not read SQUASH_MSG"));
729 hook_arg1
= "squash";
732 if (strbuf_read_file(&sb
, git_path_merge_msg(the_repository
), 0) < 0)
733 die_errno(_("could not read MERGE_MSG"));
734 } else if (!stat(git_path_squash_msg(the_repository
), &statbuf
)) {
735 if (strbuf_read_file(&sb
, git_path_squash_msg(the_repository
), 0) < 0)
736 die_errno(_("could not read SQUASH_MSG"));
737 hook_arg1
= "squash";
738 } else if (template_file
) {
739 if (strbuf_read_file(&sb
, template_file
, 0) < 0)
740 die_errno(_("could not read '%s'"), template_file
);
741 hook_arg1
= "template";
742 clean_message_contents
= 0;
746 * The remaining cases don't modify the template message, but
747 * just set the argument(s) to the prepare-commit-msg hook.
749 else if (whence
== FROM_MERGE
)
751 else if (whence
== FROM_CHERRY_PICK
) {
752 hook_arg1
= "commit";
753 hook_arg2
= "CHERRY_PICK_HEAD";
756 if (squash_message
) {
758 * If squash_commit was used for the commit subject,
759 * then we're possibly hijacking other commit log options.
760 * Reset the hook args to tell the real story.
762 hook_arg1
= "message";
766 s
->fp
= fopen_for_writing(git_path_commit_editmsg());
768 die_errno(_("could not open '%s'"), git_path_commit_editmsg());
770 /* Ignore status.displayCommentPrefix: we do need comments in COMMIT_EDITMSG. */
771 old_display_comment_prefix
= s
->display_comment_prefix
;
772 s
->display_comment_prefix
= 1;
775 * Most hints are counter-productive when the commit has
780 if (clean_message_contents
)
781 strbuf_stripspace(&sb
, 0);
784 append_signoff(&sb
, ignore_non_trailer(sb
.buf
, sb
.len
), 0);
786 if (fwrite(sb
.buf
, 1, sb
.len
, s
->fp
) < sb
.len
)
787 die_errno(_("could not write commit template"));
789 if (auto_comment_line_char
)
790 adjust_comment_line_char(&sb
);
793 /* This checks if committer ident is explicitly given */
794 strbuf_addstr(&committer_ident
, git_committer_info(IDENT_STRICT
));
795 if (use_editor
&& include_status
) {
797 int saved_color_setting
;
798 struct ident_split ci
, ai
;
800 if (whence
!= FROM_COMMIT
) {
801 if (cleanup_mode
== COMMIT_MSG_CLEANUP_SCISSORS
)
802 wt_status_add_cut_line(s
->fp
);
803 status_printf_ln(s
, GIT_COLOR_NORMAL
,
806 "It looks like you may be committing a merge.\n"
807 "If this is not correct, please remove the file\n"
811 "It looks like you may be committing a cherry-pick.\n"
812 "If this is not correct, please remove the file\n"
815 whence
== FROM_MERGE
?
816 git_path_merge_head(the_repository
) :
817 git_path_cherry_pick_head(the_repository
));
820 fprintf(s
->fp
, "\n");
821 if (cleanup_mode
== COMMIT_MSG_CLEANUP_ALL
)
822 status_printf(s
, GIT_COLOR_NORMAL
,
823 _("Please enter the commit message for your changes."
824 " Lines starting\nwith '%c' will be ignored, and an empty"
825 " message aborts the commit.\n"), comment_line_char
);
826 else if (cleanup_mode
== COMMIT_MSG_CLEANUP_SCISSORS
&&
827 whence
== FROM_COMMIT
)
828 wt_status_add_cut_line(s
->fp
);
829 else /* COMMIT_MSG_CLEANUP_SPACE, that is. */
830 status_printf(s
, GIT_COLOR_NORMAL
,
831 _("Please enter the commit message for your changes."
833 "with '%c' will be kept; you may remove them"
834 " yourself if you want to.\n"
835 "An empty message aborts the commit.\n"), comment_line_char
);
838 * These should never fail because they come from our own
839 * fmt_ident. They may fail the sane_ident test, but we know
840 * that the name and mail pointers will at least be valid,
841 * which is enough for our tests and printing here.
843 assert_split_ident(&ai
, author_ident
);
844 assert_split_ident(&ci
, &committer_ident
);
846 if (ident_cmp(&ai
, &ci
))
847 status_printf_ln(s
, GIT_COLOR_NORMAL
,
849 "Author: %.*s <%.*s>"),
850 ident_shown
++ ? "" : "\n",
851 (int)(ai
.name_end
- ai
.name_begin
), ai
.name_begin
,
852 (int)(ai
.mail_end
- ai
.mail_begin
), ai
.mail_begin
);
854 if (author_date_is_interesting())
855 status_printf_ln(s
, GIT_COLOR_NORMAL
,
858 ident_shown
++ ? "" : "\n",
859 show_ident_date(&ai
, DATE_MODE(NORMAL
)));
861 if (!committer_ident_sufficiently_given())
862 status_printf_ln(s
, GIT_COLOR_NORMAL
,
864 "Committer: %.*s <%.*s>"),
865 ident_shown
++ ? "" : "\n",
866 (int)(ci
.name_end
- ci
.name_begin
), ci
.name_begin
,
867 (int)(ci
.mail_end
- ci
.mail_begin
), ci
.mail_begin
);
869 status_printf_ln(s
, GIT_COLOR_NORMAL
, "%s", ""); /* Add new line for clarity */
871 saved_color_setting
= s
->use_color
;
873 commitable
= run_status(s
->fp
, index_file
, prefix
, 1, s
);
874 s
->use_color
= saved_color_setting
;
875 string_list_clear(&s
->change
, 1);
877 struct object_id oid
;
878 const char *parent
= "HEAD";
880 if (!active_nr
&& read_cache() < 0)
881 die(_("Cannot read index"));
886 if (get_oid(parent
, &oid
)) {
889 for (i
= 0; i
< active_nr
; i
++)
890 if (ce_intent_to_add(active_cache
[i
]))
892 commitable
= active_nr
- ita_nr
> 0;
895 * Unless the user did explicitly request a submodule
896 * ignore mode by passing a command line option we do
897 * not ignore any changed submodule SHA-1s when
898 * comparing index and parent, no matter what is
899 * configured. Otherwise we won't commit any
900 * submodules which were manually staged, which would
901 * be really confusing.
903 struct diff_flags flags
= DIFF_FLAGS_INIT
;
904 flags
.override_submodule_config
= 1;
905 if (ignore_submodule_arg
&&
906 !strcmp(ignore_submodule_arg
, "all"))
907 flags
.ignore_submodules
= 1;
908 commitable
= index_differs_from(parent
, &flags
, 1);
911 strbuf_release(&committer_ident
);
916 * Reject an attempt to record a non-merge empty commit without
917 * explicit --allow-empty. In the cherry-pick case, it may be
918 * empty due to conflict resolution, which the user should okay.
920 if (!commitable
&& whence
!= FROM_MERGE
&& !allow_empty
&&
921 !(amend
&& is_a_merge(current_head
))) {
922 s
->display_comment_prefix
= old_display_comment_prefix
;
923 run_status(stdout
, index_file
, prefix
, 0, s
);
925 fputs(_(empty_amend_advice
), stderr
);
926 else if (whence
== FROM_CHERRY_PICK
) {
927 fputs(_(empty_cherry_pick_advice
), stderr
);
928 if (!sequencer_in_use
)
929 fputs(_(empty_cherry_pick_advice_single
), stderr
);
931 fputs(_(empty_cherry_pick_advice_multi
), stderr
);
936 if (!no_verify
&& find_hook("pre-commit")) {
938 * Re-read the index as pre-commit hook could have updated it,
939 * and write it out as a tree. We must do this before we invoke
940 * the editor and after we invoke run_status above.
944 read_cache_from(index_file
);
946 if (update_main_cache_tree(0)) {
947 error(_("Error building trees"));
951 if (run_commit_hook(use_editor
, index_file
, "prepare-commit-msg",
952 git_path_commit_editmsg(), hook_arg1
, hook_arg2
, NULL
))
956 struct argv_array env
= ARGV_ARRAY_INIT
;
958 argv_array_pushf(&env
, "GIT_INDEX_FILE=%s", index_file
);
959 if (launch_editor(git_path_commit_editmsg(), NULL
, env
.argv
)) {
961 _("Please supply the message using either -m or -F option.\n"));
964 argv_array_clear(&env
);
968 run_commit_hook(use_editor
, index_file
, "commit-msg", git_path_commit_editmsg(), NULL
)) {
975 static const char *find_author_by_nickname(const char *name
)
977 struct rev_info revs
;
978 struct commit
*commit
;
979 struct strbuf buf
= STRBUF_INIT
;
980 struct string_list mailmap
= STRING_LIST_INIT_NODUP
;
984 init_revisions(&revs
, NULL
);
985 strbuf_addf(&buf
, "--author=%s", name
);
990 setup_revisions(ac
, av
, &revs
, NULL
);
991 revs
.mailmap
= &mailmap
;
992 read_mailmap(revs
.mailmap
, NULL
);
994 if (prepare_revision_walk(&revs
))
995 die(_("revision walk setup failed"));
996 commit
= get_revision(&revs
);
998 struct pretty_print_context ctx
= {0};
999 ctx
.date_mode
.type
= DATE_NORMAL
;
1000 strbuf_release(&buf
);
1001 format_commit_message(commit
, "%aN <%aE>", &buf
, &ctx
);
1002 clear_mailmap(&mailmap
);
1003 return strbuf_detach(&buf
, NULL
);
1005 die(_("--author '%s' is not 'Name <email>' and matches no existing author"), name
);
1008 static void handle_ignored_arg(struct wt_status
*s
)
1011 ; /* default already initialized */
1012 else if (!strcmp(ignored_arg
, "traditional"))
1013 s
->show_ignored_mode
= SHOW_TRADITIONAL_IGNORED
;
1014 else if (!strcmp(ignored_arg
, "no"))
1015 s
->show_ignored_mode
= SHOW_NO_IGNORED
;
1016 else if (!strcmp(ignored_arg
, "matching"))
1017 s
->show_ignored_mode
= SHOW_MATCHING_IGNORED
;
1019 die(_("Invalid ignored mode '%s'"), ignored_arg
);
1022 static void handle_untracked_files_arg(struct wt_status
*s
)
1024 if (!untracked_files_arg
)
1025 ; /* default already initialized */
1026 else if (!strcmp(untracked_files_arg
, "no"))
1027 s
->show_untracked_files
= SHOW_NO_UNTRACKED_FILES
;
1028 else if (!strcmp(untracked_files_arg
, "normal"))
1029 s
->show_untracked_files
= SHOW_NORMAL_UNTRACKED_FILES
;
1030 else if (!strcmp(untracked_files_arg
, "all"))
1031 s
->show_untracked_files
= SHOW_ALL_UNTRACKED_FILES
;
1033 die(_("Invalid untracked files mode '%s'"), untracked_files_arg
);
1036 static const char *read_commit_message(const char *name
)
1038 const char *out_enc
;
1039 struct commit
*commit
;
1041 commit
= lookup_commit_reference_by_name(name
);
1043 die(_("could not lookup commit %s"), name
);
1044 out_enc
= get_commit_output_encoding();
1045 return logmsg_reencode(commit
, NULL
, out_enc
);
1049 * Enumerate what needs to be propagated when --porcelain
1050 * is not in effect here.
1052 static struct status_deferred_config
{
1053 enum wt_status_format status_format
;
1055 } status_deferred_config
= {
1056 STATUS_FORMAT_UNSPECIFIED
,
1057 -1 /* unspecified */
1060 static void finalize_deferred_config(struct wt_status
*s
)
1062 int use_deferred_config
= (status_format
!= STATUS_FORMAT_PORCELAIN
&&
1063 status_format
!= STATUS_FORMAT_PORCELAIN_V2
&&
1064 !s
->null_termination
);
1066 if (s
->null_termination
) {
1067 if (status_format
== STATUS_FORMAT_NONE
||
1068 status_format
== STATUS_FORMAT_UNSPECIFIED
)
1069 status_format
= STATUS_FORMAT_PORCELAIN
;
1070 else if (status_format
== STATUS_FORMAT_LONG
)
1071 die(_("--long and -z are incompatible"));
1074 if (use_deferred_config
&& status_format
== STATUS_FORMAT_UNSPECIFIED
)
1075 status_format
= status_deferred_config
.status_format
;
1076 if (status_format
== STATUS_FORMAT_UNSPECIFIED
)
1077 status_format
= STATUS_FORMAT_NONE
;
1079 if (use_deferred_config
&& s
->show_branch
< 0)
1080 s
->show_branch
= status_deferred_config
.show_branch
;
1081 if (s
->show_branch
< 0)
1084 if (s
->ahead_behind_flags
== AHEAD_BEHIND_UNSPECIFIED
)
1085 s
->ahead_behind_flags
= AHEAD_BEHIND_FULL
;
1088 static int parse_and_validate_options(int argc
, const char *argv
[],
1089 const struct option
*options
,
1090 const char * const usage
[],
1092 struct commit
*current_head
,
1093 struct wt_status
*s
)
1097 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
1098 finalize_deferred_config(s
);
1100 if (force_author
&& !strchr(force_author
, '>'))
1101 force_author
= find_author_by_nickname(force_author
);
1103 if (force_author
&& renew_authorship
)
1104 die(_("Using both --reset-author and --author does not make sense"));
1106 if (logfile
|| have_option_m
|| use_message
|| fixup_message
)
1109 use_editor
= edit_flag
;
1111 /* Sanity check options */
1112 if (amend
&& !current_head
)
1113 die(_("You have nothing to amend."));
1114 if (amend
&& whence
!= FROM_COMMIT
) {
1115 if (whence
== FROM_MERGE
)
1116 die(_("You are in the middle of a merge -- cannot amend."));
1117 else if (whence
== FROM_CHERRY_PICK
)
1118 die(_("You are in the middle of a cherry-pick -- cannot amend."));
1120 if (fixup_message
&& squash_message
)
1121 die(_("Options --squash and --fixup cannot be used together"));
1131 die(_("Only one of -c/-C/-F/--fixup can be used."));
1132 if (have_option_m
&& (edit_message
|| use_message
|| logfile
))
1133 die((_("Option -m cannot be combined with -c/-C/-F.")));
1134 if (f
|| have_option_m
)
1135 template_file
= NULL
;
1137 use_message
= edit_message
;
1138 if (amend
&& !use_message
&& !fixup_message
)
1139 use_message
= "HEAD";
1140 if (!use_message
&& whence
!= FROM_CHERRY_PICK
&& renew_authorship
)
1141 die(_("--reset-author can be used only with -C, -c or --amend."));
1143 use_message_buffer
= read_commit_message(use_message
);
1144 if (!renew_authorship
) {
1145 author_message
= use_message
;
1146 author_message_buffer
= use_message_buffer
;
1149 if (whence
== FROM_CHERRY_PICK
&& !renew_authorship
) {
1150 author_message
= "CHERRY_PICK_HEAD";
1151 author_message_buffer
= read_commit_message(author_message
);
1154 if (patch_interactive
)
1157 if (also
+ only
+ all
+ interactive
> 1)
1158 die(_("Only one of --include/--only/--all/--interactive/--patch can be used."));
1159 if (argc
== 0 && (also
|| (only
&& !amend
&& !allow_empty
)))
1160 die(_("No paths with --include/--only does not make sense."));
1161 if (!cleanup_arg
|| !strcmp(cleanup_arg
, "default"))
1162 cleanup_mode
= use_editor
? COMMIT_MSG_CLEANUP_ALL
:
1163 COMMIT_MSG_CLEANUP_SPACE
;
1164 else if (!strcmp(cleanup_arg
, "verbatim"))
1165 cleanup_mode
= COMMIT_MSG_CLEANUP_NONE
;
1166 else if (!strcmp(cleanup_arg
, "whitespace"))
1167 cleanup_mode
= COMMIT_MSG_CLEANUP_SPACE
;
1168 else if (!strcmp(cleanup_arg
, "strip"))
1169 cleanup_mode
= COMMIT_MSG_CLEANUP_ALL
;
1170 else if (!strcmp(cleanup_arg
, "scissors"))
1171 cleanup_mode
= use_editor
? COMMIT_MSG_CLEANUP_SCISSORS
:
1172 COMMIT_MSG_CLEANUP_SPACE
;
1174 die(_("Invalid cleanup mode %s"), cleanup_arg
);
1176 handle_untracked_files_arg(s
);
1178 if (all
&& argc
> 0)
1179 die(_("Paths with -a does not make sense."));
1181 if (status_format
!= STATUS_FORMAT_NONE
)
1187 static int dry_run_commit(int argc
, const char **argv
, const char *prefix
,
1188 const struct commit
*current_head
, struct wt_status
*s
)
1191 const char *index_file
;
1193 index_file
= prepare_index(argc
, argv
, prefix
, current_head
, 1);
1194 commitable
= run_status(stdout
, index_file
, prefix
, 0, s
);
1195 rollback_index_files();
1197 return commitable
? 0 : 1;
1200 define_list_config_array_extra(color_status_slots
, {"added"});
1202 static int parse_status_slot(const char *slot
)
1204 if (!strcasecmp(slot
, "added"))
1205 return WT_STATUS_UPDATED
;
1207 return LOOKUP_CONFIG(color_status_slots
, slot
);
1210 static int git_status_config(const char *k
, const char *v
, void *cb
)
1212 struct wt_status
*s
= cb
;
1213 const char *slot_name
;
1215 if (starts_with(k
, "column."))
1216 return git_column_config(k
, v
, "status", &s
->colopts
);
1217 if (!strcmp(k
, "status.submodulesummary")) {
1219 s
->submodule_summary
= git_config_bool_or_int(k
, v
, &is_bool
);
1220 if (is_bool
&& s
->submodule_summary
)
1221 s
->submodule_summary
= -1;
1224 if (!strcmp(k
, "status.short")) {
1225 if (git_config_bool(k
, v
))
1226 status_deferred_config
.status_format
= STATUS_FORMAT_SHORT
;
1228 status_deferred_config
.status_format
= STATUS_FORMAT_NONE
;
1231 if (!strcmp(k
, "status.branch")) {
1232 status_deferred_config
.show_branch
= git_config_bool(k
, v
);
1235 if (!strcmp(k
, "status.showstash")) {
1236 s
->show_stash
= git_config_bool(k
, v
);
1239 if (!strcmp(k
, "status.color") || !strcmp(k
, "color.status")) {
1240 s
->use_color
= git_config_colorbool(k
, v
);
1243 if (!strcmp(k
, "status.displaycommentprefix")) {
1244 s
->display_comment_prefix
= git_config_bool(k
, v
);
1247 if (skip_prefix(k
, "status.color.", &slot_name
) ||
1248 skip_prefix(k
, "color.status.", &slot_name
)) {
1249 int slot
= parse_status_slot(slot_name
);
1253 return config_error_nonbool(k
);
1254 return color_parse(v
, s
->color_palette
[slot
]);
1256 if (!strcmp(k
, "status.relativepaths")) {
1257 s
->relative_paths
= git_config_bool(k
, v
);
1260 if (!strcmp(k
, "status.showuntrackedfiles")) {
1262 return config_error_nonbool(k
);
1263 else if (!strcmp(v
, "no"))
1264 s
->show_untracked_files
= SHOW_NO_UNTRACKED_FILES
;
1265 else if (!strcmp(v
, "normal"))
1266 s
->show_untracked_files
= SHOW_NORMAL_UNTRACKED_FILES
;
1267 else if (!strcmp(v
, "all"))
1268 s
->show_untracked_files
= SHOW_ALL_UNTRACKED_FILES
;
1270 return error(_("Invalid untracked files mode '%s'"), v
);
1273 if (!strcmp(k
, "diff.renamelimit")) {
1274 if (s
->rename_limit
== -1)
1275 s
->rename_limit
= git_config_int(k
, v
);
1278 if (!strcmp(k
, "status.renamelimit")) {
1279 s
->rename_limit
= git_config_int(k
, v
);
1282 if (!strcmp(k
, "diff.renames")) {
1283 if (s
->detect_rename
== -1)
1284 s
->detect_rename
= git_config_rename(k
, v
);
1287 if (!strcmp(k
, "status.renames")) {
1288 s
->detect_rename
= git_config_rename(k
, v
);
1291 return git_diff_ui_config(k
, v
, NULL
);
1294 int cmd_status(int argc
, const char **argv
, const char *prefix
)
1296 static int no_renames
= -1;
1297 static const char *rename_score_arg
= (const char *)-1;
1298 static struct wt_status s
;
1300 struct object_id oid
;
1301 static struct option builtin_status_options
[] = {
1302 OPT__VERBOSE(&verbose
, N_("be verbose")),
1303 OPT_SET_INT('s', "short", &status_format
,
1304 N_("show status concisely"), STATUS_FORMAT_SHORT
),
1305 OPT_BOOL('b', "branch", &s
.show_branch
,
1306 N_("show branch information")),
1307 OPT_BOOL(0, "show-stash", &s
.show_stash
,
1308 N_("show stash information")),
1309 OPT_BOOL(0, "ahead-behind", &s
.ahead_behind_flags
,
1310 N_("compute full ahead/behind values")),
1311 { OPTION_CALLBACK
, 0, "porcelain", &status_format
,
1312 N_("version"), N_("machine-readable output"),
1313 PARSE_OPT_OPTARG
, opt_parse_porcelain
},
1314 OPT_SET_INT(0, "long", &status_format
,
1315 N_("show status in long format (default)"),
1316 STATUS_FORMAT_LONG
),
1317 OPT_BOOL('z', "null", &s
.null_termination
,
1318 N_("terminate entries with NUL")),
1319 { OPTION_STRING
, 'u', "untracked-files", &untracked_files_arg
,
1321 N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1322 PARSE_OPT_OPTARG
, NULL
, (intptr_t)"all" },
1323 { OPTION_STRING
, 0, "ignored", &ignored_arg
,
1325 N_("show ignored files, optional modes: traditional, matching, no. (Default: traditional)"),
1326 PARSE_OPT_OPTARG
, NULL
, (intptr_t)"traditional" },
1327 { OPTION_STRING
, 0, "ignore-submodules", &ignore_submodule_arg
, N_("when"),
1328 N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
1329 PARSE_OPT_OPTARG
, NULL
, (intptr_t)"all" },
1330 OPT_COLUMN(0, "column", &s
.colopts
, N_("list untracked files in columns")),
1331 OPT_BOOL(0, "no-renames", &no_renames
, N_("do not detect renames")),
1332 { OPTION_CALLBACK
, 'M', "find-renames", &rename_score_arg
,
1333 N_("n"), N_("detect renames, optionally set similarity index"),
1334 PARSE_OPT_OPTARG
, opt_parse_rename_score
},
1338 if (argc
== 2 && !strcmp(argv
[1], "-h"))
1339 usage_with_options(builtin_status_usage
, builtin_status_options
);
1341 status_init_config(&s
, git_status_config
);
1342 argc
= parse_options(argc
, argv
, prefix
,
1343 builtin_status_options
,
1344 builtin_status_usage
, 0);
1345 finalize_colopts(&s
.colopts
, -1);
1346 finalize_deferred_config(&s
);
1348 handle_untracked_files_arg(&s
);
1349 handle_ignored_arg(&s
);
1351 if (s
.show_ignored_mode
== SHOW_MATCHING_IGNORED
&&
1352 s
.show_untracked_files
== SHOW_NO_UNTRACKED_FILES
)
1353 die(_("Unsupported combination of ignored and untracked-files arguments"));
1355 parse_pathspec(&s
.pathspec
, 0,
1356 PATHSPEC_PREFER_FULL
,
1359 read_cache_preload(&s
.pathspec
);
1360 refresh_index(&the_index
, REFRESH_QUIET
|REFRESH_UNMERGED
, &s
.pathspec
, NULL
, NULL
);
1362 if (use_optional_locks())
1363 fd
= hold_locked_index(&index_lock
, 0);
1367 s
.is_initial
= get_oid(s
.reference
, &oid
) ? 1 : 0;
1369 hashcpy(s
.sha1_commit
, oid
.hash
);
1371 s
.ignore_submodule_arg
= ignore_submodule_arg
;
1372 s
.status_format
= status_format
;
1373 s
.verbose
= verbose
;
1374 if (no_renames
!= -1)
1375 s
.detect_rename
= !no_renames
;
1376 if ((intptr_t)rename_score_arg
!= -1) {
1377 if (s
.detect_rename
< DIFF_DETECT_RENAME
)
1378 s
.detect_rename
= DIFF_DETECT_RENAME
;
1379 if (rename_score_arg
)
1380 s
.rename_score
= parse_rename_score(&rename_score_arg
);
1383 wt_status_collect(&s
);
1386 update_index_if_able(&the_index
, &index_lock
);
1388 if (s
.relative_paths
)
1391 wt_status_print(&s
);
1395 static int git_commit_config(const char *k
, const char *v
, void *cb
)
1397 struct wt_status
*s
= cb
;
1400 if (!strcmp(k
, "commit.template"))
1401 return git_config_pathname(&template_file
, k
, v
);
1402 if (!strcmp(k
, "commit.status")) {
1403 include_status
= git_config_bool(k
, v
);
1406 if (!strcmp(k
, "commit.cleanup"))
1407 return git_config_string(&cleanup_arg
, k
, v
);
1408 if (!strcmp(k
, "commit.gpgsign")) {
1409 sign_commit
= git_config_bool(k
, v
) ? "" : NULL
;
1412 if (!strcmp(k
, "commit.verbose")) {
1414 config_commit_verbose
= git_config_bool_or_int(k
, v
, &is_bool
);
1418 status
= git_gpg_config(k
, v
, NULL
);
1421 return git_status_config(k
, v
, s
);
1424 int run_commit_hook(int editor_is_used
, const char *index_file
, const char *name
, ...)
1426 struct argv_array hook_env
= ARGV_ARRAY_INIT
;
1430 argv_array_pushf(&hook_env
, "GIT_INDEX_FILE=%s", index_file
);
1433 * Let the hook know that no editor will be launched.
1435 if (!editor_is_used
)
1436 argv_array_push(&hook_env
, "GIT_EDITOR=:");
1438 va_start(args
, name
);
1439 ret
= run_hook_ve(hook_env
.argv
,name
, args
);
1441 argv_array_clear(&hook_env
);
1446 int cmd_commit(int argc
, const char **argv
, const char *prefix
)
1448 const char *argv_gc_auto
[] = {"gc", "--auto", NULL
};
1449 static struct wt_status s
;
1450 static struct option builtin_commit_options
[] = {
1451 OPT__QUIET(&quiet
, N_("suppress summary after successful commit")),
1452 OPT__VERBOSE(&verbose
, N_("show diff in commit message template")),
1454 OPT_GROUP(N_("Commit message options")),
1455 OPT_FILENAME('F', "file", &logfile
, N_("read message from file")),
1456 OPT_STRING(0, "author", &force_author
, N_("author"), N_("override author for commit")),
1457 OPT_STRING(0, "date", &force_date
, N_("date"), N_("override date for commit")),
1458 OPT_CALLBACK('m', "message", &message
, N_("message"), N_("commit message"), opt_parse_m
),
1459 OPT_STRING('c', "reedit-message", &edit_message
, N_("commit"), N_("reuse and edit message from specified commit")),
1460 OPT_STRING('C', "reuse-message", &use_message
, N_("commit"), N_("reuse message from specified commit")),
1461 OPT_STRING(0, "fixup", &fixup_message
, N_("commit"), N_("use autosquash formatted message to fixup specified commit")),
1462 OPT_STRING(0, "squash", &squash_message
, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
1463 OPT_BOOL(0, "reset-author", &renew_authorship
, N_("the commit is authored by me now (used with -C/-c/--amend)")),
1464 OPT_BOOL('s', "signoff", &signoff
, N_("add Signed-off-by:")),
1465 OPT_FILENAME('t', "template", &template_file
, N_("use specified template file")),
1466 OPT_BOOL('e', "edit", &edit_flag
, N_("force edit of commit")),
1467 OPT_STRING(0, "cleanup", &cleanup_arg
, N_("default"), N_("how to strip spaces and #comments from message")),
1468 OPT_BOOL(0, "status", &include_status
, N_("include status in commit message template")),
1469 { OPTION_STRING
, 'S', "gpg-sign", &sign_commit
, N_("key-id"),
1470 N_("GPG sign commit"), PARSE_OPT_OPTARG
, NULL
, (intptr_t) "" },
1471 /* end commit message options */
1473 OPT_GROUP(N_("Commit contents options")),
1474 OPT_BOOL('a', "all", &all
, N_("commit all changed files")),
1475 OPT_BOOL('i', "include", &also
, N_("add specified files to index for commit")),
1476 OPT_BOOL(0, "interactive", &interactive
, N_("interactively add files")),
1477 OPT_BOOL('p', "patch", &patch_interactive
, N_("interactively add changes")),
1478 OPT_BOOL('o', "only", &only
, N_("commit only specified files")),
1479 OPT_BOOL('n', "no-verify", &no_verify
, N_("bypass pre-commit and commit-msg hooks")),
1480 OPT_BOOL(0, "dry-run", &dry_run
, N_("show what would be committed")),
1481 OPT_SET_INT(0, "short", &status_format
, N_("show status concisely"),
1482 STATUS_FORMAT_SHORT
),
1483 OPT_BOOL(0, "branch", &s
.show_branch
, N_("show branch information")),
1484 OPT_BOOL(0, "ahead-behind", &s
.ahead_behind_flags
,
1485 N_("compute full ahead/behind values")),
1486 OPT_SET_INT(0, "porcelain", &status_format
,
1487 N_("machine-readable output"), STATUS_FORMAT_PORCELAIN
),
1488 OPT_SET_INT(0, "long", &status_format
,
1489 N_("show status in long format (default)"),
1490 STATUS_FORMAT_LONG
),
1491 OPT_BOOL('z', "null", &s
.null_termination
,
1492 N_("terminate entries with NUL")),
1493 OPT_BOOL(0, "amend", &amend
, N_("amend previous commit")),
1494 OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite
, N_("bypass post-rewrite hook")),
1495 { OPTION_STRING
, 'u', "untracked-files", &untracked_files_arg
, N_("mode"), N_("show untracked files, optional modes: all, normal, no. (Default: all)"), PARSE_OPT_OPTARG
, NULL
, (intptr_t)"all" },
1496 /* end commit contents options */
1498 OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty
,
1499 N_("ok to record an empty change")),
1500 OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message
,
1501 N_("ok to record a change with an empty message")),
1506 struct strbuf sb
= STRBUF_INIT
;
1507 struct strbuf author_ident
= STRBUF_INIT
;
1508 const char *index_file
, *reflog_msg
;
1509 struct object_id oid
;
1510 struct commit_list
*parents
= NULL
;
1511 struct stat statbuf
;
1512 struct commit
*current_head
= NULL
;
1513 struct commit_extra_header
*extra
= NULL
;
1514 struct strbuf err
= STRBUF_INIT
;
1516 if (argc
== 2 && !strcmp(argv
[1], "-h"))
1517 usage_with_options(builtin_commit_usage
, builtin_commit_options
);
1519 status_init_config(&s
, git_commit_config
);
1520 s
.commit_template
= 1;
1521 status_format
= STATUS_FORMAT_NONE
; /* Ignore status.short */
1524 if (get_oid("HEAD", &oid
))
1525 current_head
= NULL
;
1527 current_head
= lookup_commit_or_die(&oid
, "HEAD");
1528 if (parse_commit(current_head
))
1529 die(_("could not parse HEAD commit"));
1531 verbose
= -1; /* unspecified */
1532 argc
= parse_and_validate_options(argc
, argv
, builtin_commit_options
,
1533 builtin_commit_usage
,
1534 prefix
, current_head
, &s
);
1536 verbose
= (config_commit_verbose
< 0) ? 0 : config_commit_verbose
;
1539 return dry_run_commit(argc
, argv
, prefix
, current_head
, &s
);
1540 index_file
= prepare_index(argc
, argv
, prefix
, current_head
, 0);
1542 /* Set up everything for writing the commit object. This includes
1543 running hooks, writing the trees, and interacting with the user. */
1544 if (!prepare_to_commit(index_file
, prefix
,
1545 current_head
, &s
, &author_ident
)) {
1546 rollback_index_files();
1550 /* Determine parents */
1551 reflog_msg
= getenv("GIT_REFLOG_ACTION");
1552 if (!current_head
) {
1554 reflog_msg
= "commit (initial)";
1557 reflog_msg
= "commit (amend)";
1558 parents
= copy_commit_list(current_head
->parents
);
1559 } else if (whence
== FROM_MERGE
) {
1560 struct strbuf m
= STRBUF_INIT
;
1562 int allow_fast_forward
= 1;
1563 struct commit_list
**pptr
= &parents
;
1566 reflog_msg
= "commit (merge)";
1567 pptr
= commit_list_append(current_head
, pptr
);
1568 fp
= xfopen(git_path_merge_head(the_repository
), "r");
1569 while (strbuf_getline_lf(&m
, fp
) != EOF
) {
1570 struct commit
*parent
;
1572 parent
= get_merge_parent(m
.buf
);
1574 die(_("Corrupt MERGE_HEAD file (%s)"), m
.buf
);
1575 pptr
= commit_list_append(parent
, pptr
);
1579 if (!stat(git_path_merge_mode(the_repository
), &statbuf
)) {
1580 if (strbuf_read_file(&sb
, git_path_merge_mode(the_repository
), 0) < 0)
1581 die_errno(_("could not read MERGE_MODE"));
1582 if (!strcmp(sb
.buf
, "no-ff"))
1583 allow_fast_forward
= 0;
1585 if (allow_fast_forward
)
1586 reduce_heads_replace(&parents
);
1589 reflog_msg
= (whence
== FROM_CHERRY_PICK
)
1590 ? "commit (cherry-pick)"
1592 commit_list_insert(current_head
, &parents
);
1595 /* Finally, get the commit message */
1597 if (strbuf_read_file(&sb
, git_path_commit_editmsg(), 0) < 0) {
1598 int saved_errno
= errno
;
1599 rollback_index_files();
1600 die(_("could not read commit message: %s"), strerror(saved_errno
));
1603 if (verbose
|| /* Truncate the message just before the diff, if any. */
1604 cleanup_mode
== COMMIT_MSG_CLEANUP_SCISSORS
)
1605 strbuf_setlen(&sb
, wt_status_locate_end(sb
.buf
, sb
.len
));
1606 if (cleanup_mode
!= COMMIT_MSG_CLEANUP_NONE
)
1607 strbuf_stripspace(&sb
, cleanup_mode
== COMMIT_MSG_CLEANUP_ALL
);
1609 if (message_is_empty(&sb
, cleanup_mode
) && !allow_empty_message
) {
1610 rollback_index_files();
1611 fprintf(stderr
, _("Aborting commit due to empty commit message.\n"));
1614 if (template_untouched(&sb
, template_file
, cleanup_mode
) && !allow_empty_message
) {
1615 rollback_index_files();
1616 fprintf(stderr
, _("Aborting commit; you did not edit the message.\n"));
1621 const char *exclude_gpgsig
[2] = { "gpgsig", NULL
};
1622 extra
= read_commit_extra_headers(current_head
, exclude_gpgsig
);
1624 struct commit_extra_header
**tail
= &extra
;
1625 append_merge_tag_headers(parents
, &tail
);
1628 if (commit_tree_extended(sb
.buf
, sb
.len
, &active_cache_tree
->oid
,
1629 parents
, &oid
, author_ident
.buf
, sign_commit
,
1631 rollback_index_files();
1632 die(_("failed to write commit object"));
1634 strbuf_release(&author_ident
);
1635 free_commit_extra_headers(extra
);
1637 if (update_head_with_reflog(current_head
, &oid
, reflog_msg
, &sb
,
1639 rollback_index_files();
1643 unlink(git_path_cherry_pick_head(the_repository
));
1644 unlink(git_path_revert_head(the_repository
));
1645 unlink(git_path_merge_head(the_repository
));
1646 unlink(git_path_merge_msg(the_repository
));
1647 unlink(git_path_merge_mode(the_repository
));
1648 unlink(git_path_squash_msg(the_repository
));
1650 if (commit_index_files())
1651 die(_("repository has been updated, but unable to write\n"
1652 "new_index file. Check that disk is not full and quota is\n"
1653 "not exceeded, and then \"git reset HEAD\" to recover."));
1656 run_command_v_opt(argv_gc_auto
, RUN_GIT_CMD
);
1657 run_commit_hook(use_editor
, get_index_file(), "post-commit", NULL
);
1658 if (amend
&& !no_post_rewrite
) {
1659 commit_post_rewrite(current_head
, &oid
);
1662 unsigned int flags
= 0;
1665 flags
|= SUMMARY_INITIAL_COMMIT
;
1666 if (author_date_is_interesting())
1667 flags
|= SUMMARY_SHOW_AUTHOR_DATE
;
1668 print_commit_summary(prefix
, &oid
, flags
);