4 * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>
5 * Based on git-commit.sh by Junio C Hamano and Linus Torvalds
8 #define USE_THE_INDEX_VARIABLE
13 #include "cache-tree.h"
17 #include "environment.h"
24 #include "wt-status.h"
25 #include "run-command.h"
31 #include "object-name.h"
32 #include "parse-options.h"
33 #include "string-list.h"
35 #include "unpack-trees.h"
37 #include "submodule.h"
38 #include "gpg-interface.h"
40 #include "sequencer.h"
43 #include "commit-reach.h"
44 #include "commit-graph.h"
47 static const char * const builtin_commit_usage
[] = {
48 N_("git commit [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]\n"
49 " [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>)]\n"
50 " [-F <file> | -m <msg>] [--reset-author] [--allow-empty]\n"
51 " [--allow-empty-message] [--no-verify] [-e] [--author=<author>]\n"
52 " [--date=<date>] [--cleanup=<mode>] [--[no-]status]\n"
53 " [-i | -o] [--pathspec-from-file=<file> [--pathspec-file-nul]]\n"
54 " [(--trailer <token>[(=|:)<value>])...] [-S[<keyid>]]\n"
55 " [--] [<pathspec>...]"),
59 static const char * const builtin_status_usage
[] = {
60 N_("git status [<options>] [--] [<pathspec>...]"),
64 static const char empty_amend_advice
[] =
65 N_("You asked to amend the most recent commit, but doing so would make\n"
66 "it empty. You can repeat your command with --allow-empty, or you can\n"
67 "remove the commit entirely with \"git reset HEAD^\".\n");
69 static const char empty_cherry_pick_advice
[] =
70 N_("The previous cherry-pick is now empty, possibly due to conflict resolution.\n"
71 "If you wish to commit it anyway, use:\n"
73 " git commit --allow-empty\n"
76 static const char empty_rebase_pick_advice
[] =
77 N_("Otherwise, please use 'git rebase --skip'\n");
79 static const char empty_cherry_pick_advice_single
[] =
80 N_("Otherwise, please use 'git cherry-pick --skip'\n");
82 static const char empty_cherry_pick_advice_multi
[] =
85 " git cherry-pick --continue\n"
87 "to resume cherry-picking the remaining commits.\n"
88 "If you wish to skip this commit, use:\n"
90 " git cherry-pick --skip\n"
93 static const char *color_status_slots
[] = {
94 [WT_STATUS_HEADER
] = "header",
95 [WT_STATUS_UPDATED
] = "updated",
96 [WT_STATUS_CHANGED
] = "changed",
97 [WT_STATUS_UNTRACKED
] = "untracked",
98 [WT_STATUS_NOBRANCH
] = "noBranch",
99 [WT_STATUS_UNMERGED
] = "unmerged",
100 [WT_STATUS_LOCAL_BRANCH
] = "localBranch",
101 [WT_STATUS_REMOTE_BRANCH
] = "remoteBranch",
102 [WT_STATUS_ONBRANCH
] = "branch",
105 static const char *use_message_buffer
;
106 static struct lock_file index_lock
; /* real index */
107 static struct lock_file false_lock
; /* used only for partial commits */
114 static const char *logfile
, *force_author
;
115 static const char *template_file
;
117 * The _message variables are commit names from which to take
118 * the commit message and/or authorship.
120 static const char *author_message
, *author_message_buffer
;
121 static char *edit_message
, *use_message
;
122 static char *fixup_message
, *fixup_commit
, *squash_message
;
123 static const char *fixup_prefix
;
124 static int all
, also
, interactive
, patch_interactive
, only
, amend
, signoff
;
125 static int edit_flag
= -1; /* unspecified */
126 static int quiet
, verbose
, no_verify
, allow_empty
, dry_run
, renew_authorship
;
127 static int config_commit_verbose
= -1; /* unspecified */
128 static int no_post_rewrite
, allow_empty_message
, pathspec_file_nul
;
129 static char *untracked_files_arg
, *force_date
, *ignore_submodule_arg
, *ignored_arg
;
130 static char *sign_commit
, *pathspec_from_file
;
131 static struct strvec trailer_args
= STRVEC_INIT
;
134 * The default commit message cleanup mode will remove the lines
135 * beginning with # (shell comments) and leading and trailing
136 * whitespaces (empty lines or containing only whitespaces)
137 * if editor is used, and only the whitespaces if the message
138 * is specified explicitly.
140 static enum commit_msg_cleanup_mode cleanup_mode
;
141 static const char *cleanup_arg
;
143 static enum commit_whence whence
;
144 static int use_editor
= 1, include_status
= 1;
145 static int have_option_m
;
146 static struct strbuf message
= STRBUF_INIT
;
148 static enum wt_status_format status_format
= STATUS_FORMAT_UNSPECIFIED
;
150 static int opt_pass_trailer(const struct option
*opt
, const char *arg
, int unset
)
152 BUG_ON_OPT_NEG(unset
);
154 strvec_pushl(opt
->value
, "--trailer", arg
, NULL
);
158 static int opt_parse_porcelain(const struct option
*opt
, const char *arg
, int unset
)
160 enum wt_status_format
*value
= (enum wt_status_format
*)opt
->value
;
162 *value
= STATUS_FORMAT_NONE
;
164 *value
= STATUS_FORMAT_PORCELAIN
;
165 else if (!strcmp(arg
, "v1") || !strcmp(arg
, "1"))
166 *value
= STATUS_FORMAT_PORCELAIN
;
167 else if (!strcmp(arg
, "v2") || !strcmp(arg
, "2"))
168 *value
= STATUS_FORMAT_PORCELAIN_V2
;
170 die("unsupported porcelain version '%s'", arg
);
175 static int opt_parse_m(const struct option
*opt
, const char *arg
, int unset
)
177 struct strbuf
*buf
= opt
->value
;
180 strbuf_setlen(buf
, 0);
184 strbuf_addch(buf
, '\n');
185 strbuf_addstr(buf
, arg
);
186 strbuf_complete_line(buf
);
191 static int opt_parse_rename_score(const struct option
*opt
, const char *arg
, int unset
)
193 const char **value
= opt
->value
;
195 BUG_ON_OPT_NEG(unset
);
197 if (arg
!= NULL
&& *arg
== '=')
204 static void determine_whence(struct wt_status
*s
)
206 if (file_exists(git_path_merge_head(the_repository
)))
208 else if (!sequencer_determine_whence(the_repository
, &whence
))
209 whence
= FROM_COMMIT
;
214 static void status_init_config(struct wt_status
*s
, config_fn_t fn
)
216 wt_status_prepare(the_repository
, s
);
217 init_diff_ui_defaults();
220 s
->hints
= advice_enabled(ADVICE_STATUS_HINTS
); /* must come after git_config() */
223 static void rollback_index_files(void)
225 switch (commit_style
) {
227 break; /* nothing to do */
229 rollback_lock_file(&index_lock
);
232 rollback_lock_file(&index_lock
);
233 rollback_lock_file(&false_lock
);
238 static int commit_index_files(void)
242 switch (commit_style
) {
244 break; /* nothing to do */
246 err
= commit_lock_file(&index_lock
);
249 err
= commit_lock_file(&index_lock
);
250 rollback_lock_file(&false_lock
);
258 * Take a union of paths in the index and the named tree (typically, "HEAD"),
259 * and return the paths that match the given pattern in list.
261 static int list_paths(struct string_list
*list
, const char *with_tree
,
262 const struct pathspec
*pattern
)
270 m
= xcalloc(1, pattern
->nr
);
273 char *max_prefix
= common_prefix(pattern
);
274 overlay_tree_on_index(&the_index
, with_tree
, max_prefix
);
278 /* TODO: audit for interaction with sparse-index. */
279 ensure_full_index(&the_index
);
280 for (i
= 0; i
< the_index
.cache_nr
; i
++) {
281 const struct cache_entry
*ce
= the_index
.cache
[i
];
282 struct string_list_item
*item
;
284 if (ce
->ce_flags
& CE_UPDATE
)
286 if (!ce_path_match(&the_index
, ce
, pattern
, m
))
288 item
= string_list_insert(list
, ce
->name
);
289 if (ce_skip_worktree(ce
))
290 item
->util
= item
; /* better a valid pointer than a fake one */
293 ret
= report_path_error(m
, pattern
);
298 static void add_remove_files(struct string_list
*list
)
301 for (i
= 0; i
< list
->nr
; i
++) {
303 struct string_list_item
*p
= &(list
->items
[i
]);
305 /* p->util is skip-worktree */
309 if (!lstat(p
->string
, &st
)) {
310 if (add_to_index(&the_index
, p
->string
, &st
, 0))
311 die(_("updating files failed"));
313 remove_file_from_index(&the_index
, p
->string
);
317 static void create_base_index(const struct commit
*current_head
)
320 struct unpack_trees_options opts
;
324 discard_index(&the_index
);
328 memset(&opts
, 0, sizeof(opts
));
332 opts
.src_index
= &the_index
;
333 opts
.dst_index
= &the_index
;
335 opts
.fn
= oneway_merge
;
336 tree
= parse_tree_indirect(¤t_head
->object
.oid
);
338 die(_("failed to unpack HEAD tree object"));
340 init_tree_desc(&t
, tree
->buffer
, tree
->size
);
341 if (unpack_trees(1, &t
, &opts
))
342 exit(128); /* We've already reported the error, finish dying */
345 static void refresh_cache_or_die(int refresh_flags
)
348 * refresh_flags contains REFRESH_QUIET, so the only errors
349 * are for unmerged entries.
351 if (refresh_index(&the_index
, refresh_flags
| REFRESH_IN_PORCELAIN
, NULL
, NULL
, NULL
))
352 die_resolve_conflict("commit");
355 static const char *prepare_index(const char **argv
, const char *prefix
,
356 const struct commit
*current_head
, int is_status
)
358 struct string_list partial
= STRING_LIST_INIT_DUP
;
359 struct pathspec pathspec
;
360 int refresh_flags
= REFRESH_QUIET
;
364 refresh_flags
|= REFRESH_UNMERGED
;
365 parse_pathspec(&pathspec
, 0,
366 PATHSPEC_PREFER_FULL
,
369 if (pathspec_from_file
) {
371 die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "--interactive/--patch");
374 die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "-a");
377 die(_("'%s' and pathspec arguments cannot be used together"), "--pathspec-from-file");
379 parse_pathspec_file(&pathspec
, 0,
380 PATHSPEC_PREFER_FULL
,
381 prefix
, pathspec_from_file
, pathspec_file_nul
);
382 } else if (pathspec_file_nul
) {
383 die(_("the option '%s' requires '%s'"), "--pathspec-file-nul", "--pathspec-from-file");
386 if (!pathspec
.nr
&& (also
|| (only
&& !allow_empty
&&
387 (!amend
|| (fixup_message
&& strcmp(fixup_prefix
, "amend"))))))
388 die(_("No paths with --include/--only does not make sense."));
390 if (repo_read_index_preload(the_repository
, &pathspec
, 0) < 0)
391 die(_("index file corrupt"));
394 char *old_index_env
= NULL
, *old_repo_index_file
;
395 repo_hold_locked_index(the_repository
, &index_lock
,
398 refresh_cache_or_die(refresh_flags
);
400 if (write_locked_index(&the_index
, &index_lock
, 0))
401 die(_("unable to create temporary index"));
403 old_repo_index_file
= the_repository
->index_file
;
404 the_repository
->index_file
=
405 (char *)get_lock_file_path(&index_lock
);
406 old_index_env
= xstrdup_or_null(getenv(INDEX_ENVIRONMENT
));
407 setenv(INDEX_ENVIRONMENT
, the_repository
->index_file
, 1);
409 if (interactive_add(argv
, prefix
, patch_interactive
) != 0)
410 die(_("interactive add failed"));
412 the_repository
->index_file
= old_repo_index_file
;
413 if (old_index_env
&& *old_index_env
)
414 setenv(INDEX_ENVIRONMENT
, old_index_env
, 1);
416 unsetenv(INDEX_ENVIRONMENT
);
417 FREE_AND_NULL(old_index_env
);
419 discard_index(&the_index
);
420 read_index_from(&the_index
, get_lock_file_path(&index_lock
),
422 if (cache_tree_update(&the_index
, WRITE_TREE_SILENT
) == 0) {
423 if (reopen_lock_file(&index_lock
) < 0)
424 die(_("unable to write index file"));
425 if (write_locked_index(&the_index
, &index_lock
, 0))
426 die(_("unable to update temporary index"));
428 warning(_("Failed to update main cache tree"));
430 commit_style
= COMMIT_NORMAL
;
431 ret
= get_lock_file_path(&index_lock
);
436 * Non partial, non as-is commit.
438 * (1) get the real index;
439 * (2) update the_index as necessary;
440 * (3) write the_index out to the real index (still locked);
441 * (4) return the name of the locked index file.
443 * The caller should run hooks on the locked real index, and
444 * (A) if all goes well, commit the real index;
445 * (B) on failure, rollback the real index.
447 if (all
|| (also
&& pathspec
.nr
)) {
448 repo_hold_locked_index(the_repository
, &index_lock
,
450 add_files_to_cache(also
? prefix
: NULL
, &pathspec
, 0);
451 refresh_cache_or_die(refresh_flags
);
452 cache_tree_update(&the_index
, WRITE_TREE_SILENT
);
453 if (write_locked_index(&the_index
, &index_lock
, 0))
454 die(_("unable to write new_index file"));
455 commit_style
= COMMIT_NORMAL
;
456 ret
= get_lock_file_path(&index_lock
);
463 * (1) return the name of the real index file.
465 * The caller should run hooks on the real index,
466 * and create commit from the_index.
467 * We still need to refresh the index here.
469 if (!only
&& !pathspec
.nr
) {
470 repo_hold_locked_index(the_repository
, &index_lock
,
472 refresh_cache_or_die(refresh_flags
);
473 if (the_index
.cache_changed
474 || !cache_tree_fully_valid(the_index
.cache_tree
))
475 cache_tree_update(&the_index
, WRITE_TREE_SILENT
);
476 if (write_locked_index(&the_index
, &index_lock
,
477 COMMIT_LOCK
| SKIP_IF_UNCHANGED
))
478 die(_("unable to write new_index file"));
479 commit_style
= COMMIT_AS_IS
;
480 ret
= get_index_file();
487 * (0) find the set of affected paths;
488 * (1) get lock on the real index file;
489 * (2) update the_index with the given paths;
490 * (3) write the_index out to the real index (still locked);
491 * (4) get lock on the false index file;
492 * (5) reset the_index from HEAD;
493 * (6) update the_index the same way as (2);
494 * (7) write the_index out to the false index file;
495 * (8) return the name of the false index file (still locked);
497 * The caller should run hooks on the locked false index, and
498 * create commit from it. Then
499 * (A) if all goes well, commit the real index;
500 * (B) on failure, rollback the real index;
501 * In either case, rollback the false index.
503 commit_style
= COMMIT_PARTIAL
;
505 if (whence
!= FROM_COMMIT
) {
506 if (whence
== FROM_MERGE
)
507 die(_("cannot do a partial commit during a merge."));
508 else if (is_from_cherry_pick(whence
))
509 die(_("cannot do a partial commit during a cherry-pick."));
510 else if (is_from_rebase(whence
))
511 die(_("cannot do a partial commit during a rebase."));
514 if (list_paths(&partial
, !current_head
? NULL
: "HEAD", &pathspec
))
517 discard_index(&the_index
);
518 if (repo_read_index(the_repository
) < 0)
519 die(_("cannot read the index"));
521 repo_hold_locked_index(the_repository
, &index_lock
, LOCK_DIE_ON_ERROR
);
522 add_remove_files(&partial
);
523 refresh_index(&the_index
, REFRESH_QUIET
, NULL
, NULL
, NULL
);
524 cache_tree_update(&the_index
, WRITE_TREE_SILENT
);
525 if (write_locked_index(&the_index
, &index_lock
, 0))
526 die(_("unable to write new_index file"));
528 hold_lock_file_for_update(&false_lock
,
529 git_path("next-index-%"PRIuMAX
,
530 (uintmax_t) getpid()),
533 create_base_index(current_head
);
534 add_remove_files(&partial
);
535 refresh_index(&the_index
, REFRESH_QUIET
, NULL
, NULL
, NULL
);
537 if (write_locked_index(&the_index
, &false_lock
, 0))
538 die(_("unable to write temporary index file"));
540 discard_index(&the_index
);
541 ret
= get_lock_file_path(&false_lock
);
542 read_index_from(&the_index
, ret
, get_git_dir());
544 string_list_clear(&partial
, 0);
545 clear_pathspec(&pathspec
);
549 static int run_status(FILE *fp
, const char *index_file
, const char *prefix
, int nowarn
,
552 struct object_id oid
;
554 if (s
->relative_paths
)
559 s
->reference
= "HEAD^1";
561 s
->verbose
= verbose
;
562 s
->index_file
= index_file
;
565 s
->is_initial
= repo_get_oid(the_repository
, s
->reference
, &oid
) ? 1 : 0;
567 oidcpy(&s
->oid_commit
, &oid
);
568 s
->status_format
= status_format
;
569 s
->ignore_submodule_arg
= ignore_submodule_arg
;
571 wt_status_collect(s
);
573 wt_status_collect_free_buffers(s
);
575 return s
->committable
;
578 static int is_a_merge(const struct commit
*current_head
)
580 return !!(current_head
->parents
&& current_head
->parents
->next
);
583 static void assert_split_ident(struct ident_split
*id
, const struct strbuf
*buf
)
585 if (split_ident_line(id
, buf
->buf
, buf
->len
) || !id
->date_begin
)
586 BUG("unable to parse our own ident: %s", buf
->buf
);
589 static void export_one(const char *var
, const char *s
, const char *e
, int hack
)
591 struct strbuf buf
= STRBUF_INIT
;
593 strbuf_addch(&buf
, hack
);
594 strbuf_add(&buf
, s
, e
- s
);
595 setenv(var
, buf
.buf
, 1);
596 strbuf_release(&buf
);
599 static int parse_force_date(const char *in
, struct strbuf
*out
)
601 strbuf_addch(out
, '@');
603 if (parse_date(in
, out
) < 0) {
605 unsigned long t
= approxidate_careful(in
, &errors
);
608 strbuf_addf(out
, "%lu", t
);
614 static void set_ident_var(char **buf
, char *val
)
620 static void determine_author_info(struct strbuf
*author_ident
)
622 char *name
, *email
, *date
;
623 struct ident_split author
;
625 name
= xstrdup_or_null(getenv("GIT_AUTHOR_NAME"));
626 email
= xstrdup_or_null(getenv("GIT_AUTHOR_EMAIL"));
627 date
= xstrdup_or_null(getenv("GIT_AUTHOR_DATE"));
629 if (author_message
) {
630 struct ident_split ident
;
634 a
= find_commit_header(author_message_buffer
, "author", &len
);
636 die(_("commit '%s' lacks author header"), author_message
);
637 if (split_ident_line(&ident
, a
, len
) < 0)
638 die(_("commit '%s' has malformed author line"), author_message
);
640 set_ident_var(&name
, xmemdupz(ident
.name_begin
, ident
.name_end
- ident
.name_begin
));
641 set_ident_var(&email
, xmemdupz(ident
.mail_begin
, ident
.mail_end
- ident
.mail_begin
));
643 if (ident
.date_begin
) {
644 struct strbuf date_buf
= STRBUF_INIT
;
645 strbuf_addch(&date_buf
, '@');
646 strbuf_add(&date_buf
, ident
.date_begin
, ident
.date_end
- ident
.date_begin
);
647 strbuf_addch(&date_buf
, ' ');
648 strbuf_add(&date_buf
, ident
.tz_begin
, ident
.tz_end
- ident
.tz_begin
);
649 set_ident_var(&date
, strbuf_detach(&date_buf
, NULL
));
654 struct ident_split ident
;
656 if (split_ident_line(&ident
, force_author
, strlen(force_author
)) < 0)
657 die(_("malformed --author parameter"));
658 set_ident_var(&name
, xmemdupz(ident
.name_begin
, ident
.name_end
- ident
.name_begin
));
659 set_ident_var(&email
, xmemdupz(ident
.mail_begin
, ident
.mail_end
- ident
.mail_begin
));
663 struct strbuf date_buf
= STRBUF_INIT
;
664 if (parse_force_date(force_date
, &date_buf
))
665 die(_("invalid date format: %s"), force_date
);
666 set_ident_var(&date
, strbuf_detach(&date_buf
, NULL
));
669 strbuf_addstr(author_ident
, fmt_ident(name
, email
, WANT_AUTHOR_IDENT
, date
,
671 assert_split_ident(&author
, author_ident
);
672 export_one("GIT_AUTHOR_NAME", author
.name_begin
, author
.name_end
, 0);
673 export_one("GIT_AUTHOR_EMAIL", author
.mail_begin
, author
.mail_end
, 0);
674 export_one("GIT_AUTHOR_DATE", author
.date_begin
, author
.tz_end
, '@');
680 static int author_date_is_interesting(void)
682 return author_message
|| force_date
;
685 static void adjust_comment_line_char(const struct strbuf
*sb
)
687 char candidates
[] = "#;@!$%^&|:";
691 comment_line_char
= candidates
[0];
692 if (!memchr(sb
->buf
, comment_line_char
, sb
->len
))
696 candidate
= strchr(candidates
, *p
);
699 for (p
= sb
->buf
; *p
; p
++) {
700 if ((p
[0] == '\n' || p
[0] == '\r') && p
[1]) {
701 candidate
= strchr(candidates
, p
[1]);
707 for (p
= candidates
; *p
== ' '; p
++)
710 die(_("unable to select a comment character that is not used\n"
711 "in the current commit message"));
712 comment_line_char
= *p
;
715 static void prepare_amend_commit(struct commit
*commit
, struct strbuf
*sb
,
716 struct pretty_print_context
*ctx
)
718 const char *buffer
, *subject
, *fmt
;
720 buffer
= repo_get_commit_buffer(the_repository
, commit
, NULL
);
721 find_commit_subject(buffer
, &subject
);
723 * If we amend the 'amend!' commit then we don't want to
724 * duplicate the subject line.
726 fmt
= starts_with(subject
, "amend!") ? "%b" : "%B";
727 repo_format_commit_message(the_repository
, commit
, fmt
, sb
, ctx
);
728 repo_unuse_commit_buffer(the_repository
, commit
, buffer
);
731 static int prepare_to_commit(const char *index_file
, const char *prefix
,
732 struct commit
*current_head
,
734 struct strbuf
*author_ident
)
737 struct strbuf committer_ident
= STRBUF_INIT
;
739 struct strbuf sb
= STRBUF_INIT
;
740 const char *hook_arg1
= NULL
;
741 const char *hook_arg2
= NULL
;
742 int clean_message_contents
= (cleanup_mode
!= COMMIT_MSG_CLEANUP_NONE
);
743 int old_display_comment_prefix
;
744 int merge_contains_scissors
= 0;
747 /* This checks and barfs if author is badly specified */
748 determine_author_info(author_ident
);
750 if (!no_verify
&& run_commit_hook(use_editor
, index_file
, &invoked_hook
,
754 if (squash_message
) {
756 * Insert the proper subject line before other commit
757 * message options add their content.
759 if (use_message
&& !strcmp(use_message
, squash_message
))
760 strbuf_addstr(&sb
, "squash! ");
762 struct pretty_print_context ctx
= {0};
764 c
= lookup_commit_reference_by_name(squash_message
);
766 die(_("could not lookup commit '%s'"), squash_message
);
767 ctx
.output_encoding
= get_commit_output_encoding();
768 repo_format_commit_message(the_repository
, c
,
769 "squash! %s\n\n", &sb
,
774 if (have_option_m
&& !fixup_message
) {
775 strbuf_addbuf(&sb
, &message
);
776 hook_arg1
= "message";
777 } else if (logfile
&& !strcmp(logfile
, "-")) {
779 fprintf(stderr
, _("(reading log message from standard input)\n"));
780 if (strbuf_read(&sb
, 0, 0) < 0)
781 die_errno(_("could not read log from standard input"));
782 hook_arg1
= "message";
783 } else if (logfile
) {
784 if (strbuf_read_file(&sb
, logfile
, 0) < 0)
785 die_errno(_("could not read log file '%s'"),
787 hook_arg1
= "message";
788 } else if (use_message
) {
790 buffer
= strstr(use_message_buffer
, "\n\n");
792 strbuf_addstr(&sb
, skip_blank_lines(buffer
+ 2));
793 hook_arg1
= "commit";
794 hook_arg2
= use_message
;
795 } else if (fixup_message
) {
796 struct pretty_print_context ctx
= {0};
797 struct commit
*commit
;
799 commit
= lookup_commit_reference_by_name(fixup_commit
);
801 die(_("could not lookup commit '%s'"), fixup_commit
);
802 ctx
.output_encoding
= get_commit_output_encoding();
803 fmt
= xstrfmt("%s! %%s\n\n", fixup_prefix
);
804 repo_format_commit_message(the_repository
, commit
, fmt
, &sb
,
807 hook_arg1
= "message";
810 * Only `-m` commit message option is checked here, as
811 * it supports `--fixup` to append the commit message.
813 * The other commit message options `-c`/`-C`/`-F` are
814 * incompatible with all the forms of `--fixup` and
815 * have already errored out while parsing the `git commit`
818 if (have_option_m
&& !strcmp(fixup_prefix
, "fixup"))
819 strbuf_addbuf(&sb
, &message
);
821 if (!strcmp(fixup_prefix
, "amend")) {
823 die(_("options '%s' and '%s:%s' cannot be used together"), "-m", "--fixup", fixup_message
);
824 prepare_amend_commit(commit
, &sb
, &ctx
);
826 } else if (!stat(git_path_merge_msg(the_repository
), &statbuf
)) {
827 size_t merge_msg_start
;
830 * prepend SQUASH_MSG here if it exists and a
831 * "merge --squash" was originally performed
833 if (!stat(git_path_squash_msg(the_repository
), &statbuf
)) {
834 if (strbuf_read_file(&sb
, git_path_squash_msg(the_repository
), 0) < 0)
835 die_errno(_("could not read SQUASH_MSG"));
836 hook_arg1
= "squash";
840 merge_msg_start
= sb
.len
;
841 if (strbuf_read_file(&sb
, git_path_merge_msg(the_repository
), 0) < 0)
842 die_errno(_("could not read MERGE_MSG"));
844 if (cleanup_mode
== COMMIT_MSG_CLEANUP_SCISSORS
&&
845 wt_status_locate_end(sb
.buf
+ merge_msg_start
,
846 sb
.len
- merge_msg_start
) <
847 sb
.len
- merge_msg_start
)
848 merge_contains_scissors
= 1;
849 } else if (!stat(git_path_squash_msg(the_repository
), &statbuf
)) {
850 if (strbuf_read_file(&sb
, git_path_squash_msg(the_repository
), 0) < 0)
851 die_errno(_("could not read SQUASH_MSG"));
852 hook_arg1
= "squash";
853 } else if (template_file
) {
854 if (strbuf_read_file(&sb
, template_file
, 0) < 0)
855 die_errno(_("could not read '%s'"), template_file
);
856 hook_arg1
= "template";
857 clean_message_contents
= 0;
861 * The remaining cases don't modify the template message, but
862 * just set the argument(s) to the prepare-commit-msg hook.
864 else if (whence
== FROM_MERGE
)
866 else if (is_from_cherry_pick(whence
) || whence
== FROM_REBASE_PICK
) {
867 hook_arg1
= "commit";
868 hook_arg2
= "CHERRY_PICK_HEAD";
871 if (squash_message
) {
873 * If squash_commit was used for the commit subject,
874 * then we're possibly hijacking other commit log options.
875 * Reset the hook args to tell the real story.
877 hook_arg1
= "message";
881 s
->fp
= fopen_for_writing(git_path_commit_editmsg());
883 die_errno(_("could not open '%s'"), git_path_commit_editmsg());
885 /* Ignore status.displayCommentPrefix: we do need comments in COMMIT_EDITMSG. */
886 old_display_comment_prefix
= s
->display_comment_prefix
;
887 s
->display_comment_prefix
= 1;
890 * Most hints are counter-productive when the commit has
895 if (clean_message_contents
)
896 strbuf_stripspace(&sb
, 0);
899 append_signoff(&sb
, ignore_non_trailer(sb
.buf
, sb
.len
), 0);
901 if (fwrite(sb
.buf
, 1, sb
.len
, s
->fp
) < sb
.len
)
902 die_errno(_("could not write commit template"));
904 if (auto_comment_line_char
)
905 adjust_comment_line_char(&sb
);
908 /* This checks if committer ident is explicitly given */
909 strbuf_addstr(&committer_ident
, git_committer_info(IDENT_STRICT
));
910 if (use_editor
&& include_status
) {
912 int saved_color_setting
;
913 struct ident_split ci
, ai
;
914 const char *hint_cleanup_all
= allow_empty_message
?
915 _("Please enter the commit message for your changes."
916 " Lines starting\nwith '%c' will be ignored.\n") :
917 _("Please enter the commit message for your changes."
918 " Lines starting\nwith '%c' will be ignored, and an empty"
919 " message aborts the commit.\n");
920 const char *hint_cleanup_space
= allow_empty_message
?
921 _("Please enter the commit message for your changes."
923 "with '%c' will be kept; you may remove them"
924 " yourself if you want to.\n") :
925 _("Please enter the commit message for your changes."
927 "with '%c' will be kept; you may remove them"
928 " yourself if you want to.\n"
929 "An empty message aborts the commit.\n");
930 if (whence
!= FROM_COMMIT
) {
931 if (cleanup_mode
== COMMIT_MSG_CLEANUP_SCISSORS
&&
932 !merge_contains_scissors
)
933 wt_status_add_cut_line(s
->fp
);
936 whence
== FROM_MERGE
?
938 "It looks like you may be committing a merge.\n"
939 "If this is not correct, please run\n"
940 " git update-ref -d MERGE_HEAD\n"
941 "and try again.\n") :
943 "It looks like you may be committing a cherry-pick.\n"
944 "If this is not correct, please run\n"
945 " git update-ref -d CHERRY_PICK_HEAD\n"
946 "and try again.\n"));
949 fprintf(s
->fp
, "\n");
950 if (cleanup_mode
== COMMIT_MSG_CLEANUP_ALL
)
951 status_printf(s
, GIT_COLOR_NORMAL
, hint_cleanup_all
, comment_line_char
);
952 else if (cleanup_mode
== COMMIT_MSG_CLEANUP_SCISSORS
) {
953 if (whence
== FROM_COMMIT
&& !merge_contains_scissors
)
954 wt_status_add_cut_line(s
->fp
);
955 } else /* COMMIT_MSG_CLEANUP_SPACE, that is. */
956 status_printf(s
, GIT_COLOR_NORMAL
, hint_cleanup_space
, comment_line_char
);
959 * These should never fail because they come from our own
960 * fmt_ident. They may fail the sane_ident test, but we know
961 * that the name and mail pointers will at least be valid,
962 * which is enough for our tests and printing here.
964 assert_split_ident(&ai
, author_ident
);
965 assert_split_ident(&ci
, &committer_ident
);
967 if (ident_cmp(&ai
, &ci
))
968 status_printf_ln(s
, GIT_COLOR_NORMAL
,
970 "Author: %.*s <%.*s>"),
971 ident_shown
++ ? "" : "\n",
972 (int)(ai
.name_end
- ai
.name_begin
), ai
.name_begin
,
973 (int)(ai
.mail_end
- ai
.mail_begin
), ai
.mail_begin
);
975 if (author_date_is_interesting())
976 status_printf_ln(s
, GIT_COLOR_NORMAL
,
979 ident_shown
++ ? "" : "\n",
980 show_ident_date(&ai
, DATE_MODE(NORMAL
)));
982 if (!committer_ident_sufficiently_given())
983 status_printf_ln(s
, GIT_COLOR_NORMAL
,
985 "Committer: %.*s <%.*s>"),
986 ident_shown
++ ? "" : "\n",
987 (int)(ci
.name_end
- ci
.name_begin
), ci
.name_begin
,
988 (int)(ci
.mail_end
- ci
.mail_begin
), ci
.mail_begin
);
990 status_printf_ln(s
, GIT_COLOR_NORMAL
, "%s", ""); /* Add new line for clarity */
992 saved_color_setting
= s
->use_color
;
994 committable
= run_status(s
->fp
, index_file
, prefix
, 1, s
);
995 s
->use_color
= saved_color_setting
;
996 string_list_clear(&s
->change
, 1);
998 struct object_id oid
;
999 const char *parent
= "HEAD";
1001 if (!the_index
.cache_nr
) {
1002 discard_index(&the_index
);
1003 if (repo_read_index(the_repository
) < 0)
1004 die(_("Cannot read index"));
1010 if (repo_get_oid(the_repository
, parent
, &oid
)) {
1013 /* TODO: audit for interaction with sparse-index. */
1014 ensure_full_index(&the_index
);
1015 for (i
= 0; i
< the_index
.cache_nr
; i
++)
1016 if (ce_intent_to_add(the_index
.cache
[i
]))
1018 committable
= the_index
.cache_nr
- ita_nr
> 0;
1021 * Unless the user did explicitly request a submodule
1022 * ignore mode by passing a command line option we do
1023 * not ignore any changed submodule SHA-1s when
1024 * comparing index and parent, no matter what is
1025 * configured. Otherwise we won't commit any
1026 * submodules which were manually staged, which would
1027 * be really confusing.
1029 struct diff_flags flags
= DIFF_FLAGS_INIT
;
1030 flags
.override_submodule_config
= 1;
1031 if (ignore_submodule_arg
&&
1032 !strcmp(ignore_submodule_arg
, "all"))
1033 flags
.ignore_submodules
= 1;
1034 committable
= index_differs_from(the_repository
,
1038 strbuf_release(&committer_ident
);
1042 if (trailer_args
.nr
) {
1043 struct child_process run_trailer
= CHILD_PROCESS_INIT
;
1045 strvec_pushl(&run_trailer
.args
, "interpret-trailers",
1046 "--in-place", "--no-divider",
1047 git_path_commit_editmsg(), NULL
);
1048 strvec_pushv(&run_trailer
.args
, trailer_args
.v
);
1049 run_trailer
.git_cmd
= 1;
1050 if (run_command(&run_trailer
))
1051 die(_("unable to pass trailers to --trailers"));
1052 strvec_clear(&trailer_args
);
1056 * Reject an attempt to record a non-merge empty commit without
1057 * explicit --allow-empty. In the cherry-pick case, it may be
1058 * empty due to conflict resolution, which the user should okay.
1060 if (!committable
&& whence
!= FROM_MERGE
&& !allow_empty
&&
1061 !(amend
&& is_a_merge(current_head
))) {
1062 s
->hints
= advice_enabled(ADVICE_STATUS_HINTS
);
1063 s
->display_comment_prefix
= old_display_comment_prefix
;
1064 run_status(stdout
, index_file
, prefix
, 0, s
);
1066 fputs(_(empty_amend_advice
), stderr
);
1067 else if (is_from_cherry_pick(whence
) ||
1068 whence
== FROM_REBASE_PICK
) {
1069 fputs(_(empty_cherry_pick_advice
), stderr
);
1070 if (whence
== FROM_CHERRY_PICK_SINGLE
)
1071 fputs(_(empty_cherry_pick_advice_single
), stderr
);
1072 else if (whence
== FROM_CHERRY_PICK_MULTI
)
1073 fputs(_(empty_cherry_pick_advice_multi
), stderr
);
1075 fputs(_(empty_rebase_pick_advice
), stderr
);
1080 if (!no_verify
&& invoked_hook
) {
1082 * Re-read the index as the pre-commit-commit hook was invoked
1083 * and could have updated it. We must do this before we invoke
1084 * the editor and after we invoke run_status above.
1086 discard_index(&the_index
);
1088 read_index_from(&the_index
, index_file
, get_git_dir());
1090 if (cache_tree_update(&the_index
, 0)) {
1091 error(_("Error building trees"));
1095 if (run_commit_hook(use_editor
, index_file
, NULL
, "prepare-commit-msg",
1096 git_path_commit_editmsg(), hook_arg1
, hook_arg2
, NULL
))
1100 struct strvec env
= STRVEC_INIT
;
1102 strvec_pushf(&env
, "GIT_INDEX_FILE=%s", index_file
);
1103 if (launch_editor(git_path_commit_editmsg(), NULL
, env
.v
)) {
1105 _("Please supply the message using either -m or -F option.\n"));
1112 run_commit_hook(use_editor
, index_file
, NULL
, "commit-msg",
1113 git_path_commit_editmsg(), NULL
)) {
1120 static const char *find_author_by_nickname(const char *name
)
1122 struct rev_info revs
;
1123 struct commit
*commit
;
1124 struct strbuf buf
= STRBUF_INIT
;
1128 repo_init_revisions(the_repository
, &revs
, NULL
);
1129 strbuf_addf(&buf
, "--author=%s", name
);
1134 setup_revisions(ac
, av
, &revs
, NULL
);
1135 revs
.mailmap
= xmalloc(sizeof(struct string_list
));
1136 string_list_init_nodup(revs
.mailmap
);
1137 read_mailmap(revs
.mailmap
);
1139 if (prepare_revision_walk(&revs
))
1140 die(_("revision walk setup failed"));
1141 commit
= get_revision(&revs
);
1143 struct pretty_print_context ctx
= {0};
1144 ctx
.date_mode
.type
= DATE_NORMAL
;
1145 strbuf_release(&buf
);
1146 repo_format_commit_message(the_repository
, commit
,
1147 "%aN <%aE>", &buf
, &ctx
);
1148 release_revisions(&revs
);
1149 return strbuf_detach(&buf
, NULL
);
1151 die(_("--author '%s' is not 'Name <email>' and matches no existing author"), name
);
1154 static void handle_ignored_arg(struct wt_status
*s
)
1157 ; /* default already initialized */
1158 else if (!strcmp(ignored_arg
, "traditional"))
1159 s
->show_ignored_mode
= SHOW_TRADITIONAL_IGNORED
;
1160 else if (!strcmp(ignored_arg
, "no"))
1161 s
->show_ignored_mode
= SHOW_NO_IGNORED
;
1162 else if (!strcmp(ignored_arg
, "matching"))
1163 s
->show_ignored_mode
= SHOW_MATCHING_IGNORED
;
1165 die(_("Invalid ignored mode '%s'"), ignored_arg
);
1168 static void handle_untracked_files_arg(struct wt_status
*s
)
1170 if (!untracked_files_arg
)
1171 ; /* default already initialized */
1172 else if (!strcmp(untracked_files_arg
, "no"))
1173 s
->show_untracked_files
= SHOW_NO_UNTRACKED_FILES
;
1174 else if (!strcmp(untracked_files_arg
, "normal"))
1175 s
->show_untracked_files
= SHOW_NORMAL_UNTRACKED_FILES
;
1176 else if (!strcmp(untracked_files_arg
, "all"))
1177 s
->show_untracked_files
= SHOW_ALL_UNTRACKED_FILES
;
1179 * Please update $__git_untracked_file_modes in
1180 * git-completion.bash when you add new options
1183 die(_("Invalid untracked files mode '%s'"), untracked_files_arg
);
1186 static const char *read_commit_message(const char *name
)
1188 const char *out_enc
;
1189 struct commit
*commit
;
1191 commit
= lookup_commit_reference_by_name(name
);
1193 die(_("could not lookup commit '%s'"), name
);
1194 out_enc
= get_commit_output_encoding();
1195 return repo_logmsg_reencode(the_repository
, commit
, NULL
, out_enc
);
1199 * Enumerate what needs to be propagated when --porcelain
1200 * is not in effect here.
1202 static struct status_deferred_config
{
1203 enum wt_status_format status_format
;
1205 enum ahead_behind_flags ahead_behind
;
1206 } status_deferred_config
= {
1207 STATUS_FORMAT_UNSPECIFIED
,
1208 -1, /* unspecified */
1209 AHEAD_BEHIND_UNSPECIFIED
,
1212 static void finalize_deferred_config(struct wt_status
*s
)
1214 int use_deferred_config
= (status_format
!= STATUS_FORMAT_PORCELAIN
&&
1215 status_format
!= STATUS_FORMAT_PORCELAIN_V2
&&
1216 !s
->null_termination
);
1218 if (s
->null_termination
) {
1219 if (status_format
== STATUS_FORMAT_NONE
||
1220 status_format
== STATUS_FORMAT_UNSPECIFIED
)
1221 status_format
= STATUS_FORMAT_PORCELAIN
;
1222 else if (status_format
== STATUS_FORMAT_LONG
)
1223 die(_("options '%s' and '%s' cannot be used together"), "--long", "-z");
1226 if (use_deferred_config
&& status_format
== STATUS_FORMAT_UNSPECIFIED
)
1227 status_format
= status_deferred_config
.status_format
;
1228 if (status_format
== STATUS_FORMAT_UNSPECIFIED
)
1229 status_format
= STATUS_FORMAT_NONE
;
1231 if (use_deferred_config
&& s
->show_branch
< 0)
1232 s
->show_branch
= status_deferred_config
.show_branch
;
1233 if (s
->show_branch
< 0)
1237 * If the user did not give a "--[no]-ahead-behind" command
1238 * line argument *AND* we will print in a human-readable format
1239 * (short, long etc.) then we inherit from the status.aheadbehind
1240 * config setting. In all other cases (and porcelain V[12] formats
1241 * in particular), we inherit _FULL for backwards compatibility.
1243 if (use_deferred_config
&&
1244 s
->ahead_behind_flags
== AHEAD_BEHIND_UNSPECIFIED
)
1245 s
->ahead_behind_flags
= status_deferred_config
.ahead_behind
;
1247 if (s
->ahead_behind_flags
== AHEAD_BEHIND_UNSPECIFIED
)
1248 s
->ahead_behind_flags
= AHEAD_BEHIND_FULL
;
1251 static void check_fixup_reword_options(int argc
, const char *argv
[]) {
1252 if (whence
!= FROM_COMMIT
) {
1253 if (whence
== FROM_MERGE
)
1254 die(_("You are in the middle of a merge -- cannot reword."));
1255 else if (is_from_cherry_pick(whence
))
1256 die(_("You are in the middle of a cherry-pick -- cannot reword."));
1259 die(_("reword option of '%s' and path '%s' cannot be used together"), "--fixup", *argv
);
1260 if (patch_interactive
|| interactive
|| all
|| also
|| only
)
1261 die(_("reword option of '%s' and '%s' cannot be used together"),
1262 "--fixup", "--patch/--interactive/--all/--include/--only");
1265 static int parse_and_validate_options(int argc
, const char *argv
[],
1266 const struct option
*options
,
1267 const char * const usage
[],
1269 struct commit
*current_head
,
1270 struct wt_status
*s
)
1272 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
1273 finalize_deferred_config(s
);
1275 if (force_author
&& !strchr(force_author
, '>'))
1276 force_author
= find_author_by_nickname(force_author
);
1278 if (force_author
&& renew_authorship
)
1279 die(_("options '%s' and '%s' cannot be used together"), "--reset-author", "--author");
1281 if (logfile
|| have_option_m
|| use_message
)
1284 /* Sanity check options */
1285 if (amend
&& !current_head
)
1286 die(_("You have nothing to amend."));
1287 if (amend
&& whence
!= FROM_COMMIT
) {
1288 if (whence
== FROM_MERGE
)
1289 die(_("You are in the middle of a merge -- cannot amend."));
1290 else if (is_from_cherry_pick(whence
))
1291 die(_("You are in the middle of a cherry-pick -- cannot amend."));
1292 else if (whence
== FROM_REBASE_PICK
)
1293 die(_("You are in the middle of a rebase -- cannot amend."));
1295 if (fixup_message
&& squash_message
)
1296 die(_("options '%s' and '%s' cannot be used together"), "--squash", "--fixup");
1297 die_for_incompatible_opt4(!!use_message
, "-C",
1298 !!edit_message
, "-c",
1300 !!fixup_message
, "--fixup");
1301 die_for_incompatible_opt4(have_option_m
, "-m",
1302 !!edit_message
, "-c",
1303 !!use_message
, "-C",
1305 if (use_message
|| edit_message
|| logfile
||fixup_message
|| have_option_m
)
1306 template_file
= NULL
;
1308 use_message
= edit_message
;
1309 if (amend
&& !use_message
&& !fixup_message
)
1310 use_message
= "HEAD";
1311 if (!use_message
&& !is_from_cherry_pick(whence
) &&
1312 !is_from_rebase(whence
) && renew_authorship
)
1313 die(_("--reset-author can be used only with -C, -c or --amend."));
1315 use_message_buffer
= read_commit_message(use_message
);
1316 if (!renew_authorship
) {
1317 author_message
= use_message
;
1318 author_message_buffer
= use_message_buffer
;
1321 if ((is_from_cherry_pick(whence
) || whence
== FROM_REBASE_PICK
) &&
1322 !renew_authorship
) {
1323 author_message
= "CHERRY_PICK_HEAD";
1324 author_message_buffer
= read_commit_message(author_message
);
1327 if (patch_interactive
)
1330 die_for_incompatible_opt4(also
, "-i/--include",
1333 interactive
, "--interactive/-p/--patch");
1334 if (fixup_message
) {
1336 * We limit --fixup's suboptions to only alpha characters.
1337 * If the first character after a run of alpha is colon,
1338 * then the part before the colon may be a known suboption
1339 * name like `amend` or `reword`, or a misspelt suboption
1340 * name. In either case, we treat it as
1341 * --fixup=<suboption>:<arg>.
1343 * Otherwise, we are dealing with --fixup=<commit>.
1345 char *p
= fixup_message
;
1348 if (p
> fixup_message
&& *p
== ':') {
1350 fixup_commit
= p
+ 1;
1351 if (!strcmp("amend", fixup_message
) ||
1352 !strcmp("reword", fixup_message
)) {
1353 fixup_prefix
= "amend";
1355 if (*fixup_message
== 'r') {
1356 check_fixup_reword_options(argc
, argv
);
1360 die(_("unknown option: --fixup=%s:%s"), fixup_message
, fixup_commit
);
1363 fixup_commit
= fixup_message
;
1364 fixup_prefix
= "fixup";
1370 use_editor
= edit_flag
;
1372 cleanup_mode
= get_cleanup_mode(cleanup_arg
, use_editor
);
1374 handle_untracked_files_arg(s
);
1376 if (all
&& argc
> 0)
1377 die(_("paths '%s ...' with -a does not make sense"),
1380 if (status_format
!= STATUS_FORMAT_NONE
)
1386 static int dry_run_commit(const char **argv
, const char *prefix
,
1387 const struct commit
*current_head
, struct wt_status
*s
)
1390 const char *index_file
;
1392 index_file
= prepare_index(argv
, prefix
, current_head
, 1);
1393 committable
= run_status(stdout
, index_file
, prefix
, 0, s
);
1394 rollback_index_files();
1396 return committable
? 0 : 1;
1399 define_list_config_array_extra(color_status_slots
, {"added"});
1401 static int parse_status_slot(const char *slot
)
1403 if (!strcasecmp(slot
, "added"))
1404 return WT_STATUS_UPDATED
;
1406 return LOOKUP_CONFIG(color_status_slots
, slot
);
1409 static int git_status_config(const char *k
, const char *v
, void *cb
)
1411 struct wt_status
*s
= cb
;
1412 const char *slot_name
;
1414 if (starts_with(k
, "column."))
1415 return git_column_config(k
, v
, "status", &s
->colopts
);
1416 if (!strcmp(k
, "status.submodulesummary")) {
1418 s
->submodule_summary
= git_config_bool_or_int(k
, v
, &is_bool
);
1419 if (is_bool
&& s
->submodule_summary
)
1420 s
->submodule_summary
= -1;
1423 if (!strcmp(k
, "status.short")) {
1424 if (git_config_bool(k
, v
))
1425 status_deferred_config
.status_format
= STATUS_FORMAT_SHORT
;
1427 status_deferred_config
.status_format
= STATUS_FORMAT_NONE
;
1430 if (!strcmp(k
, "status.branch")) {
1431 status_deferred_config
.show_branch
= git_config_bool(k
, v
);
1434 if (!strcmp(k
, "status.aheadbehind")) {
1435 status_deferred_config
.ahead_behind
= git_config_bool(k
, v
);
1438 if (!strcmp(k
, "status.showstash")) {
1439 s
->show_stash
= git_config_bool(k
, v
);
1442 if (!strcmp(k
, "status.color") || !strcmp(k
, "color.status")) {
1443 s
->use_color
= git_config_colorbool(k
, v
);
1446 if (!strcmp(k
, "status.displaycommentprefix")) {
1447 s
->display_comment_prefix
= git_config_bool(k
, v
);
1450 if (skip_prefix(k
, "status.color.", &slot_name
) ||
1451 skip_prefix(k
, "color.status.", &slot_name
)) {
1452 int slot
= parse_status_slot(slot_name
);
1456 return config_error_nonbool(k
);
1457 return color_parse(v
, s
->color_palette
[slot
]);
1459 if (!strcmp(k
, "status.relativepaths")) {
1460 s
->relative_paths
= git_config_bool(k
, v
);
1463 if (!strcmp(k
, "status.showuntrackedfiles")) {
1465 return config_error_nonbool(k
);
1466 else if (!strcmp(v
, "no"))
1467 s
->show_untracked_files
= SHOW_NO_UNTRACKED_FILES
;
1468 else if (!strcmp(v
, "normal"))
1469 s
->show_untracked_files
= SHOW_NORMAL_UNTRACKED_FILES
;
1470 else if (!strcmp(v
, "all"))
1471 s
->show_untracked_files
= SHOW_ALL_UNTRACKED_FILES
;
1473 return error(_("Invalid untracked files mode '%s'"), v
);
1476 if (!strcmp(k
, "diff.renamelimit")) {
1477 if (s
->rename_limit
== -1)
1478 s
->rename_limit
= git_config_int(k
, v
);
1481 if (!strcmp(k
, "status.renamelimit")) {
1482 s
->rename_limit
= git_config_int(k
, v
);
1485 if (!strcmp(k
, "diff.renames")) {
1486 if (s
->detect_rename
== -1)
1487 s
->detect_rename
= git_config_rename(k
, v
);
1490 if (!strcmp(k
, "status.renames")) {
1491 s
->detect_rename
= git_config_rename(k
, v
);
1494 return git_diff_ui_config(k
, v
, NULL
);
1497 int cmd_status(int argc
, const char **argv
, const char *prefix
)
1499 static int no_renames
= -1;
1500 static const char *rename_score_arg
= (const char *)-1;
1501 static struct wt_status s
;
1502 unsigned int progress_flag
= 0;
1504 struct object_id oid
;
1505 static struct option builtin_status_options
[] = {
1506 OPT__VERBOSE(&verbose
, N_("be verbose")),
1507 OPT_SET_INT('s', "short", &status_format
,
1508 N_("show status concisely"), STATUS_FORMAT_SHORT
),
1509 OPT_BOOL('b', "branch", &s
.show_branch
,
1510 N_("show branch information")),
1511 OPT_BOOL(0, "show-stash", &s
.show_stash
,
1512 N_("show stash information")),
1513 OPT_BOOL(0, "ahead-behind", &s
.ahead_behind_flags
,
1514 N_("compute full ahead/behind values")),
1515 OPT_CALLBACK_F(0, "porcelain", &status_format
,
1516 N_("version"), N_("machine-readable output"),
1517 PARSE_OPT_OPTARG
, opt_parse_porcelain
),
1518 OPT_SET_INT(0, "long", &status_format
,
1519 N_("show status in long format (default)"),
1520 STATUS_FORMAT_LONG
),
1521 OPT_BOOL('z', "null", &s
.null_termination
,
1522 N_("terminate entries with NUL")),
1523 { OPTION_STRING
, 'u', "untracked-files", &untracked_files_arg
,
1525 N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1526 PARSE_OPT_OPTARG
, NULL
, (intptr_t)"all" },
1527 { OPTION_STRING
, 0, "ignored", &ignored_arg
,
1529 N_("show ignored files, optional modes: traditional, matching, no. (Default: traditional)"),
1530 PARSE_OPT_OPTARG
, NULL
, (intptr_t)"traditional" },
1531 { OPTION_STRING
, 0, "ignore-submodules", &ignore_submodule_arg
, N_("when"),
1532 N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
1533 PARSE_OPT_OPTARG
, NULL
, (intptr_t)"all" },
1534 OPT_COLUMN(0, "column", &s
.colopts
, N_("list untracked files in columns")),
1535 OPT_BOOL(0, "no-renames", &no_renames
, N_("do not detect renames")),
1536 OPT_CALLBACK_F('M', "find-renames", &rename_score_arg
,
1537 N_("n"), N_("detect renames, optionally set similarity index"),
1538 PARSE_OPT_OPTARG
| PARSE_OPT_NONEG
, opt_parse_rename_score
),
1542 if (argc
== 2 && !strcmp(argv
[1], "-h"))
1543 usage_with_options(builtin_status_usage
, builtin_status_options
);
1545 prepare_repo_settings(the_repository
);
1546 the_repository
->settings
.command_requires_full_index
= 0;
1548 status_init_config(&s
, git_status_config
);
1549 argc
= parse_options(argc
, argv
, prefix
,
1550 builtin_status_options
,
1551 builtin_status_usage
, 0);
1552 finalize_colopts(&s
.colopts
, -1);
1553 finalize_deferred_config(&s
);
1555 handle_untracked_files_arg(&s
);
1556 handle_ignored_arg(&s
);
1558 if (s
.show_ignored_mode
== SHOW_MATCHING_IGNORED
&&
1559 s
.show_untracked_files
== SHOW_NO_UNTRACKED_FILES
)
1560 die(_("Unsupported combination of ignored and untracked-files arguments"));
1562 parse_pathspec(&s
.pathspec
, 0,
1563 PATHSPEC_PREFER_FULL
,
1566 if (status_format
!= STATUS_FORMAT_PORCELAIN
&&
1567 status_format
!= STATUS_FORMAT_PORCELAIN_V2
)
1568 progress_flag
= REFRESH_PROGRESS
;
1569 repo_read_index(the_repository
);
1570 refresh_index(&the_index
,
1571 REFRESH_QUIET
|REFRESH_UNMERGED
|progress_flag
,
1572 &s
.pathspec
, NULL
, NULL
);
1574 if (use_optional_locks())
1575 fd
= repo_hold_locked_index(the_repository
, &index_lock
, 0);
1579 s
.is_initial
= repo_get_oid(the_repository
, s
.reference
, &oid
) ? 1 : 0;
1581 oidcpy(&s
.oid_commit
, &oid
);
1583 s
.ignore_submodule_arg
= ignore_submodule_arg
;
1584 s
.status_format
= status_format
;
1585 s
.verbose
= verbose
;
1586 if (no_renames
!= -1)
1587 s
.detect_rename
= !no_renames
;
1588 if ((intptr_t)rename_score_arg
!= -1) {
1589 if (s
.detect_rename
< DIFF_DETECT_RENAME
)
1590 s
.detect_rename
= DIFF_DETECT_RENAME
;
1591 if (rename_score_arg
)
1592 s
.rename_score
= parse_rename_score(&rename_score_arg
);
1595 wt_status_collect(&s
);
1598 repo_update_index_if_able(the_repository
, &index_lock
);
1600 if (s
.relative_paths
)
1603 wt_status_print(&s
);
1604 wt_status_collect_free_buffers(&s
);
1609 static int git_commit_config(const char *k
, const char *v
, void *cb
)
1611 struct wt_status
*s
= cb
;
1613 if (!strcmp(k
, "commit.template"))
1614 return git_config_pathname(&template_file
, k
, v
);
1615 if (!strcmp(k
, "commit.status")) {
1616 include_status
= git_config_bool(k
, v
);
1619 if (!strcmp(k
, "commit.cleanup"))
1620 return git_config_string(&cleanup_arg
, k
, v
);
1621 if (!strcmp(k
, "commit.gpgsign")) {
1622 sign_commit
= git_config_bool(k
, v
) ? "" : NULL
;
1625 if (!strcmp(k
, "commit.verbose")) {
1627 config_commit_verbose
= git_config_bool_or_int(k
, v
, &is_bool
);
1631 return git_status_config(k
, v
, s
);
1634 int cmd_commit(int argc
, const char **argv
, const char *prefix
)
1636 static struct wt_status s
;
1637 static struct option builtin_commit_options
[] = {
1638 OPT__QUIET(&quiet
, N_("suppress summary after successful commit")),
1639 OPT__VERBOSE(&verbose
, N_("show diff in commit message template")),
1641 OPT_GROUP(N_("Commit message options")),
1642 OPT_FILENAME('F', "file", &logfile
, N_("read message from file")),
1643 OPT_STRING(0, "author", &force_author
, N_("author"), N_("override author for commit")),
1644 OPT_STRING(0, "date", &force_date
, N_("date"), N_("override date for commit")),
1645 OPT_CALLBACK('m', "message", &message
, N_("message"), N_("commit message"), opt_parse_m
),
1646 OPT_STRING('c', "reedit-message", &edit_message
, N_("commit"), N_("reuse and edit message from specified commit")),
1647 OPT_STRING('C', "reuse-message", &use_message
, N_("commit"), N_("reuse message from specified commit")),
1649 * TRANSLATORS: Leave "[(amend|reword):]" as-is,
1650 * and only translate <commit>.
1652 OPT_STRING(0, "fixup", &fixup_message
, N_("[(amend|reword):]commit"), N_("use autosquash formatted message to fixup or amend/reword specified commit")),
1653 OPT_STRING(0, "squash", &squash_message
, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
1654 OPT_BOOL(0, "reset-author", &renew_authorship
, N_("the commit is authored by me now (used with -C/-c/--amend)")),
1655 OPT_CALLBACK_F(0, "trailer", &trailer_args
, N_("trailer"), N_("add custom trailer(s)"), PARSE_OPT_NONEG
, opt_pass_trailer
),
1656 OPT_BOOL('s', "signoff", &signoff
, N_("add a Signed-off-by trailer")),
1657 OPT_FILENAME('t', "template", &template_file
, N_("use specified template file")),
1658 OPT_BOOL('e', "edit", &edit_flag
, N_("force edit of commit")),
1659 OPT_CLEANUP(&cleanup_arg
),
1660 OPT_BOOL(0, "status", &include_status
, N_("include status in commit message template")),
1661 { OPTION_STRING
, 'S', "gpg-sign", &sign_commit
, N_("key-id"),
1662 N_("GPG sign commit"), PARSE_OPT_OPTARG
, NULL
, (intptr_t) "" },
1663 /* end commit message options */
1665 OPT_GROUP(N_("Commit contents options")),
1666 OPT_BOOL('a', "all", &all
, N_("commit all changed files")),
1667 OPT_BOOL('i', "include", &also
, N_("add specified files to index for commit")),
1668 OPT_BOOL(0, "interactive", &interactive
, N_("interactively add files")),
1669 OPT_BOOL('p', "patch", &patch_interactive
, N_("interactively add changes")),
1670 OPT_BOOL('o', "only", &only
, N_("commit only specified files")),
1671 OPT_BOOL('n', "no-verify", &no_verify
, N_("bypass pre-commit and commit-msg hooks")),
1672 OPT_BOOL(0, "dry-run", &dry_run
, N_("show what would be committed")),
1673 OPT_SET_INT(0, "short", &status_format
, N_("show status concisely"),
1674 STATUS_FORMAT_SHORT
),
1675 OPT_BOOL(0, "branch", &s
.show_branch
, N_("show branch information")),
1676 OPT_BOOL(0, "ahead-behind", &s
.ahead_behind_flags
,
1677 N_("compute full ahead/behind values")),
1678 OPT_SET_INT(0, "porcelain", &status_format
,
1679 N_("machine-readable output"), STATUS_FORMAT_PORCELAIN
),
1680 OPT_SET_INT(0, "long", &status_format
,
1681 N_("show status in long format (default)"),
1682 STATUS_FORMAT_LONG
),
1683 OPT_BOOL('z', "null", &s
.null_termination
,
1684 N_("terminate entries with NUL")),
1685 OPT_BOOL(0, "amend", &amend
, N_("amend previous commit")),
1686 OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite
, N_("bypass post-rewrite hook")),
1687 { 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" },
1688 OPT_PATHSPEC_FROM_FILE(&pathspec_from_file
),
1689 OPT_PATHSPEC_FILE_NUL(&pathspec_file_nul
),
1690 /* end commit contents options */
1692 OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty
,
1693 N_("ok to record an empty change")),
1694 OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message
,
1695 N_("ok to record a change with an empty message")),
1700 struct strbuf sb
= STRBUF_INIT
;
1701 struct strbuf author_ident
= STRBUF_INIT
;
1702 const char *index_file
, *reflog_msg
;
1703 struct object_id oid
;
1704 struct commit_list
*parents
= NULL
;
1705 struct stat statbuf
;
1706 struct commit
*current_head
= NULL
;
1707 struct commit_extra_header
*extra
= NULL
;
1708 struct strbuf err
= STRBUF_INIT
;
1711 if (argc
== 2 && !strcmp(argv
[1], "-h"))
1712 usage_with_options(builtin_commit_usage
, builtin_commit_options
);
1714 prepare_repo_settings(the_repository
);
1715 the_repository
->settings
.command_requires_full_index
= 0;
1717 status_init_config(&s
, git_commit_config
);
1718 s
.commit_template
= 1;
1719 status_format
= STATUS_FORMAT_NONE
; /* Ignore status.short */
1722 if (repo_get_oid(the_repository
, "HEAD", &oid
))
1723 current_head
= NULL
;
1725 current_head
= lookup_commit_or_die(&oid
, "HEAD");
1726 if (repo_parse_commit(the_repository
, current_head
))
1727 die(_("could not parse HEAD commit"));
1729 verbose
= -1; /* unspecified */
1730 argc
= parse_and_validate_options(argc
, argv
, builtin_commit_options
,
1731 builtin_commit_usage
,
1732 prefix
, current_head
, &s
);
1734 verbose
= (config_commit_verbose
< 0) ? 0 : config_commit_verbose
;
1737 return dry_run_commit(argv
, prefix
, current_head
, &s
);
1738 index_file
= prepare_index(argv
, prefix
, current_head
, 0);
1740 /* Set up everything for writing the commit object. This includes
1741 running hooks, writing the trees, and interacting with the user. */
1742 if (!prepare_to_commit(index_file
, prefix
,
1743 current_head
, &s
, &author_ident
)) {
1745 rollback_index_files();
1749 /* Determine parents */
1750 reflog_msg
= getenv("GIT_REFLOG_ACTION");
1751 if (!current_head
) {
1753 reflog_msg
= "commit (initial)";
1756 reflog_msg
= "commit (amend)";
1757 parents
= copy_commit_list(current_head
->parents
);
1758 } else if (whence
== FROM_MERGE
) {
1759 struct strbuf m
= STRBUF_INIT
;
1761 int allow_fast_forward
= 1;
1762 struct commit_list
**pptr
= &parents
;
1765 reflog_msg
= "commit (merge)";
1766 pptr
= commit_list_append(current_head
, pptr
);
1767 fp
= xfopen(git_path_merge_head(the_repository
), "r");
1768 while (strbuf_getline_lf(&m
, fp
) != EOF
) {
1769 struct commit
*parent
;
1771 parent
= get_merge_parent(m
.buf
);
1773 die(_("Corrupt MERGE_HEAD file (%s)"), m
.buf
);
1774 pptr
= commit_list_append(parent
, pptr
);
1778 if (!stat(git_path_merge_mode(the_repository
), &statbuf
)) {
1779 if (strbuf_read_file(&sb
, git_path_merge_mode(the_repository
), 0) < 0)
1780 die_errno(_("could not read MERGE_MODE"));
1781 if (!strcmp(sb
.buf
, "no-ff"))
1782 allow_fast_forward
= 0;
1784 if (allow_fast_forward
)
1785 reduce_heads_replace(&parents
);
1788 reflog_msg
= is_from_cherry_pick(whence
)
1789 ? "commit (cherry-pick)"
1790 : is_from_rebase(whence
)
1793 commit_list_insert(current_head
, &parents
);
1796 /* Finally, get the commit message */
1798 if (strbuf_read_file(&sb
, git_path_commit_editmsg(), 0) < 0) {
1799 int saved_errno
= errno
;
1800 rollback_index_files();
1801 die(_("could not read commit message: %s"), strerror(saved_errno
));
1804 cleanup_message(&sb
, cleanup_mode
, verbose
);
1806 if (message_is_empty(&sb
, cleanup_mode
) && !allow_empty_message
) {
1807 rollback_index_files();
1808 fprintf(stderr
, _("Aborting commit due to empty commit message.\n"));
1811 if (template_untouched(&sb
, template_file
, cleanup_mode
) && !allow_empty_message
) {
1812 rollback_index_files();
1813 fprintf(stderr
, _("Aborting commit; you did not edit the message.\n"));
1817 if (fixup_message
&& starts_with(sb
.buf
, "amend! ") &&
1818 !allow_empty_message
) {
1819 struct strbuf body
= STRBUF_INIT
;
1820 size_t len
= commit_subject_length(sb
.buf
);
1821 strbuf_addstr(&body
, sb
.buf
+ len
);
1822 if (message_is_empty(&body
, cleanup_mode
)) {
1823 rollback_index_files();
1824 fprintf(stderr
, _("Aborting commit due to empty commit message body.\n"));
1827 strbuf_release(&body
);
1831 const char *exclude_gpgsig
[3] = { "gpgsig", "gpgsig-sha256", NULL
};
1832 extra
= read_commit_extra_headers(current_head
, exclude_gpgsig
);
1834 struct commit_extra_header
**tail
= &extra
;
1835 append_merge_tag_headers(parents
, &tail
);
1838 if (commit_tree_extended(sb
.buf
, sb
.len
, &the_index
.cache_tree
->oid
,
1839 parents
, &oid
, author_ident
.buf
, NULL
,
1840 sign_commit
, extra
)) {
1841 rollback_index_files();
1842 die(_("failed to write commit object"));
1844 free_commit_extra_headers(extra
);
1846 if (update_head_with_reflog(current_head
, &oid
, reflog_msg
, &sb
,
1848 rollback_index_files();
1852 sequencer_post_commit_cleanup(the_repository
, 0);
1853 unlink(git_path_merge_head(the_repository
));
1854 unlink(git_path_merge_msg(the_repository
));
1855 unlink(git_path_merge_mode(the_repository
));
1856 unlink(git_path_squash_msg(the_repository
));
1858 if (commit_index_files())
1859 die(_("repository has been updated, but unable to write\n"
1860 "new_index file. Check that disk is not full and quota is\n"
1861 "not exceeded, and then \"git restore --staged :/\" to recover."));
1863 git_test_write_commit_graph_or_die();
1865 repo_rerere(the_repository
, 0);
1866 run_auto_maintenance(quiet
);
1867 run_commit_hook(use_editor
, get_index_file(), NULL
, "post-commit",
1869 if (amend
&& !no_post_rewrite
) {
1870 commit_post_rewrite(the_repository
, current_head
, &oid
);
1873 unsigned int flags
= 0;
1876 flags
|= SUMMARY_INITIAL_COMMIT
;
1877 if (author_date_is_interesting())
1878 flags
|= SUMMARY_SHOW_AUTHOR_DATE
;
1879 print_commit_summary(the_repository
, prefix
,
1883 apply_autostash(git_path_merge_autostash(the_repository
));
1886 strbuf_release(&author_ident
);
1887 strbuf_release(&err
);
1888 strbuf_release(&sb
);