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_REPOSITORY_VARIABLE
9 #define DISABLE_SIGN_COMPARE_WARNINGS
15 #include "cache-tree.h"
19 #include "environment.h"
24 #include "wt-status.h"
25 #include "run-command.h"
27 #include "object-name.h"
28 #include "parse-options.h"
30 #include "preload-index.h"
31 #include "read-cache.h"
32 #include "repository.h"
33 #include "string-list.h"
35 #include "unpack-trees.h"
37 #include "sequencer.h"
38 #include "sparse-index.h"
41 #include "commit-reach.h"
42 #include "commit-graph.h"
46 static const char * const builtin_commit_usage
[] = {
47 N_("git commit [-a | --interactive | --patch] [-s] [-v] [-u[<mode>]] [--amend]\n"
48 " [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>]\n"
49 " [-F <file> | -m <msg>] [--reset-author] [--allow-empty]\n"
50 " [--allow-empty-message] [--no-verify] [-e] [--author=<author>]\n"
51 " [--date=<date>] [--cleanup=<mode>] [--[no-]status]\n"
52 " [-i | -o] [--pathspec-from-file=<file> [--pathspec-file-nul]]\n"
53 " [(--trailer <token>[(=|:)<value>])...] [-S[<keyid>]]\n"
54 " [--] [<pathspec>...]"),
58 static const char * const builtin_status_usage
[] = {
59 N_("git status [<options>] [--] [<pathspec>...]"),
63 static const char empty_amend_advice
[] =
64 N_("You asked to amend the most recent commit, but doing so would make\n"
65 "it empty. You can repeat your command with --allow-empty, or you can\n"
66 "remove the commit entirely with \"git reset HEAD^\".\n");
68 static const char empty_cherry_pick_advice
[] =
69 N_("The previous cherry-pick is now empty, possibly due to conflict resolution.\n"
70 "If you wish to commit it anyway, use:\n"
72 " git commit --allow-empty\n"
75 static const char empty_rebase_pick_advice
[] =
76 N_("Otherwise, please use 'git rebase --skip'\n");
78 static const char empty_cherry_pick_advice_single
[] =
79 N_("Otherwise, please use 'git cherry-pick --skip'\n");
81 static const char empty_cherry_pick_advice_multi
[] =
84 " git cherry-pick --continue\n"
86 "to resume cherry-picking the remaining commits.\n"
87 "If you wish to skip this commit, use:\n"
89 " git cherry-pick --skip\n"
92 static const char *color_status_slots
[] = {
93 [WT_STATUS_HEADER
] = "header",
94 [WT_STATUS_UPDATED
] = "updated",
95 [WT_STATUS_CHANGED
] = "changed",
96 [WT_STATUS_UNTRACKED
] = "untracked",
97 [WT_STATUS_NOBRANCH
] = "noBranch",
98 [WT_STATUS_UNMERGED
] = "unmerged",
99 [WT_STATUS_LOCAL_BRANCH
] = "localBranch",
100 [WT_STATUS_REMOTE_BRANCH
] = "remoteBranch",
101 [WT_STATUS_ONBRANCH
] = "branch",
104 static const char *use_message_buffer
;
105 static struct lock_file index_lock
; /* real index */
106 static struct lock_file false_lock
; /* used only for partial commits */
113 static const char *force_author
;
114 static char *logfile
;
115 static 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 const 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 const char *untracked_files_arg
, *force_date
, *ignore_submodule_arg
, *ignored_arg
;
130 static const 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 char *cleanup_config
;
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_parse_porcelain(const struct option
*opt
, const char *arg
, int unset
)
152 enum wt_status_format
*value
= (enum wt_status_format
*)opt
->value
;
154 *value
= STATUS_FORMAT_NONE
;
156 *value
= STATUS_FORMAT_PORCELAIN
;
157 else if (!strcmp(arg
, "v1") || !strcmp(arg
, "1"))
158 *value
= STATUS_FORMAT_PORCELAIN
;
159 else if (!strcmp(arg
, "v2") || !strcmp(arg
, "2"))
160 *value
= STATUS_FORMAT_PORCELAIN_V2
;
162 die("unsupported porcelain version '%s'", arg
);
167 static int opt_parse_m(const struct option
*opt
, const char *arg
, int unset
)
169 struct strbuf
*buf
= opt
->value
;
172 strbuf_setlen(buf
, 0);
176 strbuf_addch(buf
, '\n');
177 strbuf_addstr(buf
, arg
);
178 strbuf_complete_line(buf
);
183 static int opt_parse_rename_score(const struct option
*opt
, const char *arg
, int unset
)
185 const char **value
= opt
->value
;
187 BUG_ON_OPT_NEG(unset
);
189 if (arg
!= NULL
&& *arg
== '=')
196 static void determine_whence(struct wt_status
*s
)
198 if (file_exists(git_path_merge_head(the_repository
)))
200 else if (!sequencer_determine_whence(the_repository
, &whence
))
201 whence
= FROM_COMMIT
;
206 static void status_init_config(struct wt_status
*s
, config_fn_t fn
)
208 wt_status_prepare(the_repository
, s
);
209 init_diff_ui_defaults();
212 s
->hints
= advice_enabled(ADVICE_STATUS_HINTS
); /* must come after git_config() */
215 static void rollback_index_files(void)
217 switch (commit_style
) {
219 break; /* nothing to do */
221 rollback_lock_file(&index_lock
);
224 rollback_lock_file(&index_lock
);
225 rollback_lock_file(&false_lock
);
230 static int commit_index_files(void)
234 switch (commit_style
) {
236 break; /* nothing to do */
238 err
= commit_lock_file(&index_lock
);
241 err
= commit_lock_file(&index_lock
);
242 rollback_lock_file(&false_lock
);
250 * Take a union of paths in the index and the named tree (typically, "HEAD"),
251 * and return the paths that match the given pattern in list.
253 static int list_paths(struct string_list
*list
, const char *with_tree
,
254 const struct pathspec
*pattern
)
262 m
= xcalloc(1, pattern
->nr
);
265 char *max_prefix
= common_prefix(pattern
);
266 overlay_tree_on_index(the_repository
->index
, with_tree
, max_prefix
);
270 /* TODO: audit for interaction with sparse-index. */
271 ensure_full_index(the_repository
->index
);
272 for (i
= 0; i
< the_repository
->index
->cache_nr
; i
++) {
273 const struct cache_entry
*ce
= the_repository
->index
->cache
[i
];
274 struct string_list_item
*item
;
276 if (ce
->ce_flags
& CE_UPDATE
)
278 if (!ce_path_match(the_repository
->index
, ce
, pattern
, m
))
280 item
= string_list_insert(list
, ce
->name
);
281 if (ce_skip_worktree(ce
))
282 item
->util
= item
; /* better a valid pointer than a fake one */
285 ret
= report_path_error(m
, pattern
);
290 static void add_remove_files(struct string_list
*list
)
293 for (i
= 0; i
< list
->nr
; i
++) {
295 struct string_list_item
*p
= &(list
->items
[i
]);
297 /* p->util is skip-worktree */
301 if (!lstat(p
->string
, &st
)) {
302 if (add_to_index(the_repository
->index
, p
->string
, &st
, 0))
303 die(_("updating files failed"));
305 remove_file_from_index(the_repository
->index
, p
->string
);
309 static void create_base_index(const struct commit
*current_head
)
312 struct unpack_trees_options opts
;
316 discard_index(the_repository
->index
);
320 memset(&opts
, 0, sizeof(opts
));
324 opts
.src_index
= the_repository
->index
;
325 opts
.dst_index
= the_repository
->index
;
327 opts
.fn
= oneway_merge
;
328 tree
= parse_tree_indirect(¤t_head
->object
.oid
);
330 die(_("failed to unpack HEAD tree object"));
331 if (parse_tree(tree
) < 0)
333 init_tree_desc(&t
, &tree
->object
.oid
, tree
->buffer
, tree
->size
);
334 if (unpack_trees(1, &t
, &opts
))
335 exit(128); /* We've already reported the error, finish dying */
338 static void refresh_cache_or_die(int refresh_flags
)
341 * refresh_flags contains REFRESH_QUIET, so the only errors
342 * are for unmerged entries.
344 if (refresh_index(the_repository
->index
, refresh_flags
| REFRESH_IN_PORCELAIN
, NULL
, NULL
, NULL
))
345 die_resolve_conflict("commit");
348 static const char *prepare_index(const char **argv
, const char *prefix
,
349 const struct commit
*current_head
, int is_status
)
351 struct string_list partial
= STRING_LIST_INIT_DUP
;
352 struct pathspec pathspec
;
353 int refresh_flags
= REFRESH_QUIET
;
358 refresh_flags
|= REFRESH_UNMERGED
;
359 parse_pathspec(&pathspec
, 0,
360 PATHSPEC_PREFER_FULL
,
363 if (pathspec_from_file
) {
365 die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "--interactive/--patch");
368 die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "-a");
371 die(_("'%s' and pathspec arguments cannot be used together"), "--pathspec-from-file");
373 parse_pathspec_file(&pathspec
, 0,
374 PATHSPEC_PREFER_FULL
,
375 prefix
, pathspec_from_file
, pathspec_file_nul
);
376 } else if (pathspec_file_nul
) {
377 die(_("the option '%s' requires '%s'"), "--pathspec-file-nul", "--pathspec-from-file");
380 if (!pathspec
.nr
&& (also
|| (only
&& !allow_empty
&&
381 (!amend
|| (fixup_message
&& strcmp(fixup_prefix
, "amend"))))))
382 die(_("No paths with --include/--only does not make sense."));
384 if (repo_read_index_preload(the_repository
, &pathspec
, 0) < 0)
385 die(_("index file corrupt"));
388 char *old_index_env
= NULL
, *old_repo_index_file
;
389 repo_hold_locked_index(the_repository
, &index_lock
,
392 refresh_cache_or_die(refresh_flags
);
394 if (write_locked_index(the_repository
->index
, &index_lock
, 0))
395 die(_("unable to create temporary index"));
397 old_repo_index_file
= the_repository
->index_file
;
398 the_repository
->index_file
=
399 (char *)get_lock_file_path(&index_lock
);
400 old_index_env
= xstrdup_or_null(getenv(INDEX_ENVIRONMENT
));
401 setenv(INDEX_ENVIRONMENT
, the_repository
->index_file
, 1);
403 if (interactive_add(the_repository
, argv
, prefix
, patch_interactive
) != 0)
404 die(_("interactive add failed"));
406 the_repository
->index_file
= old_repo_index_file
;
407 if (old_index_env
&& *old_index_env
)
408 setenv(INDEX_ENVIRONMENT
, old_index_env
, 1);
410 unsetenv(INDEX_ENVIRONMENT
);
411 FREE_AND_NULL(old_index_env
);
413 discard_index(the_repository
->index
);
414 read_index_from(the_repository
->index
, get_lock_file_path(&index_lock
),
415 repo_get_git_dir(the_repository
));
416 if (cache_tree_update(the_repository
->index
, WRITE_TREE_SILENT
) == 0) {
417 if (reopen_lock_file(&index_lock
) < 0)
418 die(_("unable to write index file"));
419 if (write_locked_index(the_repository
->index
, &index_lock
, 0))
420 die(_("unable to update temporary index"));
422 warning(_("Failed to update main cache tree"));
424 commit_style
= COMMIT_NORMAL
;
425 ret
= get_lock_file_path(&index_lock
);
430 * Non partial, non as-is commit.
432 * (1) get the real index;
433 * (2) update the_index as necessary;
434 * (3) write the_index out to the real index (still locked);
435 * (4) return the name of the locked index file.
437 * The caller should run hooks on the locked real index, and
438 * (A) if all goes well, commit the real index;
439 * (B) on failure, rollback the real index.
441 if (all
|| (also
&& pathspec
.nr
)) {
442 char *ps_matched
= xcalloc(pathspec
.nr
, 1);
443 repo_hold_locked_index(the_repository
, &index_lock
,
445 add_files_to_cache(the_repository
, also
? prefix
: NULL
,
446 &pathspec
, ps_matched
, 0, 0);
447 if (!all
&& report_path_error(ps_matched
, &pathspec
))
450 refresh_cache_or_die(refresh_flags
);
451 cache_tree_update(the_repository
->index
, WRITE_TREE_SILENT
);
452 if (write_locked_index(the_repository
->index
, &index_lock
, 0))
453 die(_("unable to write new index file"));
454 commit_style
= COMMIT_NORMAL
;
455 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_repository
->index
->cache_changed
474 || !cache_tree_fully_valid(the_repository
->index
->cache_tree
))
475 cache_tree_update(the_repository
->index
, WRITE_TREE_SILENT
);
476 if (write_locked_index(the_repository
->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
= repo_get_index_file(the_repository
);
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_repository
->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_repository
->index
, REFRESH_QUIET
, NULL
, NULL
, NULL
);
524 cache_tree_update(the_repository
->index
, WRITE_TREE_SILENT
);
525 if (write_locked_index(the_repository
->index
, &index_lock
, 0))
526 die(_("unable to write new index file"));
528 path
= repo_git_path(the_repository
, "next-index-%"PRIuMAX
,
529 (uintmax_t) getpid());
530 hold_lock_file_for_update(&false_lock
, path
,
533 create_base_index(current_head
);
534 add_remove_files(&partial
);
535 refresh_index(the_repository
->index
, REFRESH_QUIET
, NULL
, NULL
, NULL
);
537 if (write_locked_index(the_repository
->index
, &false_lock
, 0))
538 die(_("unable to write temporary index file"));
540 discard_index(the_repository
->index
);
541 ret
= get_lock_file_path(&false_lock
);
542 read_index_from(the_repository
->index
, ret
, repo_get_git_dir(the_repository
));
544 string_list_clear(&partial
, 0);
545 clear_pathspec(&pathspec
);
550 static int run_status(FILE *fp
, const char *index_file
, const char *prefix
, int nowarn
,
553 struct object_id oid
;
555 if (s
->relative_paths
)
560 s
->reference
= "HEAD^1";
562 s
->verbose
= verbose
;
563 s
->index_file
= index_file
;
566 s
->is_initial
= repo_get_oid(the_repository
, s
->reference
, &oid
) ? 1 : 0;
568 oidcpy(&s
->oid_commit
, &oid
);
569 s
->status_format
= status_format
;
570 s
->ignore_submodule_arg
= ignore_submodule_arg
;
572 wt_status_collect(s
);
574 wt_status_collect_free_buffers(s
);
576 return s
->committable
;
579 static int is_a_merge(const struct commit
*current_head
)
581 return !!(current_head
->parents
&& current_head
->parents
->next
);
584 static void assert_split_ident(struct ident_split
*id
, const struct strbuf
*buf
)
586 if (split_ident_line(id
, buf
->buf
, buf
->len
) || !id
->date_begin
)
587 BUG("unable to parse our own ident: %s", buf
->buf
);
590 static void export_one(const char *var
, const char *s
, const char *e
, int hack
)
592 struct strbuf buf
= STRBUF_INIT
;
594 strbuf_addch(&buf
, hack
);
595 strbuf_add(&buf
, s
, e
- s
);
596 setenv(var
, buf
.buf
, 1);
597 strbuf_release(&buf
);
600 static int parse_force_date(const char *in
, struct strbuf
*out
)
602 strbuf_addch(out
, '@');
604 if (parse_date(in
, out
) < 0) {
606 unsigned long t
= approxidate_careful(in
, &errors
);
609 strbuf_addf(out
, "%lu", t
);
615 static void set_ident_var(char **buf
, char *val
)
621 static void determine_author_info(struct strbuf
*author_ident
)
623 char *name
, *email
, *date
;
624 struct ident_split author
;
626 name
= xstrdup_or_null(getenv("GIT_AUTHOR_NAME"));
627 email
= xstrdup_or_null(getenv("GIT_AUTHOR_EMAIL"));
628 date
= xstrdup_or_null(getenv("GIT_AUTHOR_DATE"));
630 if (author_message
) {
631 struct ident_split ident
;
635 a
= find_commit_header(author_message_buffer
, "author", &len
);
637 die(_("commit '%s' lacks author header"), author_message
);
638 if (split_ident_line(&ident
, a
, len
) < 0)
639 die(_("commit '%s' has malformed author line"), author_message
);
641 set_ident_var(&name
, xmemdupz(ident
.name_begin
, ident
.name_end
- ident
.name_begin
));
642 set_ident_var(&email
, xmemdupz(ident
.mail_begin
, ident
.mail_end
- ident
.mail_begin
));
644 if (ident
.date_begin
) {
645 struct strbuf date_buf
= STRBUF_INIT
;
646 strbuf_addch(&date_buf
, '@');
647 strbuf_add(&date_buf
, ident
.date_begin
, ident
.date_end
- ident
.date_begin
);
648 strbuf_addch(&date_buf
, ' ');
649 strbuf_add(&date_buf
, ident
.tz_begin
, ident
.tz_end
- ident
.tz_begin
);
650 set_ident_var(&date
, strbuf_detach(&date_buf
, NULL
));
655 struct ident_split ident
;
657 if (split_ident_line(&ident
, force_author
, strlen(force_author
)) < 0)
658 die(_("malformed --author parameter"));
659 set_ident_var(&name
, xmemdupz(ident
.name_begin
, ident
.name_end
- ident
.name_begin
));
660 set_ident_var(&email
, xmemdupz(ident
.mail_begin
, ident
.mail_end
- ident
.mail_begin
));
664 struct strbuf date_buf
= STRBUF_INIT
;
665 if (parse_force_date(force_date
, &date_buf
))
666 die(_("invalid date format: %s"), force_date
);
667 set_ident_var(&date
, strbuf_detach(&date_buf
, NULL
));
670 strbuf_addstr(author_ident
, fmt_ident(name
, email
, WANT_AUTHOR_IDENT
, date
,
672 assert_split_ident(&author
, author_ident
);
673 export_one("GIT_AUTHOR_NAME", author
.name_begin
, author
.name_end
, 0);
674 export_one("GIT_AUTHOR_EMAIL", author
.mail_begin
, author
.mail_end
, 0);
675 export_one("GIT_AUTHOR_DATE", author
.date_begin
, author
.tz_end
, '@');
681 static int author_date_is_interesting(void)
683 return author_message
|| force_date
;
686 static void adjust_comment_line_char(const struct strbuf
*sb
)
688 char candidates
[] = "#;@!$%^&|:";
692 if (!memchr(sb
->buf
, candidates
[0], sb
->len
)) {
693 free(comment_line_str_to_free
);
694 comment_line_str
= comment_line_str_to_free
=
695 xstrfmt("%c", candidates
[0]);
700 candidate
= strchr(candidates
, *p
);
703 for (p
= sb
->buf
; *p
; p
++) {
704 if ((p
[0] == '\n' || p
[0] == '\r') && p
[1]) {
705 candidate
= strchr(candidates
, p
[1]);
711 for (p
= candidates
; *p
== ' '; p
++)
714 die(_("unable to select a comment character that is not used\n"
715 "in the current commit message"));
716 free(comment_line_str_to_free
);
717 comment_line_str
= comment_line_str_to_free
= xstrfmt("%c", *p
);
720 static void prepare_amend_commit(struct commit
*commit
, struct strbuf
*sb
,
721 struct pretty_print_context
*ctx
)
723 const char *buffer
, *subject
, *fmt
;
725 buffer
= repo_get_commit_buffer(the_repository
, commit
, NULL
);
726 find_commit_subject(buffer
, &subject
);
728 * If we amend the 'amend!' commit then we don't want to
729 * duplicate the subject line.
731 fmt
= starts_with(subject
, "amend!") ? "%b" : "%B";
732 repo_format_commit_message(the_repository
, commit
, fmt
, sb
, ctx
);
733 repo_unuse_commit_buffer(the_repository
, commit
, buffer
);
736 static void change_data_free(void *util
, const char *str UNUSED
)
738 struct wt_status_change_data
*d
= util
;
739 free(d
->rename_source
);
743 static int prepare_to_commit(const char *index_file
, const char *prefix
,
744 struct commit
*current_head
,
746 struct strbuf
*author_ident
)
749 struct strbuf committer_ident
= STRBUF_INIT
;
751 struct strbuf sb
= STRBUF_INIT
;
752 const char *hook_arg1
= NULL
;
753 const char *hook_arg2
= NULL
;
754 int clean_message_contents
= (cleanup_mode
!= COMMIT_MSG_CLEANUP_NONE
);
755 int old_display_comment_prefix
;
758 /* This checks and barfs if author is badly specified */
759 determine_author_info(author_ident
);
761 if (!no_verify
&& run_commit_hook(use_editor
, index_file
, &invoked_hook
,
765 if (squash_message
) {
767 * Insert the proper subject line before other commit
768 * message options add their content.
770 if (use_message
&& !strcmp(use_message
, squash_message
))
771 strbuf_addstr(&sb
, "squash! ");
773 struct pretty_print_context ctx
= {0};
775 c
= lookup_commit_reference_by_name(squash_message
);
777 die(_("could not lookup commit '%s'"), squash_message
);
778 ctx
.output_encoding
= get_commit_output_encoding();
779 repo_format_commit_message(the_repository
, c
,
780 "squash! %s\n\n", &sb
,
785 if (have_option_m
&& !fixup_message
) {
786 strbuf_addbuf(&sb
, &message
);
787 hook_arg1
= "message";
788 } else if (logfile
&& !strcmp(logfile
, "-")) {
790 fprintf(stderr
, _("(reading log message from standard input)\n"));
791 if (strbuf_read(&sb
, 0, 0) < 0)
792 die_errno(_("could not read log from standard input"));
793 hook_arg1
= "message";
794 } else if (logfile
) {
795 if (strbuf_read_file(&sb
, logfile
, 0) < 0)
796 die_errno(_("could not read log file '%s'"),
798 hook_arg1
= "message";
799 } else if (use_message
) {
801 buffer
= strstr(use_message_buffer
, "\n\n");
803 strbuf_addstr(&sb
, skip_blank_lines(buffer
+ 2));
804 hook_arg1
= "commit";
805 hook_arg2
= use_message
;
806 } else if (fixup_message
) {
807 struct pretty_print_context ctx
= {0};
808 struct commit
*commit
;
810 commit
= lookup_commit_reference_by_name(fixup_commit
);
812 die(_("could not lookup commit '%s'"), fixup_commit
);
813 ctx
.output_encoding
= get_commit_output_encoding();
814 fmt
= xstrfmt("%s! %%s\n\n", fixup_prefix
);
815 repo_format_commit_message(the_repository
, commit
, fmt
, &sb
,
818 hook_arg1
= "message";
821 * Only `-m` commit message option is checked here, as
822 * it supports `--fixup` to append the commit message.
824 * The other commit message options `-c`/`-C`/`-F` are
825 * incompatible with all the forms of `--fixup` and
826 * have already errored out while parsing the `git commit`
829 if (have_option_m
&& !strcmp(fixup_prefix
, "fixup"))
830 strbuf_addbuf(&sb
, &message
);
832 if (!strcmp(fixup_prefix
, "amend")) {
834 die(_("options '%s' and '%s:%s' cannot be used together"), "-m", "--fixup", fixup_message
);
835 prepare_amend_commit(commit
, &sb
, &ctx
);
837 } else if (!stat(git_path_merge_msg(the_repository
), &statbuf
)) {
838 size_t merge_msg_start
;
841 * prepend SQUASH_MSG here if it exists and a
842 * "merge --squash" was originally performed
844 if (!stat(git_path_squash_msg(the_repository
), &statbuf
)) {
845 if (strbuf_read_file(&sb
, git_path_squash_msg(the_repository
), 0) < 0)
846 die_errno(_("could not read SQUASH_MSG"));
847 hook_arg1
= "squash";
851 merge_msg_start
= sb
.len
;
852 if (strbuf_read_file(&sb
, git_path_merge_msg(the_repository
), 0) < 0)
853 die_errno(_("could not read MERGE_MSG"));
855 if (cleanup_mode
== COMMIT_MSG_CLEANUP_SCISSORS
&&
856 wt_status_locate_end(sb
.buf
+ merge_msg_start
,
857 sb
.len
- merge_msg_start
) <
858 sb
.len
- merge_msg_start
)
859 s
->added_cut_line
= 1;
860 } else if (!stat(git_path_squash_msg(the_repository
), &statbuf
)) {
861 if (strbuf_read_file(&sb
, git_path_squash_msg(the_repository
), 0) < 0)
862 die_errno(_("could not read SQUASH_MSG"));
863 hook_arg1
= "squash";
864 } else if (template_file
) {
865 if (strbuf_read_file(&sb
, template_file
, 0) < 0)
866 die_errno(_("could not read '%s'"), template_file
);
867 hook_arg1
= "template";
868 clean_message_contents
= 0;
872 * The remaining cases don't modify the template message, but
873 * just set the argument(s) to the prepare-commit-msg hook.
875 else if (whence
== FROM_MERGE
)
877 else if (is_from_cherry_pick(whence
) || whence
== FROM_REBASE_PICK
) {
878 hook_arg1
= "commit";
879 hook_arg2
= "CHERRY_PICK_HEAD";
882 if (squash_message
) {
884 * If squash_commit was used for the commit subject,
885 * then we're possibly hijacking other commit log options.
886 * Reset the hook args to tell the real story.
888 hook_arg1
= "message";
892 s
->fp
= fopen_for_writing(git_path_commit_editmsg());
894 die_errno(_("could not open '%s'"), git_path_commit_editmsg());
896 /* Ignore status.displayCommentPrefix: we do need comments in COMMIT_EDITMSG. */
897 old_display_comment_prefix
= s
->display_comment_prefix
;
898 s
->display_comment_prefix
= 1;
901 * Most hints are counter-productive when the commit has
906 if (clean_message_contents
)
907 strbuf_stripspace(&sb
, NULL
);
910 append_signoff(&sb
, ignored_log_message_bytes(sb
.buf
, sb
.len
), 0);
912 if (fwrite(sb
.buf
, 1, sb
.len
, s
->fp
) < sb
.len
)
913 die_errno(_("could not write commit template"));
915 if (auto_comment_line_char
)
916 adjust_comment_line_char(&sb
);
919 /* This checks if committer ident is explicitly given */
920 strbuf_addstr(&committer_ident
, git_committer_info(IDENT_STRICT
));
921 if (use_editor
&& include_status
) {
923 int saved_color_setting
;
924 struct ident_split ci
, ai
;
925 const char *hint_cleanup_all
= allow_empty_message
?
926 _("Please enter the commit message for your changes."
927 " Lines starting\nwith '%s' will be ignored.\n") :
928 _("Please enter the commit message for your changes."
929 " Lines starting\nwith '%s' will be ignored, and an empty"
930 " message aborts the commit.\n");
931 const char *hint_cleanup_space
= allow_empty_message
?
932 _("Please enter the commit message for your changes."
934 "with '%s' will be kept; you may remove them"
935 " yourself if you want to.\n") :
936 _("Please enter the commit message for your changes."
938 "with '%s' will be kept; you may remove them"
939 " yourself if you want to.\n"
940 "An empty message aborts the commit.\n");
941 if (whence
!= FROM_COMMIT
) {
942 if (cleanup_mode
== COMMIT_MSG_CLEANUP_SCISSORS
)
943 wt_status_add_cut_line(s
);
946 whence
== FROM_MERGE
?
948 "It looks like you may be committing a merge.\n"
949 "If this is not correct, please run\n"
950 " git update-ref -d MERGE_HEAD\n"
951 "and try again.\n") :
953 "It looks like you may be committing a cherry-pick.\n"
954 "If this is not correct, please run\n"
955 " git update-ref -d CHERRY_PICK_HEAD\n"
956 "and try again.\n"));
959 fprintf(s
->fp
, "\n");
960 if (cleanup_mode
== COMMIT_MSG_CLEANUP_ALL
)
961 status_printf(s
, GIT_COLOR_NORMAL
, hint_cleanup_all
, comment_line_str
);
962 else if (cleanup_mode
== COMMIT_MSG_CLEANUP_SCISSORS
) {
963 if (whence
== FROM_COMMIT
)
964 wt_status_add_cut_line(s
);
965 } else /* COMMIT_MSG_CLEANUP_SPACE, that is. */
966 status_printf(s
, GIT_COLOR_NORMAL
, hint_cleanup_space
, comment_line_str
);
969 * These should never fail because they come from our own
970 * fmt_ident. They may fail the sane_ident test, but we know
971 * that the name and mail pointers will at least be valid,
972 * which is enough for our tests and printing here.
974 assert_split_ident(&ai
, author_ident
);
975 assert_split_ident(&ci
, &committer_ident
);
977 if (ident_cmp(&ai
, &ci
))
978 status_printf_ln(s
, GIT_COLOR_NORMAL
,
980 "Author: %.*s <%.*s>"),
981 ident_shown
++ ? "" : "\n",
982 (int)(ai
.name_end
- ai
.name_begin
), ai
.name_begin
,
983 (int)(ai
.mail_end
- ai
.mail_begin
), ai
.mail_begin
);
985 if (author_date_is_interesting())
986 status_printf_ln(s
, GIT_COLOR_NORMAL
,
989 ident_shown
++ ? "" : "\n",
990 show_ident_date(&ai
, DATE_MODE(NORMAL
)));
992 if (!committer_ident_sufficiently_given())
993 status_printf_ln(s
, GIT_COLOR_NORMAL
,
995 "Committer: %.*s <%.*s>"),
996 ident_shown
++ ? "" : "\n",
997 (int)(ci
.name_end
- ci
.name_begin
), ci
.name_begin
,
998 (int)(ci
.mail_end
- ci
.mail_begin
), ci
.mail_begin
);
1000 status_printf_ln(s
, GIT_COLOR_NORMAL
, "%s", ""); /* Add new line for clarity */
1002 saved_color_setting
= s
->use_color
;
1004 committable
= run_status(s
->fp
, index_file
, prefix
, 1, s
);
1005 s
->use_color
= saved_color_setting
;
1006 string_list_clear_func(&s
->change
, change_data_free
);
1008 struct object_id oid
;
1009 const char *parent
= "HEAD";
1011 if (!the_repository
->index
->initialized
&& repo_read_index(the_repository
) < 0)
1012 die(_("Cannot read index"));
1017 if (repo_get_oid(the_repository
, parent
, &oid
)) {
1020 /* TODO: audit for interaction with sparse-index. */
1021 ensure_full_index(the_repository
->index
);
1022 for (i
= 0; i
< the_repository
->index
->cache_nr
; i
++)
1023 if (ce_intent_to_add(the_repository
->index
->cache
[i
]))
1025 committable
= the_repository
->index
->cache_nr
> ita_nr
;
1028 * Unless the user did explicitly request a submodule
1029 * ignore mode by passing a command line option we do
1030 * not ignore any changed submodule SHA-1s when
1031 * comparing index and parent, no matter what is
1032 * configured. Otherwise we won't commit any
1033 * submodules which were manually staged, which would
1034 * be really confusing.
1036 struct diff_flags flags
= DIFF_FLAGS_INIT
;
1037 flags
.override_submodule_config
= 1;
1038 if (ignore_submodule_arg
&&
1039 !strcmp(ignore_submodule_arg
, "all"))
1040 flags
.ignore_submodules
= 1;
1041 committable
= index_differs_from(the_repository
,
1045 strbuf_release(&committer_ident
);
1049 if (trailer_args
.nr
) {
1050 if (amend_file_with_trailers(git_path_commit_editmsg(), &trailer_args
))
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_repository
->index
);
1088 read_index_from(the_repository
->index
, index_file
, repo_get_git_dir(the_repository
));
1090 if (cache_tree_update(the_repository
->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 enum untracked_status_type
parse_untracked_setting_name(const char *u
)
1171 * Please update $__git_untracked_file_modes in
1172 * git-completion.bash when you add new options
1174 switch (git_parse_maybe_bool(u
)) {
1185 if (!strcmp(u
, "no"))
1186 return SHOW_NO_UNTRACKED_FILES
;
1187 else if (!strcmp(u
, "normal"))
1188 return SHOW_NORMAL_UNTRACKED_FILES
;
1189 else if (!strcmp(u
, "all"))
1190 return SHOW_ALL_UNTRACKED_FILES
;
1192 return SHOW_UNTRACKED_FILES_ERROR
;
1195 static void handle_untracked_files_arg(struct wt_status
*s
)
1197 enum untracked_status_type u
;
1199 if (!untracked_files_arg
)
1200 return; /* default already initialized */
1202 u
= parse_untracked_setting_name(untracked_files_arg
);
1203 if (u
== SHOW_UNTRACKED_FILES_ERROR
)
1204 die(_("Invalid untracked files mode '%s'"),
1205 untracked_files_arg
);
1206 s
->show_untracked_files
= u
;
1209 static const char *read_commit_message(const char *name
)
1211 const char *out_enc
;
1212 struct commit
*commit
;
1214 commit
= lookup_commit_reference_by_name(name
);
1216 die(_("could not lookup commit '%s'"), name
);
1217 out_enc
= get_commit_output_encoding();
1218 return repo_logmsg_reencode(the_repository
, commit
, NULL
, out_enc
);
1222 * Enumerate what needs to be propagated when --porcelain
1223 * is not in effect here.
1225 static struct status_deferred_config
{
1226 enum wt_status_format status_format
;
1228 enum ahead_behind_flags ahead_behind
;
1229 } status_deferred_config
= {
1230 STATUS_FORMAT_UNSPECIFIED
,
1231 -1, /* unspecified */
1232 AHEAD_BEHIND_UNSPECIFIED
,
1235 static void finalize_deferred_config(struct wt_status
*s
)
1237 int use_deferred_config
= (status_format
!= STATUS_FORMAT_PORCELAIN
&&
1238 status_format
!= STATUS_FORMAT_PORCELAIN_V2
&&
1239 !s
->null_termination
);
1241 if (s
->null_termination
) {
1242 if (status_format
== STATUS_FORMAT_NONE
||
1243 status_format
== STATUS_FORMAT_UNSPECIFIED
)
1244 status_format
= STATUS_FORMAT_PORCELAIN
;
1245 else if (status_format
== STATUS_FORMAT_LONG
)
1246 die(_("options '%s' and '%s' cannot be used together"), "--long", "-z");
1249 if (use_deferred_config
&& status_format
== STATUS_FORMAT_UNSPECIFIED
)
1250 status_format
= status_deferred_config
.status_format
;
1251 if (status_format
== STATUS_FORMAT_UNSPECIFIED
)
1252 status_format
= STATUS_FORMAT_NONE
;
1254 if (use_deferred_config
&& s
->show_branch
< 0)
1255 s
->show_branch
= status_deferred_config
.show_branch
;
1256 if (s
->show_branch
< 0)
1260 * If the user did not give a "--[no]-ahead-behind" command
1261 * line argument *AND* we will print in a human-readable format
1262 * (short, long etc.) then we inherit from the status.aheadbehind
1263 * config setting. In all other cases (and porcelain V[12] formats
1264 * in particular), we inherit _FULL for backwards compatibility.
1266 if (use_deferred_config
&&
1267 s
->ahead_behind_flags
== AHEAD_BEHIND_UNSPECIFIED
)
1268 s
->ahead_behind_flags
= status_deferred_config
.ahead_behind
;
1270 if (s
->ahead_behind_flags
== AHEAD_BEHIND_UNSPECIFIED
)
1271 s
->ahead_behind_flags
= AHEAD_BEHIND_FULL
;
1274 static void check_fixup_reword_options(int argc
, const char *argv
[]) {
1275 if (whence
!= FROM_COMMIT
) {
1276 if (whence
== FROM_MERGE
)
1277 die(_("You are in the middle of a merge -- cannot reword."));
1278 else if (is_from_cherry_pick(whence
))
1279 die(_("You are in the middle of a cherry-pick -- cannot reword."));
1282 die(_("reword option of '%s' and path '%s' cannot be used together"), "--fixup", *argv
);
1283 if (patch_interactive
|| interactive
|| all
|| also
|| only
)
1284 die(_("reword option of '%s' and '%s' cannot be used together"),
1285 "--fixup", "--patch/--interactive/--all/--include/--only");
1288 static int parse_and_validate_options(int argc
, const char *argv
[],
1289 const struct option
*options
,
1290 const char * const usage
[],
1292 struct commit
*current_head
,
1293 struct wt_status
*s
)
1295 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
1296 finalize_deferred_config(s
);
1298 if (force_author
&& !strchr(force_author
, '>'))
1299 force_author
= find_author_by_nickname(force_author
);
1301 if (force_author
&& renew_authorship
)
1302 die(_("options '%s' and '%s' cannot be used together"), "--reset-author", "--author");
1304 if (logfile
|| have_option_m
|| use_message
)
1307 /* Sanity check options */
1308 if (amend
&& !current_head
)
1309 die(_("You have nothing to amend."));
1310 if (amend
&& whence
!= FROM_COMMIT
) {
1311 if (whence
== FROM_MERGE
)
1312 die(_("You are in the middle of a merge -- cannot amend."));
1313 else if (is_from_cherry_pick(whence
))
1314 die(_("You are in the middle of a cherry-pick -- cannot amend."));
1315 else if (whence
== FROM_REBASE_PICK
)
1316 die(_("You are in the middle of a rebase -- cannot amend."));
1318 if (fixup_message
&& squash_message
)
1319 die(_("options '%s' and '%s' cannot be used together"), "--squash", "--fixup");
1320 die_for_incompatible_opt4(!!use_message
, "-C",
1321 !!edit_message
, "-c",
1323 !!fixup_message
, "--fixup");
1324 die_for_incompatible_opt4(have_option_m
, "-m",
1325 !!edit_message
, "-c",
1326 !!use_message
, "-C",
1328 if (use_message
|| edit_message
|| logfile
||fixup_message
|| have_option_m
)
1329 FREE_AND_NULL(template_file
);
1331 use_message
= edit_message
;
1332 if (amend
&& !use_message
&& !fixup_message
)
1333 use_message
= "HEAD";
1334 if (!use_message
&& !is_from_cherry_pick(whence
) &&
1335 !is_from_rebase(whence
) && renew_authorship
)
1336 die(_("--reset-author can be used only with -C, -c or --amend."));
1338 use_message_buffer
= read_commit_message(use_message
);
1339 if (!renew_authorship
) {
1340 author_message
= use_message
;
1341 author_message_buffer
= use_message_buffer
;
1344 if ((is_from_cherry_pick(whence
) || whence
== FROM_REBASE_PICK
) &&
1345 !renew_authorship
) {
1346 author_message
= "CHERRY_PICK_HEAD";
1347 author_message_buffer
= read_commit_message(author_message
);
1350 if (patch_interactive
)
1353 die_for_incompatible_opt4(also
, "-i/--include",
1356 interactive
, "--interactive/-p/--patch");
1357 if (fixup_message
) {
1359 * We limit --fixup's suboptions to only alpha characters.
1360 * If the first character after a run of alpha is colon,
1361 * then the part before the colon may be a known suboption
1362 * name like `amend` or `reword`, or a misspelt suboption
1363 * name. In either case, we treat it as
1364 * --fixup=<suboption>:<arg>.
1366 * Otherwise, we are dealing with --fixup=<commit>.
1368 char *p
= fixup_message
;
1371 if (p
> fixup_message
&& *p
== ':') {
1373 fixup_commit
= p
+ 1;
1374 if (!strcmp("amend", fixup_message
) ||
1375 !strcmp("reword", fixup_message
)) {
1376 fixup_prefix
= "amend";
1378 if (*fixup_message
== 'r') {
1379 check_fixup_reword_options(argc
, argv
);
1383 die(_("unknown option: --fixup=%s:%s"), fixup_message
, fixup_commit
);
1386 fixup_commit
= fixup_message
;
1387 fixup_prefix
= "fixup";
1393 use_editor
= edit_flag
;
1395 handle_untracked_files_arg(s
);
1397 if (all
&& argc
> 0)
1398 die(_("paths '%s ...' with -a does not make sense"),
1401 if (status_format
!= STATUS_FORMAT_NONE
)
1407 static int dry_run_commit(const char **argv
, const char *prefix
,
1408 const struct commit
*current_head
, struct wt_status
*s
)
1411 const char *index_file
;
1413 index_file
= prepare_index(argv
, prefix
, current_head
, 1);
1414 committable
= run_status(stdout
, index_file
, prefix
, 0, s
);
1415 rollback_index_files();
1417 return committable
? 0 : 1;
1420 define_list_config_array_extra(color_status_slots
, {"added"});
1422 static int parse_status_slot(const char *slot
)
1424 if (!strcasecmp(slot
, "added"))
1425 return WT_STATUS_UPDATED
;
1427 return LOOKUP_CONFIG(color_status_slots
, slot
);
1430 static int git_status_config(const char *k
, const char *v
,
1431 const struct config_context
*ctx
, void *cb
)
1433 struct wt_status
*s
= cb
;
1434 const char *slot_name
;
1436 if (starts_with(k
, "column."))
1437 return git_column_config(k
, v
, "status", &s
->colopts
);
1438 if (!strcmp(k
, "status.submodulesummary")) {
1440 s
->submodule_summary
= git_config_bool_or_int(k
, v
, ctx
->kvi
,
1442 if (is_bool
&& s
->submodule_summary
)
1443 s
->submodule_summary
= -1;
1446 if (!strcmp(k
, "status.short")) {
1447 if (git_config_bool(k
, v
))
1448 status_deferred_config
.status_format
= STATUS_FORMAT_SHORT
;
1450 status_deferred_config
.status_format
= STATUS_FORMAT_NONE
;
1453 if (!strcmp(k
, "status.branch")) {
1454 status_deferred_config
.show_branch
= git_config_bool(k
, v
);
1457 if (!strcmp(k
, "status.aheadbehind")) {
1458 status_deferred_config
.ahead_behind
= git_config_bool(k
, v
);
1461 if (!strcmp(k
, "status.showstash")) {
1462 s
->show_stash
= git_config_bool(k
, v
);
1465 if (!strcmp(k
, "status.color") || !strcmp(k
, "color.status")) {
1466 s
->use_color
= git_config_colorbool(k
, v
);
1469 if (!strcmp(k
, "status.displaycommentprefix")) {
1470 s
->display_comment_prefix
= git_config_bool(k
, v
);
1473 if (skip_prefix(k
, "status.color.", &slot_name
) ||
1474 skip_prefix(k
, "color.status.", &slot_name
)) {
1475 int slot
= parse_status_slot(slot_name
);
1479 return config_error_nonbool(k
);
1480 return color_parse(v
, s
->color_palette
[slot
]);
1482 if (!strcmp(k
, "status.relativepaths")) {
1483 s
->relative_paths
= git_config_bool(k
, v
);
1486 if (!strcmp(k
, "status.showuntrackedfiles")) {
1487 enum untracked_status_type u
;
1489 u
= parse_untracked_setting_name(v
);
1490 if (u
== SHOW_UNTRACKED_FILES_ERROR
)
1491 return error(_("Invalid untracked files mode '%s'"), v
);
1492 s
->show_untracked_files
= u
;
1495 if (!strcmp(k
, "diff.renamelimit")) {
1496 if (s
->rename_limit
== -1)
1497 s
->rename_limit
= git_config_int(k
, v
, ctx
->kvi
);
1500 if (!strcmp(k
, "status.renamelimit")) {
1501 s
->rename_limit
= git_config_int(k
, v
, ctx
->kvi
);
1504 if (!strcmp(k
, "diff.renames")) {
1505 if (s
->detect_rename
== -1)
1506 s
->detect_rename
= git_config_rename(k
, v
);
1509 if (!strcmp(k
, "status.renames")) {
1510 s
->detect_rename
= git_config_rename(k
, v
);
1513 return git_diff_ui_config(k
, v
, ctx
, NULL
);
1516 int cmd_status(int argc
,
1519 struct repository
*repo UNUSED
)
1521 static int no_renames
= -1;
1522 static const char *rename_score_arg
= (const char *)-1;
1523 static struct wt_status s
;
1524 unsigned int progress_flag
= 0;
1526 struct object_id oid
;
1527 static struct option builtin_status_options
[] = {
1528 OPT__VERBOSE(&verbose
, N_("be verbose")),
1529 OPT_SET_INT('s', "short", &status_format
,
1530 N_("show status concisely"), STATUS_FORMAT_SHORT
),
1531 OPT_BOOL('b', "branch", &s
.show_branch
,
1532 N_("show branch information")),
1533 OPT_BOOL(0, "show-stash", &s
.show_stash
,
1534 N_("show stash information")),
1535 OPT_BOOL(0, "ahead-behind", &s
.ahead_behind_flags
,
1536 N_("compute full ahead/behind values")),
1537 OPT_CALLBACK_F(0, "porcelain", &status_format
,
1538 N_("version"), N_("machine-readable output"),
1539 PARSE_OPT_OPTARG
, opt_parse_porcelain
),
1540 OPT_SET_INT(0, "long", &status_format
,
1541 N_("show status in long format (default)"),
1542 STATUS_FORMAT_LONG
),
1543 OPT_BOOL('z', "null", &s
.null_termination
,
1544 N_("terminate entries with NUL")),
1546 .type
= OPTION_STRING
,
1548 .long_name
= "untracked-files",
1549 .value
= &untracked_files_arg
,
1551 .help
= N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1552 .flags
= PARSE_OPT_OPTARG
,
1553 .defval
= (intptr_t)"all",
1556 .type
= OPTION_STRING
,
1557 .long_name
= "ignored",
1558 .value
= &ignored_arg
,
1560 .help
= N_("show ignored files, optional modes: traditional, matching, no. (Default: traditional)"),
1561 .flags
= PARSE_OPT_OPTARG
,
1562 .defval
= (intptr_t)"traditional",
1565 .type
= OPTION_STRING
,
1566 .long_name
= "ignore-submodules",
1567 .value
= &ignore_submodule_arg
,
1569 .help
= N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
1570 .flags
= PARSE_OPT_OPTARG
,
1571 .defval
= (intptr_t)"all",
1573 OPT_COLUMN(0, "column", &s
.colopts
, N_("list untracked files in columns")),
1574 OPT_BOOL(0, "no-renames", &no_renames
, N_("do not detect renames")),
1575 OPT_CALLBACK_F('M', "find-renames", &rename_score_arg
,
1576 N_("n"), N_("detect renames, optionally set similarity index"),
1577 PARSE_OPT_OPTARG
| PARSE_OPT_NONEG
, opt_parse_rename_score
),
1581 show_usage_with_options_if_asked(argc
, argv
,
1582 builtin_status_usage
, builtin_status_options
);
1584 prepare_repo_settings(the_repository
);
1585 the_repository
->settings
.command_requires_full_index
= 0;
1587 status_init_config(&s
, git_status_config
);
1588 argc
= parse_options(argc
, argv
, prefix
,
1589 builtin_status_options
,
1590 builtin_status_usage
, 0);
1591 finalize_colopts(&s
.colopts
, -1);
1592 finalize_deferred_config(&s
);
1594 handle_untracked_files_arg(&s
);
1595 handle_ignored_arg(&s
);
1597 if (s
.show_ignored_mode
== SHOW_MATCHING_IGNORED
&&
1598 s
.show_untracked_files
== SHOW_NO_UNTRACKED_FILES
)
1599 die(_("Unsupported combination of ignored and untracked-files arguments"));
1601 parse_pathspec(&s
.pathspec
, 0,
1602 PATHSPEC_PREFER_FULL
,
1605 if (status_format
!= STATUS_FORMAT_PORCELAIN
&&
1606 status_format
!= STATUS_FORMAT_PORCELAIN_V2
)
1607 progress_flag
= REFRESH_PROGRESS
;
1608 repo_read_index(the_repository
);
1609 refresh_index(the_repository
->index
,
1610 REFRESH_QUIET
|REFRESH_UNMERGED
|progress_flag
,
1611 &s
.pathspec
, NULL
, NULL
);
1613 if (use_optional_locks())
1614 fd
= repo_hold_locked_index(the_repository
, &index_lock
, 0);
1618 s
.is_initial
= repo_get_oid(the_repository
, s
.reference
, &oid
) ? 1 : 0;
1620 oidcpy(&s
.oid_commit
, &oid
);
1622 s
.ignore_submodule_arg
= ignore_submodule_arg
;
1623 s
.status_format
= status_format
;
1624 s
.verbose
= verbose
;
1625 if (no_renames
!= -1)
1626 s
.detect_rename
= !no_renames
;
1627 if ((intptr_t)rename_score_arg
!= -1) {
1628 if (s
.detect_rename
< DIFF_DETECT_RENAME
)
1629 s
.detect_rename
= DIFF_DETECT_RENAME
;
1630 if (rename_score_arg
)
1631 s
.rename_score
= parse_rename_score(&rename_score_arg
);
1634 wt_status_collect(&s
);
1637 repo_update_index_if_able(the_repository
, &index_lock
);
1639 if (s
.relative_paths
)
1642 wt_status_print(&s
);
1643 wt_status_collect_free_buffers(&s
);
1648 static int git_commit_config(const char *k
, const char *v
,
1649 const struct config_context
*ctx
, void *cb
)
1651 struct wt_status
*s
= cb
;
1653 if (!strcmp(k
, "commit.template"))
1654 return git_config_pathname(&template_file
, k
, v
);
1655 if (!strcmp(k
, "commit.status")) {
1656 include_status
= git_config_bool(k
, v
);
1659 if (!strcmp(k
, "commit.cleanup")) {
1660 FREE_AND_NULL(cleanup_config
);
1661 return git_config_string(&cleanup_config
, k
, v
);
1663 if (!strcmp(k
, "commit.gpgsign")) {
1664 sign_commit
= git_config_bool(k
, v
) ? "" : NULL
;
1667 if (!strcmp(k
, "commit.verbose")) {
1669 config_commit_verbose
= git_config_bool_or_int(k
, v
, ctx
->kvi
,
1674 return git_status_config(k
, v
, ctx
, s
);
1677 int cmd_commit(int argc
,
1680 struct repository
*repo UNUSED
)
1682 static struct wt_status s
;
1683 static const char *cleanup_arg
= NULL
;
1684 static struct option builtin_commit_options
[] = {
1685 OPT__QUIET(&quiet
, N_("suppress summary after successful commit")),
1686 OPT__VERBOSE(&verbose
, N_("show diff in commit message template")),
1688 OPT_GROUP(N_("Commit message options")),
1689 OPT_FILENAME('F', "file", &logfile
, N_("read message from file")),
1690 OPT_STRING(0, "author", &force_author
, N_("author"), N_("override author for commit")),
1691 OPT_STRING(0, "date", &force_date
, N_("date"), N_("override date for commit")),
1692 OPT_CALLBACK('m', "message", &message
, N_("message"), N_("commit message"), opt_parse_m
),
1693 OPT_STRING('c', "reedit-message", &edit_message
, N_("commit"), N_("reuse and edit message from specified commit")),
1694 OPT_STRING('C', "reuse-message", &use_message
, N_("commit"), N_("reuse message from specified commit")),
1696 * TRANSLATORS: Leave "[(amend|reword):]" as-is,
1697 * and only translate <commit>.
1699 OPT_STRING(0, "fixup", &fixup_message
, N_("[(amend|reword):]commit"), N_("use autosquash formatted message to fixup or amend/reword specified commit")),
1700 OPT_STRING(0, "squash", &squash_message
, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
1701 OPT_BOOL(0, "reset-author", &renew_authorship
, N_("the commit is authored by me now (used with -C/-c/--amend)")),
1702 OPT_PASSTHRU_ARGV(0, "trailer", &trailer_args
, N_("trailer"), N_("add custom trailer(s)"), PARSE_OPT_NONEG
),
1703 OPT_BOOL('s', "signoff", &signoff
, N_("add a Signed-off-by trailer")),
1704 OPT_FILENAME('t', "template", &template_file
, N_("use specified template file")),
1705 OPT_BOOL('e', "edit", &edit_flag
, N_("force edit of commit")),
1706 OPT_CLEANUP(&cleanup_arg
),
1707 OPT_BOOL(0, "status", &include_status
, N_("include status in commit message template")),
1709 .type
= OPTION_STRING
,
1711 .long_name
= "gpg-sign",
1712 .value
= &sign_commit
,
1713 .argh
= N_("key-id"),
1714 .help
= N_("GPG sign commit"),
1715 .flags
= PARSE_OPT_OPTARG
,
1716 .defval
= (intptr_t) "",
1718 /* end commit message options */
1720 OPT_GROUP(N_("Commit contents options")),
1721 OPT_BOOL('a', "all", &all
, N_("commit all changed files")),
1722 OPT_BOOL('i', "include", &also
, N_("add specified files to index for commit")),
1723 OPT_BOOL(0, "interactive", &interactive
, N_("interactively add files")),
1724 OPT_BOOL('p', "patch", &patch_interactive
, N_("interactively add changes")),
1725 OPT_BOOL('o', "only", &only
, N_("commit only specified files")),
1726 OPT_BOOL('n', "no-verify", &no_verify
, N_("bypass pre-commit and commit-msg hooks")),
1727 OPT_BOOL(0, "dry-run", &dry_run
, N_("show what would be committed")),
1728 OPT_SET_INT(0, "short", &status_format
, N_("show status concisely"),
1729 STATUS_FORMAT_SHORT
),
1730 OPT_BOOL(0, "branch", &s
.show_branch
, N_("show branch information")),
1731 OPT_BOOL(0, "ahead-behind", &s
.ahead_behind_flags
,
1732 N_("compute full ahead/behind values")),
1733 OPT_SET_INT(0, "porcelain", &status_format
,
1734 N_("machine-readable output"), STATUS_FORMAT_PORCELAIN
),
1735 OPT_SET_INT(0, "long", &status_format
,
1736 N_("show status in long format (default)"),
1737 STATUS_FORMAT_LONG
),
1738 OPT_BOOL('z', "null", &s
.null_termination
,
1739 N_("terminate entries with NUL")),
1740 OPT_BOOL(0, "amend", &amend
, N_("amend previous commit")),
1741 OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite
, N_("bypass post-rewrite hook")),
1743 .type
= OPTION_STRING
,
1745 .long_name
= "untracked-files",
1746 .value
= &untracked_files_arg
,
1748 .help
= N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1749 .flags
= PARSE_OPT_OPTARG
,
1750 .defval
= (intptr_t)"all",
1752 OPT_PATHSPEC_FROM_FILE(&pathspec_from_file
),
1753 OPT_PATHSPEC_FILE_NUL(&pathspec_file_nul
),
1754 /* end commit contents options */
1756 OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty
,
1757 N_("ok to record an empty change")),
1758 OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message
,
1759 N_("ok to record a change with an empty message")),
1764 struct strbuf sb
= STRBUF_INIT
;
1765 struct strbuf author_ident
= STRBUF_INIT
;
1766 const char *index_file
, *reflog_msg
;
1767 struct object_id oid
;
1768 struct commit_list
*parents
= NULL
;
1769 struct stat statbuf
;
1770 struct commit
*current_head
= NULL
;
1771 struct commit_extra_header
*extra
= NULL
;
1772 struct strbuf err
= STRBUF_INIT
;
1775 show_usage_with_options_if_asked(argc
, argv
,
1776 builtin_commit_usage
, builtin_commit_options
);
1778 prepare_repo_settings(the_repository
);
1779 the_repository
->settings
.command_requires_full_index
= 0;
1781 status_init_config(&s
, git_commit_config
);
1782 s
.commit_template
= 1;
1783 status_format
= STATUS_FORMAT_NONE
; /* Ignore status.short */
1786 if (repo_get_oid(the_repository
, "HEAD", &oid
))
1787 current_head
= NULL
;
1789 current_head
= lookup_commit_or_die(&oid
, "HEAD");
1790 if (repo_parse_commit(the_repository
, current_head
))
1791 die(_("could not parse HEAD commit"));
1793 verbose
= -1; /* unspecified */
1794 argc
= parse_and_validate_options(argc
, argv
, builtin_commit_options
,
1795 builtin_commit_usage
,
1796 prefix
, current_head
, &s
);
1798 verbose
= (config_commit_verbose
< 0) ? 0 : config_commit_verbose
;
1801 free(cleanup_config
);
1802 cleanup_config
= xstrdup(cleanup_arg
);
1804 cleanup_mode
= get_cleanup_mode(cleanup_config
, use_editor
);
1807 return dry_run_commit(argv
, prefix
, current_head
, &s
);
1808 index_file
= prepare_index(argv
, prefix
, current_head
, 0);
1810 /* Set up everything for writing the commit object. This includes
1811 running hooks, writing the trees, and interacting with the user. */
1812 if (!prepare_to_commit(index_file
, prefix
,
1813 current_head
, &s
, &author_ident
)) {
1815 rollback_index_files();
1819 /* Determine parents */
1820 reflog_msg
= getenv("GIT_REFLOG_ACTION");
1821 if (!current_head
) {
1823 reflog_msg
= "commit (initial)";
1826 reflog_msg
= "commit (amend)";
1827 parents
= copy_commit_list(current_head
->parents
);
1828 } else if (whence
== FROM_MERGE
) {
1829 struct strbuf m
= STRBUF_INIT
;
1831 int allow_fast_forward
= 1;
1832 struct commit_list
**pptr
= &parents
;
1835 reflog_msg
= "commit (merge)";
1836 pptr
= commit_list_append(current_head
, pptr
);
1837 fp
= xfopen(git_path_merge_head(the_repository
), "r");
1838 while (strbuf_getline_lf(&m
, fp
) != EOF
) {
1839 struct commit
*parent
;
1841 parent
= get_merge_parent(m
.buf
);
1843 die(_("Corrupt MERGE_HEAD file (%s)"), m
.buf
);
1844 pptr
= commit_list_append(parent
, pptr
);
1848 if (!stat(git_path_merge_mode(the_repository
), &statbuf
)) {
1849 if (strbuf_read_file(&sb
, git_path_merge_mode(the_repository
), 0) < 0)
1850 die_errno(_("could not read MERGE_MODE"));
1851 if (!strcmp(sb
.buf
, "no-ff"))
1852 allow_fast_forward
= 0;
1854 if (allow_fast_forward
)
1855 reduce_heads_replace(&parents
);
1858 reflog_msg
= is_from_cherry_pick(whence
)
1859 ? "commit (cherry-pick)"
1860 : is_from_rebase(whence
)
1863 commit_list_insert(current_head
, &parents
);
1866 /* Finally, get the commit message */
1868 if (strbuf_read_file(&sb
, git_path_commit_editmsg(), 0) < 0) {
1869 int saved_errno
= errno
;
1870 rollback_index_files();
1871 die(_("could not read commit message: %s"), strerror(saved_errno
));
1874 cleanup_message(&sb
, cleanup_mode
, verbose
);
1876 if (message_is_empty(&sb
, cleanup_mode
) && !allow_empty_message
) {
1877 rollback_index_files();
1878 fprintf(stderr
, _("Aborting commit due to empty commit message.\n"));
1881 if (template_untouched(&sb
, template_file
, cleanup_mode
) && !allow_empty_message
) {
1882 rollback_index_files();
1883 fprintf(stderr
, _("Aborting commit; you did not edit the message.\n"));
1887 if (fixup_message
&& starts_with(sb
.buf
, "amend! ") &&
1888 !allow_empty_message
) {
1889 struct strbuf body
= STRBUF_INIT
;
1890 size_t len
= commit_subject_length(sb
.buf
);
1891 strbuf_addstr(&body
, sb
.buf
+ len
);
1892 if (message_is_empty(&body
, cleanup_mode
)) {
1893 rollback_index_files();
1894 fprintf(stderr
, _("Aborting commit due to empty commit message body.\n"));
1897 strbuf_release(&body
);
1901 const char *exclude_gpgsig
[3] = { "gpgsig", "gpgsig-sha256", NULL
};
1902 extra
= read_commit_extra_headers(current_head
, exclude_gpgsig
);
1904 struct commit_extra_header
**tail
= &extra
;
1905 append_merge_tag_headers(parents
, &tail
);
1908 if (commit_tree_extended(sb
.buf
, sb
.len
, &the_repository
->index
->cache_tree
->oid
,
1909 parents
, &oid
, author_ident
.buf
, NULL
,
1910 sign_commit
, extra
)) {
1911 rollback_index_files();
1912 die(_("failed to write commit object"));
1915 if (update_head_with_reflog(current_head
, &oid
, reflog_msg
, &sb
,
1917 rollback_index_files();
1921 sequencer_post_commit_cleanup(the_repository
, 0);
1922 unlink(git_path_merge_head(the_repository
));
1923 unlink(git_path_merge_msg(the_repository
));
1924 unlink(git_path_merge_mode(the_repository
));
1925 unlink(git_path_squash_msg(the_repository
));
1927 if (commit_index_files())
1928 die(_("repository has been updated, but unable to write\n"
1929 "new index file. Check that disk is not full and quota is\n"
1930 "not exceeded, and then \"git restore --staged :/\" to recover."));
1932 git_test_write_commit_graph_or_die();
1934 repo_rerere(the_repository
, 0);
1935 run_auto_maintenance(quiet
);
1936 run_commit_hook(use_editor
, repo_get_index_file(the_repository
),
1937 NULL
, "post-commit", NULL
);
1938 if (amend
&& !no_post_rewrite
) {
1939 commit_post_rewrite(the_repository
, current_head
, &oid
);
1942 unsigned int flags
= 0;
1945 flags
|= SUMMARY_INITIAL_COMMIT
;
1946 if (author_date_is_interesting())
1947 flags
|= SUMMARY_SHOW_AUTHOR_DATE
;
1948 print_commit_summary(the_repository
, prefix
,
1952 apply_autostash_ref(the_repository
, "MERGE_AUTOSTASH");
1955 free_commit_extra_headers(extra
);
1956 free_commit_list(parents
);
1957 strbuf_release(&author_ident
);
1958 strbuf_release(&err
);
1959 strbuf_release(&sb
);
1961 free(template_file
);