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 void determine_whence(struct wt_status
*s
)
148 if (file_exists(git_path_merge_head(the_repository
)))
150 else if (file_exists(git_path_cherry_pick_head(the_repository
))) {
151 whence
= FROM_CHERRY_PICK
;
152 if (file_exists(git_path_seq_dir()))
153 sequencer_in_use
= 1;
156 whence
= FROM_COMMIT
;
161 static void status_init_config(struct wt_status
*s
, config_fn_t fn
)
163 wt_status_prepare(s
);
166 init_diff_ui_defaults();
167 s
->hints
= advice_status_hints
; /* must come after git_config() */
170 static void rollback_index_files(void)
172 switch (commit_style
) {
174 break; /* nothing to do */
176 rollback_lock_file(&index_lock
);
179 rollback_lock_file(&index_lock
);
180 rollback_lock_file(&false_lock
);
185 static int commit_index_files(void)
189 switch (commit_style
) {
191 break; /* nothing to do */
193 err
= commit_lock_file(&index_lock
);
196 err
= commit_lock_file(&index_lock
);
197 rollback_lock_file(&false_lock
);
205 * Take a union of paths in the index and the named tree (typically, "HEAD"),
206 * and return the paths that match the given pattern in list.
208 static int list_paths(struct string_list
*list
, const char *with_tree
,
209 const char *prefix
, const struct pathspec
*pattern
)
217 m
= xcalloc(1, pattern
->nr
);
220 char *max_prefix
= common_prefix(pattern
);
221 overlay_tree_on_index(&the_index
, with_tree
,
222 max_prefix
? max_prefix
: prefix
);
226 for (i
= 0; i
< active_nr
; i
++) {
227 const struct cache_entry
*ce
= active_cache
[i
];
228 struct string_list_item
*item
;
230 if (ce
->ce_flags
& CE_UPDATE
)
232 if (!ce_path_match(ce
, pattern
, m
))
234 item
= string_list_insert(list
, ce
->name
);
235 if (ce_skip_worktree(ce
))
236 item
->util
= item
; /* better a valid pointer than a fake one */
239 ret
= report_path_error(m
, pattern
, prefix
);
244 static void add_remove_files(struct string_list
*list
)
247 for (i
= 0; i
< list
->nr
; i
++) {
249 struct string_list_item
*p
= &(list
->items
[i
]);
251 /* p->util is skip-worktree */
255 if (!lstat(p
->string
, &st
)) {
256 if (add_to_cache(p
->string
, &st
, 0))
257 die(_("updating files failed"));
259 remove_file_from_cache(p
->string
);
263 static void create_base_index(const struct commit
*current_head
)
266 struct unpack_trees_options opts
;
274 memset(&opts
, 0, sizeof(opts
));
278 opts
.src_index
= &the_index
;
279 opts
.dst_index
= &the_index
;
281 opts
.fn
= oneway_merge
;
282 tree
= parse_tree_indirect(¤t_head
->object
.oid
);
284 die(_("failed to unpack HEAD tree object"));
286 init_tree_desc(&t
, tree
->buffer
, tree
->size
);
287 if (unpack_trees(1, &t
, &opts
))
288 exit(128); /* We've already reported the error, finish dying */
291 static void refresh_cache_or_die(int refresh_flags
)
294 * refresh_flags contains REFRESH_QUIET, so the only errors
295 * are for unmerged entries.
297 if (refresh_cache(refresh_flags
| REFRESH_IN_PORCELAIN
))
298 die_resolve_conflict("commit");
301 static const char *prepare_index(int argc
, const char **argv
, const char *prefix
,
302 const struct commit
*current_head
, int is_status
)
304 struct string_list partial
= STRING_LIST_INIT_DUP
;
305 struct pathspec pathspec
;
306 int refresh_flags
= REFRESH_QUIET
;
310 refresh_flags
|= REFRESH_UNMERGED
;
311 parse_pathspec(&pathspec
, 0,
312 PATHSPEC_PREFER_FULL
,
315 if (read_cache_preload(&pathspec
) < 0)
316 die(_("index file corrupt"));
319 char *old_index_env
= NULL
;
320 hold_locked_index(&index_lock
, LOCK_DIE_ON_ERROR
);
322 refresh_cache_or_die(refresh_flags
);
324 if (write_locked_index(&the_index
, &index_lock
, 0))
325 die(_("unable to create temporary index"));
327 old_index_env
= getenv(INDEX_ENVIRONMENT
);
328 setenv(INDEX_ENVIRONMENT
, get_lock_file_path(&index_lock
), 1);
330 if (interactive_add(argc
, argv
, prefix
, patch_interactive
) != 0)
331 die(_("interactive add failed"));
333 if (old_index_env
&& *old_index_env
)
334 setenv(INDEX_ENVIRONMENT
, old_index_env
, 1);
336 unsetenv(INDEX_ENVIRONMENT
);
339 read_cache_from(get_lock_file_path(&index_lock
));
340 if (update_main_cache_tree(WRITE_TREE_SILENT
) == 0) {
341 if (reopen_lock_file(&index_lock
) < 0)
342 die(_("unable to write index file"));
343 if (write_locked_index(&the_index
, &index_lock
, 0))
344 die(_("unable to update temporary index"));
346 warning(_("Failed to update main cache tree"));
348 commit_style
= COMMIT_NORMAL
;
349 ret
= get_lock_file_path(&index_lock
);
354 * Non partial, non as-is commit.
356 * (1) get the real index;
357 * (2) update the_index as necessary;
358 * (3) write the_index out to the real index (still locked);
359 * (4) return the name of the locked index file.
361 * The caller should run hooks on the locked real index, and
362 * (A) if all goes well, commit the real index;
363 * (B) on failure, rollback the real index.
365 if (all
|| (also
&& pathspec
.nr
)) {
366 hold_locked_index(&index_lock
, LOCK_DIE_ON_ERROR
);
367 add_files_to_cache(also
? prefix
: NULL
, &pathspec
, 0);
368 refresh_cache_or_die(refresh_flags
);
369 update_main_cache_tree(WRITE_TREE_SILENT
);
370 if (write_locked_index(&the_index
, &index_lock
, 0))
371 die(_("unable to write new_index file"));
372 commit_style
= COMMIT_NORMAL
;
373 ret
= get_lock_file_path(&index_lock
);
380 * (1) return the name of the real index file.
382 * The caller should run hooks on the real index,
383 * and create commit from the_index.
384 * We still need to refresh the index here.
386 if (!only
&& !pathspec
.nr
) {
387 hold_locked_index(&index_lock
, LOCK_DIE_ON_ERROR
);
388 refresh_cache_or_die(refresh_flags
);
389 if (active_cache_changed
390 || !cache_tree_fully_valid(active_cache_tree
))
391 update_main_cache_tree(WRITE_TREE_SILENT
);
392 if (write_locked_index(&the_index
, &index_lock
,
393 COMMIT_LOCK
| SKIP_IF_UNCHANGED
))
394 die(_("unable to write new_index file"));
395 commit_style
= COMMIT_AS_IS
;
396 ret
= get_index_file();
403 * (0) find the set of affected paths;
404 * (1) get lock on the real index file;
405 * (2) update the_index with the given paths;
406 * (3) write the_index out to the real index (still locked);
407 * (4) get lock on the false index file;
408 * (5) reset the_index from HEAD;
409 * (6) update the_index the same way as (2);
410 * (7) write the_index out to the false index file;
411 * (8) return the name of the false index file (still locked);
413 * The caller should run hooks on the locked false index, and
414 * create commit from it. Then
415 * (A) if all goes well, commit the real index;
416 * (B) on failure, rollback the real index;
417 * In either case, rollback the false index.
419 commit_style
= COMMIT_PARTIAL
;
421 if (whence
!= FROM_COMMIT
) {
422 if (whence
== FROM_MERGE
)
423 die(_("cannot do a partial commit during a merge."));
424 else if (whence
== FROM_CHERRY_PICK
)
425 die(_("cannot do a partial commit during a cherry-pick."));
428 if (list_paths(&partial
, !current_head
? NULL
: "HEAD", prefix
, &pathspec
))
432 if (read_cache() < 0)
433 die(_("cannot read the index"));
435 hold_locked_index(&index_lock
, LOCK_DIE_ON_ERROR
);
436 add_remove_files(&partial
);
437 refresh_cache(REFRESH_QUIET
);
438 update_main_cache_tree(WRITE_TREE_SILENT
);
439 if (write_locked_index(&the_index
, &index_lock
, 0))
440 die(_("unable to write new_index file"));
442 hold_lock_file_for_update(&false_lock
,
443 git_path("next-index-%"PRIuMAX
,
444 (uintmax_t) getpid()),
447 create_base_index(current_head
);
448 add_remove_files(&partial
);
449 refresh_cache(REFRESH_QUIET
);
451 if (write_locked_index(&the_index
, &false_lock
, 0))
452 die(_("unable to write temporary index file"));
455 ret
= get_lock_file_path(&false_lock
);
456 read_cache_from(ret
);
458 string_list_clear(&partial
, 0);
459 clear_pathspec(&pathspec
);
463 static int run_status(FILE *fp
, const char *index_file
, const char *prefix
, int nowarn
,
466 struct object_id oid
;
468 if (s
->relative_paths
)
473 s
->reference
= "HEAD^1";
475 s
->verbose
= verbose
;
476 s
->index_file
= index_file
;
479 s
->is_initial
= get_oid(s
->reference
, &oid
) ? 1 : 0;
481 hashcpy(s
->sha1_commit
, oid
.hash
);
482 s
->status_format
= status_format
;
483 s
->ignore_submodule_arg
= ignore_submodule_arg
;
485 wt_status_collect(s
);
488 return s
->commitable
;
491 static int is_a_merge(const struct commit
*current_head
)
493 return !!(current_head
->parents
&& current_head
->parents
->next
);
496 static void assert_split_ident(struct ident_split
*id
, const struct strbuf
*buf
)
498 if (split_ident_line(id
, buf
->buf
, buf
->len
) || !id
->date_begin
)
499 die("BUG: unable to parse our own ident: %s", buf
->buf
);
502 static void export_one(const char *var
, const char *s
, const char *e
, int hack
)
504 struct strbuf buf
= STRBUF_INIT
;
506 strbuf_addch(&buf
, hack
);
507 strbuf_addf(&buf
, "%.*s", (int)(e
- s
), s
);
508 setenv(var
, buf
.buf
, 1);
509 strbuf_release(&buf
);
512 static int parse_force_date(const char *in
, struct strbuf
*out
)
514 strbuf_addch(out
, '@');
516 if (parse_date(in
, out
) < 0) {
518 unsigned long t
= approxidate_careful(in
, &errors
);
521 strbuf_addf(out
, "%lu", t
);
527 static void set_ident_var(char **buf
, char *val
)
533 static void determine_author_info(struct strbuf
*author_ident
)
535 char *name
, *email
, *date
;
536 struct ident_split author
;
538 name
= xstrdup_or_null(getenv("GIT_AUTHOR_NAME"));
539 email
= xstrdup_or_null(getenv("GIT_AUTHOR_EMAIL"));
540 date
= xstrdup_or_null(getenv("GIT_AUTHOR_DATE"));
542 if (author_message
) {
543 struct ident_split ident
;
547 a
= find_commit_header(author_message_buffer
, "author", &len
);
549 die(_("commit '%s' lacks author header"), author_message
);
550 if (split_ident_line(&ident
, a
, len
) < 0)
551 die(_("commit '%s' has malformed author line"), author_message
);
553 set_ident_var(&name
, xmemdupz(ident
.name_begin
, ident
.name_end
- ident
.name_begin
));
554 set_ident_var(&email
, xmemdupz(ident
.mail_begin
, ident
.mail_end
- ident
.mail_begin
));
556 if (ident
.date_begin
) {
557 struct strbuf date_buf
= STRBUF_INIT
;
558 strbuf_addch(&date_buf
, '@');
559 strbuf_add(&date_buf
, ident
.date_begin
, ident
.date_end
- ident
.date_begin
);
560 strbuf_addch(&date_buf
, ' ');
561 strbuf_add(&date_buf
, ident
.tz_begin
, ident
.tz_end
- ident
.tz_begin
);
562 set_ident_var(&date
, strbuf_detach(&date_buf
, NULL
));
567 struct ident_split ident
;
569 if (split_ident_line(&ident
, force_author
, strlen(force_author
)) < 0)
570 die(_("malformed --author parameter"));
571 set_ident_var(&name
, xmemdupz(ident
.name_begin
, ident
.name_end
- ident
.name_begin
));
572 set_ident_var(&email
, xmemdupz(ident
.mail_begin
, ident
.mail_end
- ident
.mail_begin
));
576 struct strbuf date_buf
= STRBUF_INIT
;
577 if (parse_force_date(force_date
, &date_buf
))
578 die(_("invalid date format: %s"), force_date
);
579 set_ident_var(&date
, strbuf_detach(&date_buf
, NULL
));
582 strbuf_addstr(author_ident
, fmt_ident(name
, email
, date
, IDENT_STRICT
));
583 assert_split_ident(&author
, author_ident
);
584 export_one("GIT_AUTHOR_NAME", author
.name_begin
, author
.name_end
, 0);
585 export_one("GIT_AUTHOR_EMAIL", author
.mail_begin
, author
.mail_end
, 0);
586 export_one("GIT_AUTHOR_DATE", author
.date_begin
, author
.tz_end
, '@');
592 static int author_date_is_interesting(void)
594 return author_message
|| force_date
;
597 static void adjust_comment_line_char(const struct strbuf
*sb
)
599 char candidates
[] = "#;@!$%^&|:";
603 comment_line_char
= candidates
[0];
604 if (!memchr(sb
->buf
, comment_line_char
, sb
->len
))
608 candidate
= strchr(candidates
, *p
);
611 for (p
= sb
->buf
; *p
; p
++) {
612 if ((p
[0] == '\n' || p
[0] == '\r') && p
[1]) {
613 candidate
= strchr(candidates
, p
[1]);
619 for (p
= candidates
; *p
== ' '; p
++)
622 die(_("unable to select a comment character that is not used\n"
623 "in the current commit message"));
624 comment_line_char
= *p
;
627 static int prepare_to_commit(const char *index_file
, const char *prefix
,
628 struct commit
*current_head
,
630 struct strbuf
*author_ident
)
633 struct strbuf committer_ident
= STRBUF_INIT
;
635 struct strbuf sb
= STRBUF_INIT
;
636 const char *hook_arg1
= NULL
;
637 const char *hook_arg2
= NULL
;
638 int clean_message_contents
= (cleanup_mode
!= COMMIT_MSG_CLEANUP_NONE
);
639 int old_display_comment_prefix
;
641 /* This checks and barfs if author is badly specified */
642 determine_author_info(author_ident
);
644 if (!no_verify
&& run_commit_hook(use_editor
, index_file
, "pre-commit", NULL
))
647 if (squash_message
) {
649 * Insert the proper subject line before other commit
650 * message options add their content.
652 if (use_message
&& !strcmp(use_message
, squash_message
))
653 strbuf_addstr(&sb
, "squash! ");
655 struct pretty_print_context ctx
= {0};
657 c
= lookup_commit_reference_by_name(squash_message
);
659 die(_("could not lookup commit %s"), squash_message
);
660 ctx
.output_encoding
= get_commit_output_encoding();
661 format_commit_message(c
, "squash! %s\n\n", &sb
,
666 if (have_option_m
&& !fixup_message
) {
667 strbuf_addbuf(&sb
, &message
);
668 hook_arg1
= "message";
669 } else if (logfile
&& !strcmp(logfile
, "-")) {
671 fprintf(stderr
, _("(reading log message from standard input)\n"));
672 if (strbuf_read(&sb
, 0, 0) < 0)
673 die_errno(_("could not read log from standard input"));
674 hook_arg1
= "message";
675 } else if (logfile
) {
676 if (strbuf_read_file(&sb
, logfile
, 0) < 0)
677 die_errno(_("could not read log file '%s'"),
679 hook_arg1
= "message";
680 } else if (use_message
) {
682 buffer
= strstr(use_message_buffer
, "\n\n");
684 strbuf_addstr(&sb
, skip_blank_lines(buffer
+ 2));
685 hook_arg1
= "commit";
686 hook_arg2
= use_message
;
687 } else if (fixup_message
) {
688 struct pretty_print_context ctx
= {0};
689 struct commit
*commit
;
690 commit
= lookup_commit_reference_by_name(fixup_message
);
692 die(_("could not lookup commit %s"), fixup_message
);
693 ctx
.output_encoding
= get_commit_output_encoding();
694 format_commit_message(commit
, "fixup! %s\n\n",
697 strbuf_addbuf(&sb
, &message
);
698 hook_arg1
= "message";
699 } else if (!stat(git_path_merge_msg(the_repository
), &statbuf
)) {
701 * prepend SQUASH_MSG here if it exists and a
702 * "merge --squash" was originally performed
704 if (!stat(git_path_squash_msg(the_repository
), &statbuf
)) {
705 if (strbuf_read_file(&sb
, git_path_squash_msg(the_repository
), 0) < 0)
706 die_errno(_("could not read SQUASH_MSG"));
707 hook_arg1
= "squash";
710 if (strbuf_read_file(&sb
, git_path_merge_msg(the_repository
), 0) < 0)
711 die_errno(_("could not read MERGE_MSG"));
712 } else if (!stat(git_path_squash_msg(the_repository
), &statbuf
)) {
713 if (strbuf_read_file(&sb
, git_path_squash_msg(the_repository
), 0) < 0)
714 die_errno(_("could not read SQUASH_MSG"));
715 hook_arg1
= "squash";
716 } else if (template_file
) {
717 if (strbuf_read_file(&sb
, template_file
, 0) < 0)
718 die_errno(_("could not read '%s'"), template_file
);
719 hook_arg1
= "template";
720 clean_message_contents
= 0;
724 * The remaining cases don't modify the template message, but
725 * just set the argument(s) to the prepare-commit-msg hook.
727 else if (whence
== FROM_MERGE
)
729 else if (whence
== FROM_CHERRY_PICK
) {
730 hook_arg1
= "commit";
731 hook_arg2
= "CHERRY_PICK_HEAD";
734 if (squash_message
) {
736 * If squash_commit was used for the commit subject,
737 * then we're possibly hijacking other commit log options.
738 * Reset the hook args to tell the real story.
740 hook_arg1
= "message";
744 s
->fp
= fopen_for_writing(git_path_commit_editmsg());
746 die_errno(_("could not open '%s'"), git_path_commit_editmsg());
748 /* Ignore status.displayCommentPrefix: we do need comments in COMMIT_EDITMSG. */
749 old_display_comment_prefix
= s
->display_comment_prefix
;
750 s
->display_comment_prefix
= 1;
753 * Most hints are counter-productive when the commit has
758 if (clean_message_contents
)
759 strbuf_stripspace(&sb
, 0);
762 append_signoff(&sb
, ignore_non_trailer(sb
.buf
, sb
.len
), 0);
764 if (fwrite(sb
.buf
, 1, sb
.len
, s
->fp
) < sb
.len
)
765 die_errno(_("could not write commit template"));
767 if (auto_comment_line_char
)
768 adjust_comment_line_char(&sb
);
771 /* This checks if committer ident is explicitly given */
772 strbuf_addstr(&committer_ident
, git_committer_info(IDENT_STRICT
));
773 if (use_editor
&& include_status
) {
775 int saved_color_setting
;
776 struct ident_split ci
, ai
;
778 if (whence
!= FROM_COMMIT
) {
779 if (cleanup_mode
== COMMIT_MSG_CLEANUP_SCISSORS
)
780 wt_status_add_cut_line(s
->fp
);
781 status_printf_ln(s
, GIT_COLOR_NORMAL
,
784 "It looks like you may be committing a merge.\n"
785 "If this is not correct, please remove the file\n"
789 "It looks like you may be committing a cherry-pick.\n"
790 "If this is not correct, please remove the file\n"
793 whence
== FROM_MERGE
?
794 git_path_merge_head(the_repository
) :
795 git_path_cherry_pick_head(the_repository
));
798 fprintf(s
->fp
, "\n");
799 if (cleanup_mode
== COMMIT_MSG_CLEANUP_ALL
)
800 status_printf(s
, GIT_COLOR_NORMAL
,
801 _("Please enter the commit message for your changes."
802 " Lines starting\nwith '%c' will be ignored, and an empty"
803 " message aborts the commit.\n"), comment_line_char
);
804 else if (cleanup_mode
== COMMIT_MSG_CLEANUP_SCISSORS
&&
805 whence
== FROM_COMMIT
)
806 wt_status_add_cut_line(s
->fp
);
807 else /* COMMIT_MSG_CLEANUP_SPACE, that is. */
808 status_printf(s
, GIT_COLOR_NORMAL
,
809 _("Please enter the commit message for your changes."
811 "with '%c' will be kept; you may remove them"
812 " yourself if you want to.\n"
813 "An empty message aborts the commit.\n"), comment_line_char
);
816 * These should never fail because they come from our own
817 * fmt_ident. They may fail the sane_ident test, but we know
818 * that the name and mail pointers will at least be valid,
819 * which is enough for our tests and printing here.
821 assert_split_ident(&ai
, author_ident
);
822 assert_split_ident(&ci
, &committer_ident
);
824 if (ident_cmp(&ai
, &ci
))
825 status_printf_ln(s
, GIT_COLOR_NORMAL
,
827 "Author: %.*s <%.*s>"),
828 ident_shown
++ ? "" : "\n",
829 (int)(ai
.name_end
- ai
.name_begin
), ai
.name_begin
,
830 (int)(ai
.mail_end
- ai
.mail_begin
), ai
.mail_begin
);
832 if (author_date_is_interesting())
833 status_printf_ln(s
, GIT_COLOR_NORMAL
,
836 ident_shown
++ ? "" : "\n",
837 show_ident_date(&ai
, DATE_MODE(NORMAL
)));
839 if (!committer_ident_sufficiently_given())
840 status_printf_ln(s
, GIT_COLOR_NORMAL
,
842 "Committer: %.*s <%.*s>"),
843 ident_shown
++ ? "" : "\n",
844 (int)(ci
.name_end
- ci
.name_begin
), ci
.name_begin
,
845 (int)(ci
.mail_end
- ci
.mail_begin
), ci
.mail_begin
);
847 status_printf_ln(s
, GIT_COLOR_NORMAL
, "%s", ""); /* Add new line for clarity */
849 saved_color_setting
= s
->use_color
;
851 commitable
= run_status(s
->fp
, index_file
, prefix
, 1, s
);
852 s
->use_color
= saved_color_setting
;
854 struct object_id oid
;
855 const char *parent
= "HEAD";
857 if (!active_nr
&& read_cache() < 0)
858 die(_("Cannot read index"));
863 if (get_oid(parent
, &oid
)) {
866 for (i
= 0; i
< active_nr
; i
++)
867 if (ce_intent_to_add(active_cache
[i
]))
869 commitable
= active_nr
- ita_nr
> 0;
872 * Unless the user did explicitly request a submodule
873 * ignore mode by passing a command line option we do
874 * not ignore any changed submodule SHA-1s when
875 * comparing index and parent, no matter what is
876 * configured. Otherwise we won't commit any
877 * submodules which were manually staged, which would
878 * be really confusing.
880 struct diff_flags flags
= DIFF_FLAGS_INIT
;
881 flags
.override_submodule_config
= 1;
882 if (ignore_submodule_arg
&&
883 !strcmp(ignore_submodule_arg
, "all"))
884 flags
.ignore_submodules
= 1;
885 commitable
= index_differs_from(parent
, &flags
, 1);
888 strbuf_release(&committer_ident
);
893 * Reject an attempt to record a non-merge empty commit without
894 * explicit --allow-empty. In the cherry-pick case, it may be
895 * empty due to conflict resolution, which the user should okay.
897 if (!commitable
&& whence
!= FROM_MERGE
&& !allow_empty
&&
898 !(amend
&& is_a_merge(current_head
))) {
899 s
->display_comment_prefix
= old_display_comment_prefix
;
900 run_status(stdout
, index_file
, prefix
, 0, s
);
902 fputs(_(empty_amend_advice
), stderr
);
903 else if (whence
== FROM_CHERRY_PICK
) {
904 fputs(_(empty_cherry_pick_advice
), stderr
);
905 if (!sequencer_in_use
)
906 fputs(_(empty_cherry_pick_advice_single
), stderr
);
908 fputs(_(empty_cherry_pick_advice_multi
), stderr
);
913 if (!no_verify
&& find_hook("pre-commit")) {
915 * Re-read the index as pre-commit hook could have updated it,
916 * and write it out as a tree. We must do this before we invoke
917 * the editor and after we invoke run_status above.
921 read_cache_from(index_file
);
923 if (update_main_cache_tree(0)) {
924 error(_("Error building trees"));
928 if (run_commit_hook(use_editor
, index_file
, "prepare-commit-msg",
929 git_path_commit_editmsg(), hook_arg1
, hook_arg2
, NULL
))
933 struct argv_array env
= ARGV_ARRAY_INIT
;
935 argv_array_pushf(&env
, "GIT_INDEX_FILE=%s", index_file
);
936 if (launch_editor(git_path_commit_editmsg(), NULL
, env
.argv
)) {
938 _("Please supply the message using either -m or -F option.\n"));
941 argv_array_clear(&env
);
945 run_commit_hook(use_editor
, index_file
, "commit-msg", git_path_commit_editmsg(), NULL
)) {
952 static const char *find_author_by_nickname(const char *name
)
954 struct rev_info revs
;
955 struct commit
*commit
;
956 struct strbuf buf
= STRBUF_INIT
;
957 struct string_list mailmap
= STRING_LIST_INIT_NODUP
;
961 init_revisions(&revs
, NULL
);
962 strbuf_addf(&buf
, "--author=%s", name
);
967 setup_revisions(ac
, av
, &revs
, NULL
);
968 revs
.mailmap
= &mailmap
;
969 read_mailmap(revs
.mailmap
, NULL
);
971 if (prepare_revision_walk(&revs
))
972 die(_("revision walk setup failed"));
973 commit
= get_revision(&revs
);
975 struct pretty_print_context ctx
= {0};
976 ctx
.date_mode
.type
= DATE_NORMAL
;
977 strbuf_release(&buf
);
978 format_commit_message(commit
, "%aN <%aE>", &buf
, &ctx
);
979 clear_mailmap(&mailmap
);
980 return strbuf_detach(&buf
, NULL
);
982 die(_("--author '%s' is not 'Name <email>' and matches no existing author"), name
);
985 static void handle_ignored_arg(struct wt_status
*s
)
988 ; /* default already initialized */
989 else if (!strcmp(ignored_arg
, "traditional"))
990 s
->show_ignored_mode
= SHOW_TRADITIONAL_IGNORED
;
991 else if (!strcmp(ignored_arg
, "no"))
992 s
->show_ignored_mode
= SHOW_NO_IGNORED
;
993 else if (!strcmp(ignored_arg
, "matching"))
994 s
->show_ignored_mode
= SHOW_MATCHING_IGNORED
;
996 die(_("Invalid ignored mode '%s'"), ignored_arg
);
999 static void handle_untracked_files_arg(struct wt_status
*s
)
1001 if (!untracked_files_arg
)
1002 ; /* default already initialized */
1003 else if (!strcmp(untracked_files_arg
, "no"))
1004 s
->show_untracked_files
= SHOW_NO_UNTRACKED_FILES
;
1005 else if (!strcmp(untracked_files_arg
, "normal"))
1006 s
->show_untracked_files
= SHOW_NORMAL_UNTRACKED_FILES
;
1007 else if (!strcmp(untracked_files_arg
, "all"))
1008 s
->show_untracked_files
= SHOW_ALL_UNTRACKED_FILES
;
1010 die(_("Invalid untracked files mode '%s'"), untracked_files_arg
);
1013 static const char *read_commit_message(const char *name
)
1015 const char *out_enc
;
1016 struct commit
*commit
;
1018 commit
= lookup_commit_reference_by_name(name
);
1020 die(_("could not lookup commit %s"), name
);
1021 out_enc
= get_commit_output_encoding();
1022 return logmsg_reencode(commit
, NULL
, out_enc
);
1026 * Enumerate what needs to be propagated when --porcelain
1027 * is not in effect here.
1029 static struct status_deferred_config
{
1030 enum wt_status_format status_format
;
1032 } status_deferred_config
= {
1033 STATUS_FORMAT_UNSPECIFIED
,
1034 -1 /* unspecified */
1037 static void finalize_deferred_config(struct wt_status
*s
)
1039 int use_deferred_config
= (status_format
!= STATUS_FORMAT_PORCELAIN
&&
1040 status_format
!= STATUS_FORMAT_PORCELAIN_V2
&&
1041 !s
->null_termination
);
1043 if (s
->null_termination
) {
1044 if (status_format
== STATUS_FORMAT_NONE
||
1045 status_format
== STATUS_FORMAT_UNSPECIFIED
)
1046 status_format
= STATUS_FORMAT_PORCELAIN
;
1047 else if (status_format
== STATUS_FORMAT_LONG
)
1048 die(_("--long and -z are incompatible"));
1051 if (use_deferred_config
&& status_format
== STATUS_FORMAT_UNSPECIFIED
)
1052 status_format
= status_deferred_config
.status_format
;
1053 if (status_format
== STATUS_FORMAT_UNSPECIFIED
)
1054 status_format
= STATUS_FORMAT_NONE
;
1056 if (use_deferred_config
&& s
->show_branch
< 0)
1057 s
->show_branch
= status_deferred_config
.show_branch
;
1058 if (s
->show_branch
< 0)
1061 if (s
->ahead_behind_flags
== AHEAD_BEHIND_UNSPECIFIED
)
1062 s
->ahead_behind_flags
= AHEAD_BEHIND_FULL
;
1065 static int parse_and_validate_options(int argc
, const char *argv
[],
1066 const struct option
*options
,
1067 const char * const usage
[],
1069 struct commit
*current_head
,
1070 struct wt_status
*s
)
1074 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
1075 finalize_deferred_config(s
);
1077 if (force_author
&& !strchr(force_author
, '>'))
1078 force_author
= find_author_by_nickname(force_author
);
1080 if (force_author
&& renew_authorship
)
1081 die(_("Using both --reset-author and --author does not make sense"));
1083 if (logfile
|| have_option_m
|| use_message
|| fixup_message
)
1086 use_editor
= edit_flag
;
1088 /* Sanity check options */
1089 if (amend
&& !current_head
)
1090 die(_("You have nothing to amend."));
1091 if (amend
&& whence
!= FROM_COMMIT
) {
1092 if (whence
== FROM_MERGE
)
1093 die(_("You are in the middle of a merge -- cannot amend."));
1094 else if (whence
== FROM_CHERRY_PICK
)
1095 die(_("You are in the middle of a cherry-pick -- cannot amend."));
1097 if (fixup_message
&& squash_message
)
1098 die(_("Options --squash and --fixup cannot be used together"));
1108 die(_("Only one of -c/-C/-F/--fixup can be used."));
1109 if (have_option_m
&& (edit_message
|| use_message
|| logfile
))
1110 die((_("Option -m cannot be combined with -c/-C/-F.")));
1111 if (f
|| have_option_m
)
1112 template_file
= NULL
;
1114 use_message
= edit_message
;
1115 if (amend
&& !use_message
&& !fixup_message
)
1116 use_message
= "HEAD";
1117 if (!use_message
&& whence
!= FROM_CHERRY_PICK
&& renew_authorship
)
1118 die(_("--reset-author can be used only with -C, -c or --amend."));
1120 use_message_buffer
= read_commit_message(use_message
);
1121 if (!renew_authorship
) {
1122 author_message
= use_message
;
1123 author_message_buffer
= use_message_buffer
;
1126 if (whence
== FROM_CHERRY_PICK
&& !renew_authorship
) {
1127 author_message
= "CHERRY_PICK_HEAD";
1128 author_message_buffer
= read_commit_message(author_message
);
1131 if (patch_interactive
)
1134 if (also
+ only
+ all
+ interactive
> 1)
1135 die(_("Only one of --include/--only/--all/--interactive/--patch can be used."));
1136 if (argc
== 0 && (also
|| (only
&& !amend
&& !allow_empty
)))
1137 die(_("No paths with --include/--only does not make sense."));
1138 if (!cleanup_arg
|| !strcmp(cleanup_arg
, "default"))
1139 cleanup_mode
= use_editor
? COMMIT_MSG_CLEANUP_ALL
:
1140 COMMIT_MSG_CLEANUP_SPACE
;
1141 else if (!strcmp(cleanup_arg
, "verbatim"))
1142 cleanup_mode
= COMMIT_MSG_CLEANUP_NONE
;
1143 else if (!strcmp(cleanup_arg
, "whitespace"))
1144 cleanup_mode
= COMMIT_MSG_CLEANUP_SPACE
;
1145 else if (!strcmp(cleanup_arg
, "strip"))
1146 cleanup_mode
= COMMIT_MSG_CLEANUP_ALL
;
1147 else if (!strcmp(cleanup_arg
, "scissors"))
1148 cleanup_mode
= use_editor
? COMMIT_MSG_CLEANUP_SCISSORS
:
1149 COMMIT_MSG_CLEANUP_SPACE
;
1151 die(_("Invalid cleanup mode %s"), cleanup_arg
);
1153 handle_untracked_files_arg(s
);
1155 if (all
&& argc
> 0)
1156 die(_("Paths with -a does not make sense."));
1158 if (status_format
!= STATUS_FORMAT_NONE
)
1164 static int dry_run_commit(int argc
, const char **argv
, const char *prefix
,
1165 const struct commit
*current_head
, struct wt_status
*s
)
1168 const char *index_file
;
1170 index_file
= prepare_index(argc
, argv
, prefix
, current_head
, 1);
1171 commitable
= run_status(stdout
, index_file
, prefix
, 0, s
);
1172 rollback_index_files();
1174 return commitable
? 0 : 1;
1177 static int parse_status_slot(const char *slot
)
1179 if (!strcasecmp(slot
, "header"))
1180 return WT_STATUS_HEADER
;
1181 if (!strcasecmp(slot
, "branch"))
1182 return WT_STATUS_ONBRANCH
;
1183 if (!strcasecmp(slot
, "updated") || !strcasecmp(slot
, "added"))
1184 return WT_STATUS_UPDATED
;
1185 if (!strcasecmp(slot
, "changed"))
1186 return WT_STATUS_CHANGED
;
1187 if (!strcasecmp(slot
, "untracked"))
1188 return WT_STATUS_UNTRACKED
;
1189 if (!strcasecmp(slot
, "nobranch"))
1190 return WT_STATUS_NOBRANCH
;
1191 if (!strcasecmp(slot
, "unmerged"))
1192 return WT_STATUS_UNMERGED
;
1193 if (!strcasecmp(slot
, "localBranch"))
1194 return WT_STATUS_LOCAL_BRANCH
;
1195 if (!strcasecmp(slot
, "remoteBranch"))
1196 return WT_STATUS_REMOTE_BRANCH
;
1200 static int git_status_config(const char *k
, const char *v
, void *cb
)
1202 struct wt_status
*s
= cb
;
1203 const char *slot_name
;
1205 if (starts_with(k
, "column."))
1206 return git_column_config(k
, v
, "status", &s
->colopts
);
1207 if (!strcmp(k
, "status.submodulesummary")) {
1209 s
->submodule_summary
= git_config_bool_or_int(k
, v
, &is_bool
);
1210 if (is_bool
&& s
->submodule_summary
)
1211 s
->submodule_summary
= -1;
1214 if (!strcmp(k
, "status.short")) {
1215 if (git_config_bool(k
, v
))
1216 status_deferred_config
.status_format
= STATUS_FORMAT_SHORT
;
1218 status_deferred_config
.status_format
= STATUS_FORMAT_NONE
;
1221 if (!strcmp(k
, "status.branch")) {
1222 status_deferred_config
.show_branch
= git_config_bool(k
, v
);
1225 if (!strcmp(k
, "status.showstash")) {
1226 s
->show_stash
= git_config_bool(k
, v
);
1229 if (!strcmp(k
, "status.color") || !strcmp(k
, "color.status")) {
1230 s
->use_color
= git_config_colorbool(k
, v
);
1233 if (!strcmp(k
, "status.displaycommentprefix")) {
1234 s
->display_comment_prefix
= git_config_bool(k
, v
);
1237 if (skip_prefix(k
, "status.color.", &slot_name
) ||
1238 skip_prefix(k
, "color.status.", &slot_name
)) {
1239 int slot
= parse_status_slot(slot_name
);
1243 return config_error_nonbool(k
);
1244 return color_parse(v
, s
->color_palette
[slot
]);
1246 if (!strcmp(k
, "status.relativepaths")) {
1247 s
->relative_paths
= git_config_bool(k
, v
);
1250 if (!strcmp(k
, "status.showuntrackedfiles")) {
1252 return config_error_nonbool(k
);
1253 else if (!strcmp(v
, "no"))
1254 s
->show_untracked_files
= SHOW_NO_UNTRACKED_FILES
;
1255 else if (!strcmp(v
, "normal"))
1256 s
->show_untracked_files
= SHOW_NORMAL_UNTRACKED_FILES
;
1257 else if (!strcmp(v
, "all"))
1258 s
->show_untracked_files
= SHOW_ALL_UNTRACKED_FILES
;
1260 return error(_("Invalid untracked files mode '%s'"), v
);
1263 return git_diff_ui_config(k
, v
, NULL
);
1266 int cmd_status(int argc
, const char **argv
, const char *prefix
)
1268 static struct wt_status s
;
1270 struct object_id oid
;
1271 static struct option builtin_status_options
[] = {
1272 OPT__VERBOSE(&verbose
, N_("be verbose")),
1273 OPT_SET_INT('s', "short", &status_format
,
1274 N_("show status concisely"), STATUS_FORMAT_SHORT
),
1275 OPT_BOOL('b', "branch", &s
.show_branch
,
1276 N_("show branch information")),
1277 OPT_BOOL(0, "show-stash", &s
.show_stash
,
1278 N_("show stash information")),
1279 OPT_BOOL(0, "ahead-behind", &s
.ahead_behind_flags
,
1280 N_("compute full ahead/behind values")),
1281 { OPTION_CALLBACK
, 0, "porcelain", &status_format
,
1282 N_("version"), N_("machine-readable output"),
1283 PARSE_OPT_OPTARG
, opt_parse_porcelain
},
1284 OPT_SET_INT(0, "long", &status_format
,
1285 N_("show status in long format (default)"),
1286 STATUS_FORMAT_LONG
),
1287 OPT_BOOL('z', "null", &s
.null_termination
,
1288 N_("terminate entries with NUL")),
1289 { OPTION_STRING
, 'u', "untracked-files", &untracked_files_arg
,
1291 N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1292 PARSE_OPT_OPTARG
, NULL
, (intptr_t)"all" },
1293 { OPTION_STRING
, 0, "ignored", &ignored_arg
,
1295 N_("show ignored files, optional modes: traditional, matching, no. (Default: traditional)"),
1296 PARSE_OPT_OPTARG
, NULL
, (intptr_t)"traditional" },
1297 { OPTION_STRING
, 0, "ignore-submodules", &ignore_submodule_arg
, N_("when"),
1298 N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
1299 PARSE_OPT_OPTARG
, NULL
, (intptr_t)"all" },
1300 OPT_COLUMN(0, "column", &s
.colopts
, N_("list untracked files in columns")),
1304 if (argc
== 2 && !strcmp(argv
[1], "-h"))
1305 usage_with_options(builtin_status_usage
, builtin_status_options
);
1307 status_init_config(&s
, git_status_config
);
1308 argc
= parse_options(argc
, argv
, prefix
,
1309 builtin_status_options
,
1310 builtin_status_usage
, 0);
1311 finalize_colopts(&s
.colopts
, -1);
1312 finalize_deferred_config(&s
);
1314 handle_untracked_files_arg(&s
);
1315 handle_ignored_arg(&s
);
1317 if (s
.show_ignored_mode
== SHOW_MATCHING_IGNORED
&&
1318 s
.show_untracked_files
== SHOW_NO_UNTRACKED_FILES
)
1319 die(_("Unsupported combination of ignored and untracked-files arguments"));
1321 parse_pathspec(&s
.pathspec
, 0,
1322 PATHSPEC_PREFER_FULL
,
1325 read_cache_preload(&s
.pathspec
);
1326 refresh_index(&the_index
, REFRESH_QUIET
|REFRESH_UNMERGED
, &s
.pathspec
, NULL
, NULL
);
1328 if (use_optional_locks())
1329 fd
= hold_locked_index(&index_lock
, 0);
1333 s
.is_initial
= get_oid(s
.reference
, &oid
) ? 1 : 0;
1335 hashcpy(s
.sha1_commit
, oid
.hash
);
1337 s
.ignore_submodule_arg
= ignore_submodule_arg
;
1338 s
.status_format
= status_format
;
1339 s
.verbose
= verbose
;
1341 wt_status_collect(&s
);
1344 update_index_if_able(&the_index
, &index_lock
);
1346 if (s
.relative_paths
)
1349 wt_status_print(&s
);
1353 static int git_commit_config(const char *k
, const char *v
, void *cb
)
1355 struct wt_status
*s
= cb
;
1358 if (!strcmp(k
, "commit.template"))
1359 return git_config_pathname(&template_file
, k
, v
);
1360 if (!strcmp(k
, "commit.status")) {
1361 include_status
= git_config_bool(k
, v
);
1364 if (!strcmp(k
, "commit.cleanup"))
1365 return git_config_string(&cleanup_arg
, k
, v
);
1366 if (!strcmp(k
, "commit.gpgsign")) {
1367 sign_commit
= git_config_bool(k
, v
) ? "" : NULL
;
1370 if (!strcmp(k
, "commit.verbose")) {
1372 config_commit_verbose
= git_config_bool_or_int(k
, v
, &is_bool
);
1376 status
= git_gpg_config(k
, v
, NULL
);
1379 return git_status_config(k
, v
, s
);
1382 int run_commit_hook(int editor_is_used
, const char *index_file
, const char *name
, ...)
1384 struct argv_array hook_env
= ARGV_ARRAY_INIT
;
1388 argv_array_pushf(&hook_env
, "GIT_INDEX_FILE=%s", index_file
);
1391 * Let the hook know that no editor will be launched.
1393 if (!editor_is_used
)
1394 argv_array_push(&hook_env
, "GIT_EDITOR=:");
1396 va_start(args
, name
);
1397 ret
= run_hook_ve(hook_env
.argv
,name
, args
);
1399 argv_array_clear(&hook_env
);
1404 int cmd_commit(int argc
, const char **argv
, const char *prefix
)
1406 const char *argv_gc_auto
[] = {"gc", "--auto", NULL
};
1407 static struct wt_status s
;
1408 static struct option builtin_commit_options
[] = {
1409 OPT__QUIET(&quiet
, N_("suppress summary after successful commit")),
1410 OPT__VERBOSE(&verbose
, N_("show diff in commit message template")),
1412 OPT_GROUP(N_("Commit message options")),
1413 OPT_FILENAME('F', "file", &logfile
, N_("read message from file")),
1414 OPT_STRING(0, "author", &force_author
, N_("author"), N_("override author for commit")),
1415 OPT_STRING(0, "date", &force_date
, N_("date"), N_("override date for commit")),
1416 OPT_CALLBACK('m', "message", &message
, N_("message"), N_("commit message"), opt_parse_m
),
1417 OPT_STRING('c', "reedit-message", &edit_message
, N_("commit"), N_("reuse and edit message from specified commit")),
1418 OPT_STRING('C', "reuse-message", &use_message
, N_("commit"), N_("reuse message from specified commit")),
1419 OPT_STRING(0, "fixup", &fixup_message
, N_("commit"), N_("use autosquash formatted message to fixup specified commit")),
1420 OPT_STRING(0, "squash", &squash_message
, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
1421 OPT_BOOL(0, "reset-author", &renew_authorship
, N_("the commit is authored by me now (used with -C/-c/--amend)")),
1422 OPT_BOOL('s', "signoff", &signoff
, N_("add Signed-off-by:")),
1423 OPT_FILENAME('t', "template", &template_file
, N_("use specified template file")),
1424 OPT_BOOL('e', "edit", &edit_flag
, N_("force edit of commit")),
1425 OPT_STRING(0, "cleanup", &cleanup_arg
, N_("default"), N_("how to strip spaces and #comments from message")),
1426 OPT_BOOL(0, "status", &include_status
, N_("include status in commit message template")),
1427 { OPTION_STRING
, 'S', "gpg-sign", &sign_commit
, N_("key-id"),
1428 N_("GPG sign commit"), PARSE_OPT_OPTARG
, NULL
, (intptr_t) "" },
1429 /* end commit message options */
1431 OPT_GROUP(N_("Commit contents options")),
1432 OPT_BOOL('a', "all", &all
, N_("commit all changed files")),
1433 OPT_BOOL('i', "include", &also
, N_("add specified files to index for commit")),
1434 OPT_BOOL(0, "interactive", &interactive
, N_("interactively add files")),
1435 OPT_BOOL('p', "patch", &patch_interactive
, N_("interactively add changes")),
1436 OPT_BOOL('o', "only", &only
, N_("commit only specified files")),
1437 OPT_BOOL('n', "no-verify", &no_verify
, N_("bypass pre-commit and commit-msg hooks")),
1438 OPT_BOOL(0, "dry-run", &dry_run
, N_("show what would be committed")),
1439 OPT_SET_INT(0, "short", &status_format
, N_("show status concisely"),
1440 STATUS_FORMAT_SHORT
),
1441 OPT_BOOL(0, "branch", &s
.show_branch
, N_("show branch information")),
1442 OPT_BOOL(0, "ahead-behind", &s
.ahead_behind_flags
,
1443 N_("compute full ahead/behind values")),
1444 OPT_SET_INT(0, "porcelain", &status_format
,
1445 N_("machine-readable output"), STATUS_FORMAT_PORCELAIN
),
1446 OPT_SET_INT(0, "long", &status_format
,
1447 N_("show status in long format (default)"),
1448 STATUS_FORMAT_LONG
),
1449 OPT_BOOL('z', "null", &s
.null_termination
,
1450 N_("terminate entries with NUL")),
1451 OPT_BOOL(0, "amend", &amend
, N_("amend previous commit")),
1452 OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite
, N_("bypass post-rewrite hook")),
1453 { 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" },
1454 /* end commit contents options */
1456 OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty
,
1457 N_("ok to record an empty change")),
1458 OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message
,
1459 N_("ok to record a change with an empty message")),
1464 struct strbuf sb
= STRBUF_INIT
;
1465 struct strbuf author_ident
= STRBUF_INIT
;
1466 const char *index_file
, *reflog_msg
;
1467 struct object_id oid
;
1468 struct commit_list
*parents
= NULL
;
1469 struct stat statbuf
;
1470 struct commit
*current_head
= NULL
;
1471 struct commit_extra_header
*extra
= NULL
;
1472 struct strbuf err
= STRBUF_INIT
;
1474 if (argc
== 2 && !strcmp(argv
[1], "-h"))
1475 usage_with_options(builtin_commit_usage
, builtin_commit_options
);
1477 status_init_config(&s
, git_commit_config
);
1478 s
.commit_template
= 1;
1479 status_format
= STATUS_FORMAT_NONE
; /* Ignore status.short */
1482 if (get_oid("HEAD", &oid
))
1483 current_head
= NULL
;
1485 current_head
= lookup_commit_or_die(&oid
, "HEAD");
1486 if (parse_commit(current_head
))
1487 die(_("could not parse HEAD commit"));
1489 verbose
= -1; /* unspecified */
1490 argc
= parse_and_validate_options(argc
, argv
, builtin_commit_options
,
1491 builtin_commit_usage
,
1492 prefix
, current_head
, &s
);
1494 verbose
= (config_commit_verbose
< 0) ? 0 : config_commit_verbose
;
1497 return dry_run_commit(argc
, argv
, prefix
, current_head
, &s
);
1498 index_file
= prepare_index(argc
, argv
, prefix
, current_head
, 0);
1500 /* Set up everything for writing the commit object. This includes
1501 running hooks, writing the trees, and interacting with the user. */
1502 if (!prepare_to_commit(index_file
, prefix
,
1503 current_head
, &s
, &author_ident
)) {
1504 rollback_index_files();
1508 /* Determine parents */
1509 reflog_msg
= getenv("GIT_REFLOG_ACTION");
1510 if (!current_head
) {
1512 reflog_msg
= "commit (initial)";
1515 reflog_msg
= "commit (amend)";
1516 parents
= copy_commit_list(current_head
->parents
);
1517 } else if (whence
== FROM_MERGE
) {
1518 struct strbuf m
= STRBUF_INIT
;
1520 int allow_fast_forward
= 1;
1521 struct commit_list
**pptr
= &parents
;
1524 reflog_msg
= "commit (merge)";
1525 pptr
= commit_list_append(current_head
, pptr
);
1526 fp
= xfopen(git_path_merge_head(the_repository
), "r");
1527 while (strbuf_getline_lf(&m
, fp
) != EOF
) {
1528 struct commit
*parent
;
1530 parent
= get_merge_parent(m
.buf
);
1532 die(_("Corrupt MERGE_HEAD file (%s)"), m
.buf
);
1533 pptr
= commit_list_append(parent
, pptr
);
1537 if (!stat(git_path_merge_mode(the_repository
), &statbuf
)) {
1538 if (strbuf_read_file(&sb
, git_path_merge_mode(the_repository
), 0) < 0)
1539 die_errno(_("could not read MERGE_MODE"));
1540 if (!strcmp(sb
.buf
, "no-ff"))
1541 allow_fast_forward
= 0;
1543 if (allow_fast_forward
)
1544 reduce_heads_replace(&parents
);
1547 reflog_msg
= (whence
== FROM_CHERRY_PICK
)
1548 ? "commit (cherry-pick)"
1550 commit_list_insert(current_head
, &parents
);
1553 /* Finally, get the commit message */
1555 if (strbuf_read_file(&sb
, git_path_commit_editmsg(), 0) < 0) {
1556 int saved_errno
= errno
;
1557 rollback_index_files();
1558 die(_("could not read commit message: %s"), strerror(saved_errno
));
1561 if (verbose
|| /* Truncate the message just before the diff, if any. */
1562 cleanup_mode
== COMMIT_MSG_CLEANUP_SCISSORS
)
1563 strbuf_setlen(&sb
, wt_status_locate_end(sb
.buf
, sb
.len
));
1564 if (cleanup_mode
!= COMMIT_MSG_CLEANUP_NONE
)
1565 strbuf_stripspace(&sb
, cleanup_mode
== COMMIT_MSG_CLEANUP_ALL
);
1567 if (message_is_empty(&sb
, cleanup_mode
) && !allow_empty_message
) {
1568 rollback_index_files();
1569 fprintf(stderr
, _("Aborting commit due to empty commit message.\n"));
1572 if (template_untouched(&sb
, template_file
, cleanup_mode
) && !allow_empty_message
) {
1573 rollback_index_files();
1574 fprintf(stderr
, _("Aborting commit; you did not edit the message.\n"));
1579 const char *exclude_gpgsig
[2] = { "gpgsig", NULL
};
1580 extra
= read_commit_extra_headers(current_head
, exclude_gpgsig
);
1582 struct commit_extra_header
**tail
= &extra
;
1583 append_merge_tag_headers(parents
, &tail
);
1586 if (commit_tree_extended(sb
.buf
, sb
.len
, &active_cache_tree
->oid
,
1587 parents
, &oid
, author_ident
.buf
, sign_commit
,
1589 rollback_index_files();
1590 die(_("failed to write commit object"));
1592 strbuf_release(&author_ident
);
1593 free_commit_extra_headers(extra
);
1595 if (update_head_with_reflog(current_head
, &oid
, reflog_msg
, &sb
,
1597 rollback_index_files();
1601 unlink(git_path_cherry_pick_head(the_repository
));
1602 unlink(git_path_revert_head(the_repository
));
1603 unlink(git_path_merge_head(the_repository
));
1604 unlink(git_path_merge_msg(the_repository
));
1605 unlink(git_path_merge_mode(the_repository
));
1606 unlink(git_path_squash_msg(the_repository
));
1608 if (commit_index_files())
1609 die (_("Repository has been updated, but unable to write\n"
1610 "new_index file. Check that disk is not full and quota is\n"
1611 "not exceeded, and then \"git reset HEAD\" to recover."));
1614 run_command_v_opt(argv_gc_auto
, RUN_GIT_CMD
);
1615 run_commit_hook(use_editor
, get_index_file(), "post-commit", NULL
);
1616 if (amend
&& !no_post_rewrite
) {
1617 commit_post_rewrite(current_head
, &oid
);
1620 unsigned int flags
= 0;
1623 flags
|= SUMMARY_INITIAL_COMMIT
;
1624 if (author_date_is_interesting())
1625 flags
|= SUMMARY_SHOW_AUTHOR_DATE
;
1626 print_commit_summary(prefix
, &oid
, flags
);