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"
36 static const char * const builtin_commit_usage
[] = {
37 N_("git commit [<options>] [--] <pathspec>..."),
41 static const char * const builtin_status_usage
[] = {
42 N_("git status [<options>] [--] <pathspec>..."),
46 static const char empty_amend_advice
[] =
47 N_("You asked to amend the most recent commit, but doing so would make\n"
48 "it empty. You can repeat your command with --allow-empty, or you can\n"
49 "remove the commit entirely with \"git reset HEAD^\".\n");
51 static const char empty_cherry_pick_advice
[] =
52 N_("The previous cherry-pick is now empty, possibly due to conflict resolution.\n"
53 "If you wish to commit it anyway, use:\n"
55 " git commit --allow-empty\n"
58 static const char empty_cherry_pick_advice_single
[] =
59 N_("Otherwise, please use 'git reset'\n");
61 static const char empty_cherry_pick_advice_multi
[] =
62 N_("If you wish to skip this commit, use:\n"
66 "Then \"git cherry-pick --continue\" will resume cherry-picking\n"
67 "the remaining commits.\n");
69 static const char *use_message_buffer
;
70 static struct lock_file index_lock
; /* real index */
71 static struct lock_file false_lock
; /* used only for partial commits */
78 static const char *logfile
, *force_author
;
79 static const char *template_file
;
81 * The _message variables are commit names from which to take
82 * the commit message and/or authorship.
84 static const char *author_message
, *author_message_buffer
;
85 static char *edit_message
, *use_message
;
86 static char *fixup_message
, *squash_message
;
87 static int all
, also
, interactive
, patch_interactive
, only
, amend
, signoff
;
88 static int edit_flag
= -1; /* unspecified */
89 static int quiet
, verbose
, no_verify
, allow_empty
, dry_run
, renew_authorship
;
90 static int config_commit_verbose
= -1; /* unspecified */
91 static int no_post_rewrite
, allow_empty_message
;
92 static char *untracked_files_arg
, *force_date
, *ignore_submodule_arg
, *ignored_arg
;
93 static char *sign_commit
;
96 * The default commit message cleanup mode will remove the lines
97 * beginning with # (shell comments) and leading and trailing
98 * whitespaces (empty lines or containing only whitespaces)
99 * if editor is used, and only the whitespaces if the message
100 * is specified explicitly.
102 static enum commit_msg_cleanup_mode cleanup_mode
;
103 static const char *cleanup_arg
;
105 static enum commit_whence whence
;
106 static int sequencer_in_use
;
107 static int use_editor
= 1, include_status
= 1;
108 static int have_option_m
;
109 static struct strbuf message
= STRBUF_INIT
;
111 static enum wt_status_format status_format
= STATUS_FORMAT_UNSPECIFIED
;
113 static int opt_parse_porcelain(const struct option
*opt
, const char *arg
, int unset
)
115 enum wt_status_format
*value
= (enum wt_status_format
*)opt
->value
;
117 *value
= STATUS_FORMAT_NONE
;
119 *value
= STATUS_FORMAT_PORCELAIN
;
120 else if (!strcmp(arg
, "v1") || !strcmp(arg
, "1"))
121 *value
= STATUS_FORMAT_PORCELAIN
;
122 else if (!strcmp(arg
, "v2") || !strcmp(arg
, "2"))
123 *value
= STATUS_FORMAT_PORCELAIN_V2
;
125 die("unsupported porcelain version '%s'", arg
);
130 static int opt_parse_m(const struct option
*opt
, const char *arg
, int unset
)
132 struct strbuf
*buf
= opt
->value
;
135 strbuf_setlen(buf
, 0);
139 strbuf_addch(buf
, '\n');
140 strbuf_addstr(buf
, arg
);
141 strbuf_complete_line(buf
);
146 static int opt_parse_rename_score(const struct option
*opt
, const char *arg
, int unset
)
148 const char **value
= opt
->value
;
149 if (arg
!= NULL
&& *arg
== '=')
156 static void determine_whence(struct wt_status
*s
)
158 if (file_exists(git_path_merge_head()))
160 else if (file_exists(git_path_cherry_pick_head())) {
161 whence
= FROM_CHERRY_PICK
;
162 if (file_exists(git_path_seq_dir()))
163 sequencer_in_use
= 1;
166 whence
= FROM_COMMIT
;
171 static void status_init_config(struct wt_status
*s
, config_fn_t fn
)
173 wt_status_prepare(s
);
174 init_diff_ui_defaults();
177 s
->hints
= advice_status_hints
; /* must come after git_config() */
180 static void rollback_index_files(void)
182 switch (commit_style
) {
184 break; /* nothing to do */
186 rollback_lock_file(&index_lock
);
189 rollback_lock_file(&index_lock
);
190 rollback_lock_file(&false_lock
);
195 static int commit_index_files(void)
199 switch (commit_style
) {
201 break; /* nothing to do */
203 err
= commit_lock_file(&index_lock
);
206 err
= commit_lock_file(&index_lock
);
207 rollback_lock_file(&false_lock
);
215 * Take a union of paths in the index and the named tree (typically, "HEAD"),
216 * and return the paths that match the given pattern in list.
218 static int list_paths(struct string_list
*list
, const char *with_tree
,
219 const char *prefix
, const struct pathspec
*pattern
)
227 m
= xcalloc(1, pattern
->nr
);
230 char *max_prefix
= common_prefix(pattern
);
231 overlay_tree_on_index(&the_index
, with_tree
, max_prefix
);
235 for (i
= 0; i
< active_nr
; i
++) {
236 const struct cache_entry
*ce
= active_cache
[i
];
237 struct string_list_item
*item
;
239 if (ce
->ce_flags
& CE_UPDATE
)
241 if (!ce_path_match(ce
, pattern
, m
))
243 item
= string_list_insert(list
, ce
->name
);
244 if (ce_skip_worktree(ce
))
245 item
->util
= item
; /* better a valid pointer than a fake one */
248 ret
= report_path_error(m
, pattern
, prefix
);
253 static void add_remove_files(struct string_list
*list
)
256 for (i
= 0; i
< list
->nr
; i
++) {
258 struct string_list_item
*p
= &(list
->items
[i
]);
260 /* p->util is skip-worktree */
264 if (!lstat(p
->string
, &st
)) {
265 if (add_to_cache(p
->string
, &st
, 0))
266 die(_("updating files failed"));
268 remove_file_from_cache(p
->string
);
272 static void create_base_index(const struct commit
*current_head
)
275 struct unpack_trees_options opts
;
283 memset(&opts
, 0, sizeof(opts
));
287 opts
.src_index
= &the_index
;
288 opts
.dst_index
= &the_index
;
290 opts
.fn
= oneway_merge
;
291 tree
= parse_tree_indirect(¤t_head
->object
.oid
);
293 die(_("failed to unpack HEAD tree object"));
295 init_tree_desc(&t
, tree
->buffer
, tree
->size
);
296 if (unpack_trees(1, &t
, &opts
))
297 exit(128); /* We've already reported the error, finish dying */
300 static void refresh_cache_or_die(int refresh_flags
)
303 * refresh_flags contains REFRESH_QUIET, so the only errors
304 * are for unmerged entries.
306 if (refresh_cache(refresh_flags
| REFRESH_IN_PORCELAIN
))
307 die_resolve_conflict("commit");
310 static const char *prepare_index(int argc
, const char **argv
, const char *prefix
,
311 const struct commit
*current_head
, int is_status
)
313 struct string_list partial
= STRING_LIST_INIT_DUP
;
314 struct pathspec pathspec
;
315 int refresh_flags
= REFRESH_QUIET
;
319 refresh_flags
|= REFRESH_UNMERGED
;
320 parse_pathspec(&pathspec
, 0,
321 PATHSPEC_PREFER_FULL
,
324 if (read_cache_preload(&pathspec
) < 0)
325 die(_("index file corrupt"));
328 char *old_index_env
= NULL
;
329 hold_locked_index(&index_lock
, LOCK_DIE_ON_ERROR
);
331 refresh_cache_or_die(refresh_flags
);
333 if (write_locked_index(&the_index
, &index_lock
, 0))
334 die(_("unable to create temporary index"));
336 old_index_env
= getenv(INDEX_ENVIRONMENT
);
337 setenv(INDEX_ENVIRONMENT
, get_lock_file_path(&index_lock
), 1);
339 if (interactive_add(argc
, argv
, prefix
, patch_interactive
) != 0)
340 die(_("interactive add failed"));
342 if (old_index_env
&& *old_index_env
)
343 setenv(INDEX_ENVIRONMENT
, old_index_env
, 1);
345 unsetenv(INDEX_ENVIRONMENT
);
348 read_cache_from(get_lock_file_path(&index_lock
));
349 if (update_main_cache_tree(WRITE_TREE_SILENT
) == 0) {
350 if (reopen_lock_file(&index_lock
) < 0)
351 die(_("unable to write index file"));
352 if (write_locked_index(&the_index
, &index_lock
, 0))
353 die(_("unable to update temporary index"));
355 warning(_("Failed to update main cache tree"));
357 commit_style
= COMMIT_NORMAL
;
358 ret
= get_lock_file_path(&index_lock
);
363 * Non partial, non as-is commit.
365 * (1) get the real index;
366 * (2) update the_index as necessary;
367 * (3) write the_index out to the real index (still locked);
368 * (4) return the name of the locked index file.
370 * The caller should run hooks on the locked real index, and
371 * (A) if all goes well, commit the real index;
372 * (B) on failure, rollback the real index.
374 if (all
|| (also
&& pathspec
.nr
)) {
375 hold_locked_index(&index_lock
, LOCK_DIE_ON_ERROR
);
376 add_files_to_cache(also
? prefix
: NULL
, &pathspec
, 0);
377 refresh_cache_or_die(refresh_flags
);
378 update_main_cache_tree(WRITE_TREE_SILENT
);
379 if (write_locked_index(&the_index
, &index_lock
, 0))
380 die(_("unable to write new_index file"));
381 commit_style
= COMMIT_NORMAL
;
382 ret
= get_lock_file_path(&index_lock
);
389 * (1) return the name of the real index file.
391 * The caller should run hooks on the real index,
392 * and create commit from the_index.
393 * We still need to refresh the index here.
395 if (!only
&& !pathspec
.nr
) {
396 hold_locked_index(&index_lock
, LOCK_DIE_ON_ERROR
);
397 refresh_cache_or_die(refresh_flags
);
398 if (active_cache_changed
399 || !cache_tree_fully_valid(active_cache_tree
))
400 update_main_cache_tree(WRITE_TREE_SILENT
);
401 if (write_locked_index(&the_index
, &index_lock
,
402 COMMIT_LOCK
| SKIP_IF_UNCHANGED
))
403 die(_("unable to write new_index file"));
404 commit_style
= COMMIT_AS_IS
;
405 ret
= get_index_file();
412 * (0) find the set of affected paths;
413 * (1) get lock on the real index file;
414 * (2) update the_index with the given paths;
415 * (3) write the_index out to the real index (still locked);
416 * (4) get lock on the false index file;
417 * (5) reset the_index from HEAD;
418 * (6) update the_index the same way as (2);
419 * (7) write the_index out to the false index file;
420 * (8) return the name of the false index file (still locked);
422 * The caller should run hooks on the locked false index, and
423 * create commit from it. Then
424 * (A) if all goes well, commit the real index;
425 * (B) on failure, rollback the real index;
426 * In either case, rollback the false index.
428 commit_style
= COMMIT_PARTIAL
;
430 if (whence
!= FROM_COMMIT
) {
431 if (whence
== FROM_MERGE
)
432 die(_("cannot do a partial commit during a merge."));
433 else if (whence
== FROM_CHERRY_PICK
)
434 die(_("cannot do a partial commit during a cherry-pick."));
437 if (list_paths(&partial
, !current_head
? NULL
: "HEAD", prefix
, &pathspec
))
441 if (read_cache() < 0)
442 die(_("cannot read the index"));
444 hold_locked_index(&index_lock
, LOCK_DIE_ON_ERROR
);
445 add_remove_files(&partial
);
446 refresh_cache(REFRESH_QUIET
);
447 update_main_cache_tree(WRITE_TREE_SILENT
);
448 if (write_locked_index(&the_index
, &index_lock
, 0))
449 die(_("unable to write new_index file"));
451 hold_lock_file_for_update(&false_lock
,
452 git_path("next-index-%"PRIuMAX
,
453 (uintmax_t) getpid()),
456 create_base_index(current_head
);
457 add_remove_files(&partial
);
458 refresh_cache(REFRESH_QUIET
);
460 if (write_locked_index(&the_index
, &false_lock
, 0))
461 die(_("unable to write temporary index file"));
464 ret
= get_lock_file_path(&false_lock
);
465 read_cache_from(ret
);
467 string_list_clear(&partial
, 0);
468 clear_pathspec(&pathspec
);
472 static int run_status(FILE *fp
, const char *index_file
, const char *prefix
, int nowarn
,
475 struct object_id oid
;
477 if (s
->relative_paths
)
482 s
->reference
= "HEAD^1";
484 s
->verbose
= verbose
;
485 s
->index_file
= index_file
;
488 s
->is_initial
= get_oid(s
->reference
, &oid
) ? 1 : 0;
490 hashcpy(s
->sha1_commit
, oid
.hash
);
491 s
->status_format
= status_format
;
492 s
->ignore_submodule_arg
= ignore_submodule_arg
;
494 wt_status_collect(s
);
497 return s
->commitable
;
500 static int is_a_merge(const struct commit
*current_head
)
502 return !!(current_head
->parents
&& current_head
->parents
->next
);
505 static void assert_split_ident(struct ident_split
*id
, const struct strbuf
*buf
)
507 if (split_ident_line(id
, buf
->buf
, buf
->len
) || !id
->date_begin
)
508 BUG("unable to parse our own ident: %s", buf
->buf
);
511 static void export_one(const char *var
, const char *s
, const char *e
, int hack
)
513 struct strbuf buf
= STRBUF_INIT
;
515 strbuf_addch(&buf
, hack
);
516 strbuf_addf(&buf
, "%.*s", (int)(e
- s
), s
);
517 setenv(var
, buf
.buf
, 1);
518 strbuf_release(&buf
);
521 static int parse_force_date(const char *in
, struct strbuf
*out
)
523 strbuf_addch(out
, '@');
525 if (parse_date(in
, out
) < 0) {
527 unsigned long t
= approxidate_careful(in
, &errors
);
530 strbuf_addf(out
, "%lu", t
);
536 static void set_ident_var(char **buf
, char *val
)
542 static void determine_author_info(struct strbuf
*author_ident
)
544 char *name
, *email
, *date
;
545 struct ident_split author
;
547 name
= xstrdup_or_null(getenv("GIT_AUTHOR_NAME"));
548 email
= xstrdup_or_null(getenv("GIT_AUTHOR_EMAIL"));
549 date
= xstrdup_or_null(getenv("GIT_AUTHOR_DATE"));
551 if (author_message
) {
552 struct ident_split ident
;
556 a
= find_commit_header(author_message_buffer
, "author", &len
);
558 die(_("commit '%s' lacks author header"), author_message
);
559 if (split_ident_line(&ident
, a
, len
) < 0)
560 die(_("commit '%s' has malformed author line"), author_message
);
562 set_ident_var(&name
, xmemdupz(ident
.name_begin
, ident
.name_end
- ident
.name_begin
));
563 set_ident_var(&email
, xmemdupz(ident
.mail_begin
, ident
.mail_end
- ident
.mail_begin
));
565 if (ident
.date_begin
) {
566 struct strbuf date_buf
= STRBUF_INIT
;
567 strbuf_addch(&date_buf
, '@');
568 strbuf_add(&date_buf
, ident
.date_begin
, ident
.date_end
- ident
.date_begin
);
569 strbuf_addch(&date_buf
, ' ');
570 strbuf_add(&date_buf
, ident
.tz_begin
, ident
.tz_end
- ident
.tz_begin
);
571 set_ident_var(&date
, strbuf_detach(&date_buf
, NULL
));
576 struct ident_split ident
;
578 if (split_ident_line(&ident
, force_author
, strlen(force_author
)) < 0)
579 die(_("malformed --author parameter"));
580 set_ident_var(&name
, xmemdupz(ident
.name_begin
, ident
.name_end
- ident
.name_begin
));
581 set_ident_var(&email
, xmemdupz(ident
.mail_begin
, ident
.mail_end
- ident
.mail_begin
));
585 struct strbuf date_buf
= STRBUF_INIT
;
586 if (parse_force_date(force_date
, &date_buf
))
587 die(_("invalid date format: %s"), force_date
);
588 set_ident_var(&date
, strbuf_detach(&date_buf
, NULL
));
591 strbuf_addstr(author_ident
, fmt_ident(name
, email
, date
, IDENT_STRICT
));
592 assert_split_ident(&author
, author_ident
);
593 export_one("GIT_AUTHOR_NAME", author
.name_begin
, author
.name_end
, 0);
594 export_one("GIT_AUTHOR_EMAIL", author
.mail_begin
, author
.mail_end
, 0);
595 export_one("GIT_AUTHOR_DATE", author
.date_begin
, author
.tz_end
, '@');
601 static int author_date_is_interesting(void)
603 return author_message
|| force_date
;
606 static void adjust_comment_line_char(const struct strbuf
*sb
)
608 char candidates
[] = "#;@!$%^&|:";
612 comment_line_char
= candidates
[0];
613 if (!memchr(sb
->buf
, comment_line_char
, sb
->len
))
617 candidate
= strchr(candidates
, *p
);
620 for (p
= sb
->buf
; *p
; p
++) {
621 if ((p
[0] == '\n' || p
[0] == '\r') && p
[1]) {
622 candidate
= strchr(candidates
, p
[1]);
628 for (p
= candidates
; *p
== ' '; p
++)
631 die(_("unable to select a comment character that is not used\n"
632 "in the current commit message"));
633 comment_line_char
= *p
;
636 static int prepare_to_commit(const char *index_file
, const char *prefix
,
637 struct commit
*current_head
,
639 struct strbuf
*author_ident
)
642 struct strbuf committer_ident
= STRBUF_INIT
;
644 struct strbuf sb
= STRBUF_INIT
;
645 const char *hook_arg1
= NULL
;
646 const char *hook_arg2
= NULL
;
647 int clean_message_contents
= (cleanup_mode
!= COMMIT_MSG_CLEANUP_NONE
);
648 int old_display_comment_prefix
;
650 /* This checks and barfs if author is badly specified */
651 determine_author_info(author_ident
);
653 if (!no_verify
&& run_commit_hook(use_editor
, index_file
, "pre-commit", NULL
))
656 if (squash_message
) {
658 * Insert the proper subject line before other commit
659 * message options add their content.
661 if (use_message
&& !strcmp(use_message
, squash_message
))
662 strbuf_addstr(&sb
, "squash! ");
664 struct pretty_print_context ctx
= {0};
666 c
= lookup_commit_reference_by_name(squash_message
);
668 die(_("could not lookup commit %s"), squash_message
);
669 ctx
.output_encoding
= get_commit_output_encoding();
670 format_commit_message(c
, "squash! %s\n\n", &sb
,
675 if (have_option_m
&& !fixup_message
) {
676 strbuf_addbuf(&sb
, &message
);
677 hook_arg1
= "message";
678 } else if (logfile
&& !strcmp(logfile
, "-")) {
680 fprintf(stderr
, _("(reading log message from standard input)\n"));
681 if (strbuf_read(&sb
, 0, 0) < 0)
682 die_errno(_("could not read log from standard input"));
683 hook_arg1
= "message";
684 } else if (logfile
) {
685 if (strbuf_read_file(&sb
, logfile
, 0) < 0)
686 die_errno(_("could not read log file '%s'"),
688 hook_arg1
= "message";
689 } else if (use_message
) {
691 buffer
= strstr(use_message_buffer
, "\n\n");
693 strbuf_addstr(&sb
, skip_blank_lines(buffer
+ 2));
694 hook_arg1
= "commit";
695 hook_arg2
= use_message
;
696 } else if (fixup_message
) {
697 struct pretty_print_context ctx
= {0};
698 struct commit
*commit
;
699 commit
= lookup_commit_reference_by_name(fixup_message
);
701 die(_("could not lookup commit %s"), fixup_message
);
702 ctx
.output_encoding
= get_commit_output_encoding();
703 format_commit_message(commit
, "fixup! %s\n\n",
706 strbuf_addbuf(&sb
, &message
);
707 hook_arg1
= "message";
708 } else if (!stat(git_path_merge_msg(), &statbuf
)) {
710 * prepend SQUASH_MSG here if it exists and a
711 * "merge --squash" was originally performed
713 if (!stat(git_path_squash_msg(), &statbuf
)) {
714 if (strbuf_read_file(&sb
, git_path_squash_msg(), 0) < 0)
715 die_errno(_("could not read SQUASH_MSG"));
716 hook_arg1
= "squash";
719 if (strbuf_read_file(&sb
, git_path_merge_msg(), 0) < 0)
720 die_errno(_("could not read MERGE_MSG"));
721 } else if (!stat(git_path_squash_msg(), &statbuf
)) {
722 if (strbuf_read_file(&sb
, git_path_squash_msg(), 0) < 0)
723 die_errno(_("could not read SQUASH_MSG"));
724 hook_arg1
= "squash";
725 } else if (template_file
) {
726 if (strbuf_read_file(&sb
, template_file
, 0) < 0)
727 die_errno(_("could not read '%s'"), template_file
);
728 hook_arg1
= "template";
729 clean_message_contents
= 0;
733 * The remaining cases don't modify the template message, but
734 * just set the argument(s) to the prepare-commit-msg hook.
736 else if (whence
== FROM_MERGE
)
738 else if (whence
== FROM_CHERRY_PICK
) {
739 hook_arg1
= "commit";
740 hook_arg2
= "CHERRY_PICK_HEAD";
743 if (squash_message
) {
745 * If squash_commit was used for the commit subject,
746 * then we're possibly hijacking other commit log options.
747 * Reset the hook args to tell the real story.
749 hook_arg1
= "message";
753 s
->fp
= fopen_for_writing(git_path_commit_editmsg());
755 die_errno(_("could not open '%s'"), git_path_commit_editmsg());
757 /* Ignore status.displayCommentPrefix: we do need comments in COMMIT_EDITMSG. */
758 old_display_comment_prefix
= s
->display_comment_prefix
;
759 s
->display_comment_prefix
= 1;
762 * Most hints are counter-productive when the commit has
767 if (clean_message_contents
)
768 strbuf_stripspace(&sb
, 0);
771 append_signoff(&sb
, ignore_non_trailer(sb
.buf
, sb
.len
), 0);
773 if (fwrite(sb
.buf
, 1, sb
.len
, s
->fp
) < sb
.len
)
774 die_errno(_("could not write commit template"));
776 if (auto_comment_line_char
)
777 adjust_comment_line_char(&sb
);
780 /* This checks if committer ident is explicitly given */
781 strbuf_addstr(&committer_ident
, git_committer_info(IDENT_STRICT
));
782 if (use_editor
&& include_status
) {
784 int saved_color_setting
;
785 struct ident_split ci
, ai
;
787 if (whence
!= FROM_COMMIT
) {
788 if (cleanup_mode
== COMMIT_MSG_CLEANUP_SCISSORS
)
789 wt_status_add_cut_line(s
->fp
);
790 status_printf_ln(s
, GIT_COLOR_NORMAL
,
793 "It looks like you may be committing a merge.\n"
794 "If this is not correct, please remove the file\n"
798 "It looks like you may be committing a cherry-pick.\n"
799 "If this is not correct, please remove the file\n"
802 whence
== FROM_MERGE
?
803 git_path_merge_head() :
804 git_path_cherry_pick_head());
807 fprintf(s
->fp
, "\n");
808 if (cleanup_mode
== COMMIT_MSG_CLEANUP_ALL
)
809 status_printf(s
, GIT_COLOR_NORMAL
,
810 _("Please enter the commit message for your changes."
811 " Lines starting\nwith '%c' will be ignored, and an empty"
812 " message aborts the commit.\n"), comment_line_char
);
813 else if (cleanup_mode
== COMMIT_MSG_CLEANUP_SCISSORS
&&
814 whence
== FROM_COMMIT
)
815 wt_status_add_cut_line(s
->fp
);
816 else /* COMMIT_MSG_CLEANUP_SPACE, that is. */
817 status_printf(s
, GIT_COLOR_NORMAL
,
818 _("Please enter the commit message for your changes."
820 "with '%c' will be kept; you may remove them"
821 " yourself if you want to.\n"
822 "An empty message aborts the commit.\n"), comment_line_char
);
825 * These should never fail because they come from our own
826 * fmt_ident. They may fail the sane_ident test, but we know
827 * that the name and mail pointers will at least be valid,
828 * which is enough for our tests and printing here.
830 assert_split_ident(&ai
, author_ident
);
831 assert_split_ident(&ci
, &committer_ident
);
833 if (ident_cmp(&ai
, &ci
))
834 status_printf_ln(s
, GIT_COLOR_NORMAL
,
836 "Author: %.*s <%.*s>"),
837 ident_shown
++ ? "" : "\n",
838 (int)(ai
.name_end
- ai
.name_begin
), ai
.name_begin
,
839 (int)(ai
.mail_end
- ai
.mail_begin
), ai
.mail_begin
);
841 if (author_date_is_interesting())
842 status_printf_ln(s
, GIT_COLOR_NORMAL
,
845 ident_shown
++ ? "" : "\n",
846 show_ident_date(&ai
, DATE_MODE(NORMAL
)));
848 if (!committer_ident_sufficiently_given())
849 status_printf_ln(s
, GIT_COLOR_NORMAL
,
851 "Committer: %.*s <%.*s>"),
852 ident_shown
++ ? "" : "\n",
853 (int)(ci
.name_end
- ci
.name_begin
), ci
.name_begin
,
854 (int)(ci
.mail_end
- ci
.mail_begin
), ci
.mail_begin
);
856 status_printf_ln(s
, GIT_COLOR_NORMAL
, "%s", ""); /* Add new line for clarity */
858 saved_color_setting
= s
->use_color
;
860 commitable
= run_status(s
->fp
, index_file
, prefix
, 1, s
);
861 s
->use_color
= saved_color_setting
;
863 struct object_id oid
;
864 const char *parent
= "HEAD";
866 if (!active_nr
&& read_cache() < 0)
867 die(_("Cannot read index"));
872 if (get_oid(parent
, &oid
)) {
875 for (i
= 0; i
< active_nr
; i
++)
876 if (ce_intent_to_add(active_cache
[i
]))
878 commitable
= active_nr
- ita_nr
> 0;
881 * Unless the user did explicitly request a submodule
882 * ignore mode by passing a command line option we do
883 * not ignore any changed submodule SHA-1s when
884 * comparing index and parent, no matter what is
885 * configured. Otherwise we won't commit any
886 * submodules which were manually staged, which would
887 * be really confusing.
889 struct diff_flags flags
= DIFF_FLAGS_INIT
;
890 flags
.override_submodule_config
= 1;
891 if (ignore_submodule_arg
&&
892 !strcmp(ignore_submodule_arg
, "all"))
893 flags
.ignore_submodules
= 1;
894 commitable
= index_differs_from(parent
, &flags
, 1);
897 strbuf_release(&committer_ident
);
902 * Reject an attempt to record a non-merge empty commit without
903 * explicit --allow-empty. In the cherry-pick case, it may be
904 * empty due to conflict resolution, which the user should okay.
906 if (!commitable
&& whence
!= FROM_MERGE
&& !allow_empty
&&
907 !(amend
&& is_a_merge(current_head
))) {
908 s
->display_comment_prefix
= old_display_comment_prefix
;
909 run_status(stdout
, index_file
, prefix
, 0, s
);
911 fputs(_(empty_amend_advice
), stderr
);
912 else if (whence
== FROM_CHERRY_PICK
) {
913 fputs(_(empty_cherry_pick_advice
), stderr
);
914 if (!sequencer_in_use
)
915 fputs(_(empty_cherry_pick_advice_single
), stderr
);
917 fputs(_(empty_cherry_pick_advice_multi
), stderr
);
922 if (!no_verify
&& find_hook("pre-commit")) {
924 * Re-read the index as pre-commit hook could have updated it,
925 * and write it out as a tree. We must do this before we invoke
926 * the editor and after we invoke run_status above.
930 read_cache_from(index_file
);
932 if (update_main_cache_tree(0)) {
933 error(_("Error building trees"));
937 if (run_commit_hook(use_editor
, index_file
, "prepare-commit-msg",
938 git_path_commit_editmsg(), hook_arg1
, hook_arg2
, NULL
))
942 struct argv_array env
= ARGV_ARRAY_INIT
;
944 argv_array_pushf(&env
, "GIT_INDEX_FILE=%s", index_file
);
945 if (launch_editor(git_path_commit_editmsg(), NULL
, env
.argv
)) {
947 _("Please supply the message using either -m or -F option.\n"));
950 argv_array_clear(&env
);
954 run_commit_hook(use_editor
, index_file
, "commit-msg", git_path_commit_editmsg(), NULL
)) {
961 static const char *find_author_by_nickname(const char *name
)
963 struct rev_info revs
;
964 struct commit
*commit
;
965 struct strbuf buf
= STRBUF_INIT
;
966 struct string_list mailmap
= STRING_LIST_INIT_NODUP
;
970 init_revisions(&revs
, NULL
);
971 strbuf_addf(&buf
, "--author=%s", name
);
976 setup_revisions(ac
, av
, &revs
, NULL
);
977 revs
.mailmap
= &mailmap
;
978 read_mailmap(revs
.mailmap
, NULL
);
980 if (prepare_revision_walk(&revs
))
981 die(_("revision walk setup failed"));
982 commit
= get_revision(&revs
);
984 struct pretty_print_context ctx
= {0};
985 ctx
.date_mode
.type
= DATE_NORMAL
;
986 strbuf_release(&buf
);
987 format_commit_message(commit
, "%aN <%aE>", &buf
, &ctx
);
988 clear_mailmap(&mailmap
);
989 return strbuf_detach(&buf
, NULL
);
991 die(_("--author '%s' is not 'Name <email>' and matches no existing author"), name
);
994 static void handle_ignored_arg(struct wt_status
*s
)
997 ; /* default already initialized */
998 else if (!strcmp(ignored_arg
, "traditional"))
999 s
->show_ignored_mode
= SHOW_TRADITIONAL_IGNORED
;
1000 else if (!strcmp(ignored_arg
, "no"))
1001 s
->show_ignored_mode
= SHOW_NO_IGNORED
;
1002 else if (!strcmp(ignored_arg
, "matching"))
1003 s
->show_ignored_mode
= SHOW_MATCHING_IGNORED
;
1005 die(_("Invalid ignored mode '%s'"), ignored_arg
);
1008 static void handle_untracked_files_arg(struct wt_status
*s
)
1010 if (!untracked_files_arg
)
1011 ; /* default already initialized */
1012 else if (!strcmp(untracked_files_arg
, "no"))
1013 s
->show_untracked_files
= SHOW_NO_UNTRACKED_FILES
;
1014 else if (!strcmp(untracked_files_arg
, "normal"))
1015 s
->show_untracked_files
= SHOW_NORMAL_UNTRACKED_FILES
;
1016 else if (!strcmp(untracked_files_arg
, "all"))
1017 s
->show_untracked_files
= SHOW_ALL_UNTRACKED_FILES
;
1019 die(_("Invalid untracked files mode '%s'"), untracked_files_arg
);
1022 static const char *read_commit_message(const char *name
)
1024 const char *out_enc
;
1025 struct commit
*commit
;
1027 commit
= lookup_commit_reference_by_name(name
);
1029 die(_("could not lookup commit %s"), name
);
1030 out_enc
= get_commit_output_encoding();
1031 return logmsg_reencode(commit
, NULL
, out_enc
);
1035 * Enumerate what needs to be propagated when --porcelain
1036 * is not in effect here.
1038 static struct status_deferred_config
{
1039 enum wt_status_format status_format
;
1041 } status_deferred_config
= {
1042 STATUS_FORMAT_UNSPECIFIED
,
1043 -1 /* unspecified */
1046 static void finalize_deferred_config(struct wt_status
*s
)
1048 int use_deferred_config
= (status_format
!= STATUS_FORMAT_PORCELAIN
&&
1049 status_format
!= STATUS_FORMAT_PORCELAIN_V2
&&
1050 !s
->null_termination
);
1052 if (s
->null_termination
) {
1053 if (status_format
== STATUS_FORMAT_NONE
||
1054 status_format
== STATUS_FORMAT_UNSPECIFIED
)
1055 status_format
= STATUS_FORMAT_PORCELAIN
;
1056 else if (status_format
== STATUS_FORMAT_LONG
)
1057 die(_("--long and -z are incompatible"));
1060 if (use_deferred_config
&& status_format
== STATUS_FORMAT_UNSPECIFIED
)
1061 status_format
= status_deferred_config
.status_format
;
1062 if (status_format
== STATUS_FORMAT_UNSPECIFIED
)
1063 status_format
= STATUS_FORMAT_NONE
;
1065 if (use_deferred_config
&& s
->show_branch
< 0)
1066 s
->show_branch
= status_deferred_config
.show_branch
;
1067 if (s
->show_branch
< 0)
1070 if (s
->ahead_behind_flags
== AHEAD_BEHIND_UNSPECIFIED
)
1071 s
->ahead_behind_flags
= AHEAD_BEHIND_FULL
;
1074 static int parse_and_validate_options(int argc
, const char *argv
[],
1075 const struct option
*options
,
1076 const char * const usage
[],
1078 struct commit
*current_head
,
1079 struct wt_status
*s
)
1083 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
1084 finalize_deferred_config(s
);
1086 if (force_author
&& !strchr(force_author
, '>'))
1087 force_author
= find_author_by_nickname(force_author
);
1089 if (force_author
&& renew_authorship
)
1090 die(_("Using both --reset-author and --author does not make sense"));
1092 if (logfile
|| have_option_m
|| use_message
|| fixup_message
)
1095 use_editor
= edit_flag
;
1097 /* Sanity check options */
1098 if (amend
&& !current_head
)
1099 die(_("You have nothing to amend."));
1100 if (amend
&& whence
!= FROM_COMMIT
) {
1101 if (whence
== FROM_MERGE
)
1102 die(_("You are in the middle of a merge -- cannot amend."));
1103 else if (whence
== FROM_CHERRY_PICK
)
1104 die(_("You are in the middle of a cherry-pick -- cannot amend."));
1106 if (fixup_message
&& squash_message
)
1107 die(_("Options --squash and --fixup cannot be used together"));
1117 die(_("Only one of -c/-C/-F/--fixup can be used."));
1118 if (have_option_m
&& (edit_message
|| use_message
|| logfile
))
1119 die((_("Option -m cannot be combined with -c/-C/-F.")));
1120 if (f
|| have_option_m
)
1121 template_file
= NULL
;
1123 use_message
= edit_message
;
1124 if (amend
&& !use_message
&& !fixup_message
)
1125 use_message
= "HEAD";
1126 if (!use_message
&& whence
!= FROM_CHERRY_PICK
&& renew_authorship
)
1127 die(_("--reset-author can be used only with -C, -c or --amend."));
1129 use_message_buffer
= read_commit_message(use_message
);
1130 if (!renew_authorship
) {
1131 author_message
= use_message
;
1132 author_message_buffer
= use_message_buffer
;
1135 if (whence
== FROM_CHERRY_PICK
&& !renew_authorship
) {
1136 author_message
= "CHERRY_PICK_HEAD";
1137 author_message_buffer
= read_commit_message(author_message
);
1140 if (patch_interactive
)
1143 if (also
+ only
+ all
+ interactive
> 1)
1144 die(_("Only one of --include/--only/--all/--interactive/--patch can be used."));
1145 if (argc
== 0 && (also
|| (only
&& !amend
&& !allow_empty
)))
1146 die(_("No paths with --include/--only does not make sense."));
1147 if (!cleanup_arg
|| !strcmp(cleanup_arg
, "default"))
1148 cleanup_mode
= use_editor
? COMMIT_MSG_CLEANUP_ALL
:
1149 COMMIT_MSG_CLEANUP_SPACE
;
1150 else if (!strcmp(cleanup_arg
, "verbatim"))
1151 cleanup_mode
= COMMIT_MSG_CLEANUP_NONE
;
1152 else if (!strcmp(cleanup_arg
, "whitespace"))
1153 cleanup_mode
= COMMIT_MSG_CLEANUP_SPACE
;
1154 else if (!strcmp(cleanup_arg
, "strip"))
1155 cleanup_mode
= COMMIT_MSG_CLEANUP_ALL
;
1156 else if (!strcmp(cleanup_arg
, "scissors"))
1157 cleanup_mode
= use_editor
? COMMIT_MSG_CLEANUP_SCISSORS
:
1158 COMMIT_MSG_CLEANUP_SPACE
;
1160 die(_("Invalid cleanup mode %s"), cleanup_arg
);
1162 handle_untracked_files_arg(s
);
1164 if (all
&& argc
> 0)
1165 die(_("Paths with -a does not make sense."));
1167 if (status_format
!= STATUS_FORMAT_NONE
)
1173 static int dry_run_commit(int argc
, const char **argv
, const char *prefix
,
1174 const struct commit
*current_head
, struct wt_status
*s
)
1177 const char *index_file
;
1179 index_file
= prepare_index(argc
, argv
, prefix
, current_head
, 1);
1180 commitable
= run_status(stdout
, index_file
, prefix
, 0, s
);
1181 rollback_index_files();
1183 return commitable
? 0 : 1;
1186 static int parse_status_slot(const char *slot
)
1188 if (!strcasecmp(slot
, "header"))
1189 return WT_STATUS_HEADER
;
1190 if (!strcasecmp(slot
, "branch"))
1191 return WT_STATUS_ONBRANCH
;
1192 if (!strcasecmp(slot
, "updated") || !strcasecmp(slot
, "added"))
1193 return WT_STATUS_UPDATED
;
1194 if (!strcasecmp(slot
, "changed"))
1195 return WT_STATUS_CHANGED
;
1196 if (!strcasecmp(slot
, "untracked"))
1197 return WT_STATUS_UNTRACKED
;
1198 if (!strcasecmp(slot
, "nobranch"))
1199 return WT_STATUS_NOBRANCH
;
1200 if (!strcasecmp(slot
, "unmerged"))
1201 return WT_STATUS_UNMERGED
;
1202 if (!strcasecmp(slot
, "localBranch"))
1203 return WT_STATUS_LOCAL_BRANCH
;
1204 if (!strcasecmp(slot
, "remoteBranch"))
1205 return WT_STATUS_REMOTE_BRANCH
;
1209 static int git_status_config(const char *k
, const char *v
, void *cb
)
1211 struct wt_status
*s
= cb
;
1212 const char *slot_name
;
1214 if (starts_with(k
, "column."))
1215 return git_column_config(k
, v
, "status", &s
->colopts
);
1216 if (!strcmp(k
, "status.submodulesummary")) {
1218 s
->submodule_summary
= git_config_bool_or_int(k
, v
, &is_bool
);
1219 if (is_bool
&& s
->submodule_summary
)
1220 s
->submodule_summary
= -1;
1223 if (!strcmp(k
, "status.short")) {
1224 if (git_config_bool(k
, v
))
1225 status_deferred_config
.status_format
= STATUS_FORMAT_SHORT
;
1227 status_deferred_config
.status_format
= STATUS_FORMAT_NONE
;
1230 if (!strcmp(k
, "status.branch")) {
1231 status_deferred_config
.show_branch
= git_config_bool(k
, v
);
1234 if (!strcmp(k
, "status.showstash")) {
1235 s
->show_stash
= git_config_bool(k
, v
);
1238 if (!strcmp(k
, "status.color") || !strcmp(k
, "color.status")) {
1239 s
->use_color
= git_config_colorbool(k
, v
);
1242 if (!strcmp(k
, "status.displaycommentprefix")) {
1243 s
->display_comment_prefix
= git_config_bool(k
, v
);
1246 if (skip_prefix(k
, "status.color.", &slot_name
) ||
1247 skip_prefix(k
, "color.status.", &slot_name
)) {
1248 int slot
= parse_status_slot(slot_name
);
1252 return config_error_nonbool(k
);
1253 return color_parse(v
, s
->color_palette
[slot
]);
1255 if (!strcmp(k
, "status.relativepaths")) {
1256 s
->relative_paths
= git_config_bool(k
, v
);
1259 if (!strcmp(k
, "status.showuntrackedfiles")) {
1261 return config_error_nonbool(k
);
1262 else if (!strcmp(v
, "no"))
1263 s
->show_untracked_files
= SHOW_NO_UNTRACKED_FILES
;
1264 else if (!strcmp(v
, "normal"))
1265 s
->show_untracked_files
= SHOW_NORMAL_UNTRACKED_FILES
;
1266 else if (!strcmp(v
, "all"))
1267 s
->show_untracked_files
= SHOW_ALL_UNTRACKED_FILES
;
1269 return error(_("Invalid untracked files mode '%s'"), v
);
1272 if (!strcmp(k
, "diff.renamelimit")) {
1273 if (s
->rename_limit
== -1)
1274 s
->rename_limit
= git_config_int(k
, v
);
1277 if (!strcmp(k
, "status.renamelimit")) {
1278 s
->rename_limit
= git_config_int(k
, v
);
1281 if (!strcmp(k
, "diff.renames")) {
1282 if (s
->detect_rename
== -1)
1283 s
->detect_rename
= git_config_rename(k
, v
);
1286 if (!strcmp(k
, "status.renames")) {
1287 s
->detect_rename
= git_config_rename(k
, v
);
1290 return git_diff_ui_config(k
, v
, NULL
);
1293 int cmd_status(int argc
, const char **argv
, const char *prefix
)
1295 static int no_renames
= -1;
1296 static const char *rename_score_arg
= (const char *)-1;
1297 static struct wt_status s
;
1299 struct object_id oid
;
1300 static struct option builtin_status_options
[] = {
1301 OPT__VERBOSE(&verbose
, N_("be verbose")),
1302 OPT_SET_INT('s', "short", &status_format
,
1303 N_("show status concisely"), STATUS_FORMAT_SHORT
),
1304 OPT_BOOL('b', "branch", &s
.show_branch
,
1305 N_("show branch information")),
1306 OPT_BOOL(0, "show-stash", &s
.show_stash
,
1307 N_("show stash information")),
1308 OPT_BOOL(0, "ahead-behind", &s
.ahead_behind_flags
,
1309 N_("compute full ahead/behind values")),
1310 { OPTION_CALLBACK
, 0, "porcelain", &status_format
,
1311 N_("version"), N_("machine-readable output"),
1312 PARSE_OPT_OPTARG
, opt_parse_porcelain
},
1313 OPT_SET_INT(0, "long", &status_format
,
1314 N_("show status in long format (default)"),
1315 STATUS_FORMAT_LONG
),
1316 OPT_BOOL('z', "null", &s
.null_termination
,
1317 N_("terminate entries with NUL")),
1318 { OPTION_STRING
, 'u', "untracked-files", &untracked_files_arg
,
1320 N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1321 PARSE_OPT_OPTARG
, NULL
, (intptr_t)"all" },
1322 { OPTION_STRING
, 0, "ignored", &ignored_arg
,
1324 N_("show ignored files, optional modes: traditional, matching, no. (Default: traditional)"),
1325 PARSE_OPT_OPTARG
, NULL
, (intptr_t)"traditional" },
1326 { OPTION_STRING
, 0, "ignore-submodules", &ignore_submodule_arg
, N_("when"),
1327 N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
1328 PARSE_OPT_OPTARG
, NULL
, (intptr_t)"all" },
1329 OPT_COLUMN(0, "column", &s
.colopts
, N_("list untracked files in columns")),
1330 OPT_BOOL(0, "no-renames", &no_renames
, N_("do not detect renames")),
1331 { OPTION_CALLBACK
, 'M', "find-renames", &rename_score_arg
,
1332 N_("n"), N_("detect renames, optionally set similarity index"),
1333 PARSE_OPT_OPTARG
, opt_parse_rename_score
},
1337 if (argc
== 2 && !strcmp(argv
[1], "-h"))
1338 usage_with_options(builtin_status_usage
, builtin_status_options
);
1340 status_init_config(&s
, git_status_config
);
1341 argc
= parse_options(argc
, argv
, prefix
,
1342 builtin_status_options
,
1343 builtin_status_usage
, 0);
1344 finalize_colopts(&s
.colopts
, -1);
1345 finalize_deferred_config(&s
);
1347 handle_untracked_files_arg(&s
);
1348 handle_ignored_arg(&s
);
1350 if (s
.show_ignored_mode
== SHOW_MATCHING_IGNORED
&&
1351 s
.show_untracked_files
== SHOW_NO_UNTRACKED_FILES
)
1352 die(_("Unsupported combination of ignored and untracked-files arguments"));
1354 parse_pathspec(&s
.pathspec
, 0,
1355 PATHSPEC_PREFER_FULL
,
1358 read_cache_preload(&s
.pathspec
);
1359 refresh_index(&the_index
, REFRESH_QUIET
|REFRESH_UNMERGED
, &s
.pathspec
, NULL
, NULL
);
1361 if (use_optional_locks())
1362 fd
= hold_locked_index(&index_lock
, 0);
1366 s
.is_initial
= get_oid(s
.reference
, &oid
) ? 1 : 0;
1368 hashcpy(s
.sha1_commit
, oid
.hash
);
1370 s
.ignore_submodule_arg
= ignore_submodule_arg
;
1371 s
.status_format
= status_format
;
1372 s
.verbose
= verbose
;
1373 if (no_renames
!= -1)
1374 s
.detect_rename
= !no_renames
;
1375 if ((intptr_t)rename_score_arg
!= -1) {
1376 if (s
.detect_rename
< DIFF_DETECT_RENAME
)
1377 s
.detect_rename
= DIFF_DETECT_RENAME
;
1378 if (rename_score_arg
)
1379 s
.rename_score
= parse_rename_score(&rename_score_arg
);
1382 wt_status_collect(&s
);
1385 update_index_if_able(&the_index
, &index_lock
);
1387 if (s
.relative_paths
)
1390 wt_status_print(&s
);
1394 static int git_commit_config(const char *k
, const char *v
, void *cb
)
1396 struct wt_status
*s
= cb
;
1399 if (!strcmp(k
, "commit.template"))
1400 return git_config_pathname(&template_file
, k
, v
);
1401 if (!strcmp(k
, "commit.status")) {
1402 include_status
= git_config_bool(k
, v
);
1405 if (!strcmp(k
, "commit.cleanup"))
1406 return git_config_string(&cleanup_arg
, k
, v
);
1407 if (!strcmp(k
, "commit.gpgsign")) {
1408 sign_commit
= git_config_bool(k
, v
) ? "" : NULL
;
1411 if (!strcmp(k
, "commit.verbose")) {
1413 config_commit_verbose
= git_config_bool_or_int(k
, v
, &is_bool
);
1417 status
= git_gpg_config(k
, v
, NULL
);
1420 return git_status_config(k
, v
, s
);
1423 int run_commit_hook(int editor_is_used
, const char *index_file
, const char *name
, ...)
1425 struct argv_array hook_env
= ARGV_ARRAY_INIT
;
1429 argv_array_pushf(&hook_env
, "GIT_INDEX_FILE=%s", index_file
);
1432 * Let the hook know that no editor will be launched.
1434 if (!editor_is_used
)
1435 argv_array_push(&hook_env
, "GIT_EDITOR=:");
1437 va_start(args
, name
);
1438 ret
= run_hook_ve(hook_env
.argv
,name
, args
);
1440 argv_array_clear(&hook_env
);
1445 int cmd_commit(int argc
, const char **argv
, const char *prefix
)
1447 const char *argv_gc_auto
[] = {"gc", "--auto", NULL
};
1448 static struct wt_status s
;
1449 static struct option builtin_commit_options
[] = {
1450 OPT__QUIET(&quiet
, N_("suppress summary after successful commit")),
1451 OPT__VERBOSE(&verbose
, N_("show diff in commit message template")),
1453 OPT_GROUP(N_("Commit message options")),
1454 OPT_FILENAME('F', "file", &logfile
, N_("read message from file")),
1455 OPT_STRING(0, "author", &force_author
, N_("author"), N_("override author for commit")),
1456 OPT_STRING(0, "date", &force_date
, N_("date"), N_("override date for commit")),
1457 OPT_CALLBACK('m', "message", &message
, N_("message"), N_("commit message"), opt_parse_m
),
1458 OPT_STRING('c', "reedit-message", &edit_message
, N_("commit"), N_("reuse and edit message from specified commit")),
1459 OPT_STRING('C', "reuse-message", &use_message
, N_("commit"), N_("reuse message from specified commit")),
1460 OPT_STRING(0, "fixup", &fixup_message
, N_("commit"), N_("use autosquash formatted message to fixup specified commit")),
1461 OPT_STRING(0, "squash", &squash_message
, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
1462 OPT_BOOL(0, "reset-author", &renew_authorship
, N_("the commit is authored by me now (used with -C/-c/--amend)")),
1463 OPT_BOOL('s', "signoff", &signoff
, N_("add Signed-off-by:")),
1464 OPT_FILENAME('t', "template", &template_file
, N_("use specified template file")),
1465 OPT_BOOL('e', "edit", &edit_flag
, N_("force edit of commit")),
1466 OPT_STRING(0, "cleanup", &cleanup_arg
, N_("default"), N_("how to strip spaces and #comments from message")),
1467 OPT_BOOL(0, "status", &include_status
, N_("include status in commit message template")),
1468 { OPTION_STRING
, 'S', "gpg-sign", &sign_commit
, N_("key-id"),
1469 N_("GPG sign commit"), PARSE_OPT_OPTARG
, NULL
, (intptr_t) "" },
1470 /* end commit message options */
1472 OPT_GROUP(N_("Commit contents options")),
1473 OPT_BOOL('a', "all", &all
, N_("commit all changed files")),
1474 OPT_BOOL('i', "include", &also
, N_("add specified files to index for commit")),
1475 OPT_BOOL(0, "interactive", &interactive
, N_("interactively add files")),
1476 OPT_BOOL('p', "patch", &patch_interactive
, N_("interactively add changes")),
1477 OPT_BOOL('o', "only", &only
, N_("commit only specified files")),
1478 OPT_BOOL('n', "no-verify", &no_verify
, N_("bypass pre-commit and commit-msg hooks")),
1479 OPT_BOOL(0, "dry-run", &dry_run
, N_("show what would be committed")),
1480 OPT_SET_INT(0, "short", &status_format
, N_("show status concisely"),
1481 STATUS_FORMAT_SHORT
),
1482 OPT_BOOL(0, "branch", &s
.show_branch
, N_("show branch information")),
1483 OPT_BOOL(0, "ahead-behind", &s
.ahead_behind_flags
,
1484 N_("compute full ahead/behind values")),
1485 OPT_SET_INT(0, "porcelain", &status_format
,
1486 N_("machine-readable output"), STATUS_FORMAT_PORCELAIN
),
1487 OPT_SET_INT(0, "long", &status_format
,
1488 N_("show status in long format (default)"),
1489 STATUS_FORMAT_LONG
),
1490 OPT_BOOL('z', "null", &s
.null_termination
,
1491 N_("terminate entries with NUL")),
1492 OPT_BOOL(0, "amend", &amend
, N_("amend previous commit")),
1493 OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite
, N_("bypass post-rewrite hook")),
1494 { 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" },
1495 /* end commit contents options */
1497 OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty
,
1498 N_("ok to record an empty change")),
1499 OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message
,
1500 N_("ok to record a change with an empty message")),
1505 struct strbuf sb
= STRBUF_INIT
;
1506 struct strbuf author_ident
= STRBUF_INIT
;
1507 const char *index_file
, *reflog_msg
;
1508 struct object_id oid
;
1509 struct commit_list
*parents
= NULL
;
1510 struct stat statbuf
;
1511 struct commit
*current_head
= NULL
;
1512 struct commit_extra_header
*extra
= NULL
;
1513 struct strbuf err
= STRBUF_INIT
;
1515 if (argc
== 2 && !strcmp(argv
[1], "-h"))
1516 usage_with_options(builtin_commit_usage
, builtin_commit_options
);
1518 status_init_config(&s
, git_commit_config
);
1519 s
.commit_template
= 1;
1520 status_format
= STATUS_FORMAT_NONE
; /* Ignore status.short */
1523 if (get_oid("HEAD", &oid
))
1524 current_head
= NULL
;
1526 current_head
= lookup_commit_or_die(&oid
, "HEAD");
1527 if (parse_commit(current_head
))
1528 die(_("could not parse HEAD commit"));
1530 verbose
= -1; /* unspecified */
1531 argc
= parse_and_validate_options(argc
, argv
, builtin_commit_options
,
1532 builtin_commit_usage
,
1533 prefix
, current_head
, &s
);
1535 verbose
= (config_commit_verbose
< 0) ? 0 : config_commit_verbose
;
1538 return dry_run_commit(argc
, argv
, prefix
, current_head
, &s
);
1539 index_file
= prepare_index(argc
, argv
, prefix
, current_head
, 0);
1541 /* Set up everything for writing the commit object. This includes
1542 running hooks, writing the trees, and interacting with the user. */
1543 if (!prepare_to_commit(index_file
, prefix
,
1544 current_head
, &s
, &author_ident
)) {
1545 rollback_index_files();
1549 /* Determine parents */
1550 reflog_msg
= getenv("GIT_REFLOG_ACTION");
1551 if (!current_head
) {
1553 reflog_msg
= "commit (initial)";
1556 reflog_msg
= "commit (amend)";
1557 parents
= copy_commit_list(current_head
->parents
);
1558 } else if (whence
== FROM_MERGE
) {
1559 struct strbuf m
= STRBUF_INIT
;
1561 int allow_fast_forward
= 1;
1562 struct commit_list
**pptr
= &parents
;
1565 reflog_msg
= "commit (merge)";
1566 pptr
= commit_list_append(current_head
, pptr
);
1567 fp
= xfopen(git_path_merge_head(), "r");
1568 while (strbuf_getline_lf(&m
, fp
) != EOF
) {
1569 struct commit
*parent
;
1571 parent
= get_merge_parent(m
.buf
);
1573 die(_("Corrupt MERGE_HEAD file (%s)"), m
.buf
);
1574 pptr
= commit_list_append(parent
, pptr
);
1578 if (!stat(git_path_merge_mode(), &statbuf
)) {
1579 if (strbuf_read_file(&sb
, git_path_merge_mode(), 0) < 0)
1580 die_errno(_("could not read MERGE_MODE"));
1581 if (!strcmp(sb
.buf
, "no-ff"))
1582 allow_fast_forward
= 0;
1584 if (allow_fast_forward
)
1585 reduce_heads_replace(&parents
);
1588 reflog_msg
= (whence
== FROM_CHERRY_PICK
)
1589 ? "commit (cherry-pick)"
1591 commit_list_insert(current_head
, &parents
);
1594 /* Finally, get the commit message */
1596 if (strbuf_read_file(&sb
, git_path_commit_editmsg(), 0) < 0) {
1597 int saved_errno
= errno
;
1598 rollback_index_files();
1599 die(_("could not read commit message: %s"), strerror(saved_errno
));
1602 if (verbose
|| /* Truncate the message just before the diff, if any. */
1603 cleanup_mode
== COMMIT_MSG_CLEANUP_SCISSORS
)
1604 strbuf_setlen(&sb
, wt_status_locate_end(sb
.buf
, sb
.len
));
1605 if (cleanup_mode
!= COMMIT_MSG_CLEANUP_NONE
)
1606 strbuf_stripspace(&sb
, cleanup_mode
== COMMIT_MSG_CLEANUP_ALL
);
1608 if (message_is_empty(&sb
, cleanup_mode
) && !allow_empty_message
) {
1609 rollback_index_files();
1610 fprintf(stderr
, _("Aborting commit due to empty commit message.\n"));
1613 if (template_untouched(&sb
, template_file
, cleanup_mode
) && !allow_empty_message
) {
1614 rollback_index_files();
1615 fprintf(stderr
, _("Aborting commit; you did not edit the message.\n"));
1620 const char *exclude_gpgsig
[2] = { "gpgsig", NULL
};
1621 extra
= read_commit_extra_headers(current_head
, exclude_gpgsig
);
1623 struct commit_extra_header
**tail
= &extra
;
1624 append_merge_tag_headers(parents
, &tail
);
1627 if (commit_tree_extended(sb
.buf
, sb
.len
, &active_cache_tree
->oid
,
1628 parents
, &oid
, author_ident
.buf
, sign_commit
,
1630 rollback_index_files();
1631 die(_("failed to write commit object"));
1633 strbuf_release(&author_ident
);
1634 free_commit_extra_headers(extra
);
1636 if (update_head_with_reflog(current_head
, &oid
, reflog_msg
, &sb
,
1638 rollback_index_files();
1642 unlink(git_path_cherry_pick_head());
1643 unlink(git_path_revert_head());
1644 unlink(git_path_merge_head());
1645 unlink(git_path_merge_msg());
1646 unlink(git_path_merge_mode());
1647 unlink(git_path_squash_msg());
1649 if (commit_index_files())
1650 die (_("Repository has been updated, but unable to write\n"
1651 "new_index file. Check that disk is not full and quota is\n"
1652 "not exceeded, and then \"git reset HEAD\" to recover."));
1655 run_command_v_opt(argv_gc_auto
, RUN_GIT_CMD
);
1656 run_commit_hook(use_editor
, get_index_file(), "post-commit", NULL
);
1657 if (amend
&& !no_post_rewrite
) {
1658 commit_post_rewrite(current_head
, &oid
);
1661 unsigned int flags
= 0;
1664 flags
|= SUMMARY_INITIAL_COMMIT
;
1665 if (author_date_is_interesting())
1666 flags
|= SUMMARY_SHOW_AUTHOR_DATE
;
1667 print_commit_summary(prefix
, &oid
, flags
);