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"
22 #include "add-interactive.h"
25 #include "wt-status.h"
26 #include "run-command.h"
28 #include "object-name.h"
29 #include "parse-options.h"
31 #include "preload-index.h"
32 #include "read-cache.h"
33 #include "repository.h"
34 #include "string-list.h"
36 #include "unpack-trees.h"
38 #include "sequencer.h"
39 #include "sparse-index.h"
42 #include "commit-reach.h"
43 #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 *force_author
;
115 static char *logfile
;
116 static char *template_file
;
118 * The _message variables are commit names from which to take
119 * the commit message and/or authorship.
121 static const char *author_message
, *author_message_buffer
;
122 static const char *edit_message
, *use_message
;
123 static char *fixup_message
, *fixup_commit
, *squash_message
;
124 static const char *fixup_prefix
;
125 static int all
, also
, interactive
, patch_interactive
, only
, amend
, signoff
;
126 static struct add_p_opt add_p_opt
= ADD_P_OPT_INIT
;
127 static int edit_flag
= -1; /* unspecified */
128 static int quiet
, verbose
, no_verify
, allow_empty
, dry_run
, renew_authorship
;
129 static int config_commit_verbose
= -1; /* unspecified */
130 static int no_post_rewrite
, allow_empty_message
, pathspec_file_nul
;
131 static const char *untracked_files_arg
, *force_date
, *ignore_submodule_arg
, *ignored_arg
;
132 static const char *sign_commit
, *pathspec_from_file
;
133 static struct strvec trailer_args
= STRVEC_INIT
;
136 * The default commit message cleanup mode will remove the lines
137 * beginning with # (shell comments) and leading and trailing
138 * whitespaces (empty lines or containing only whitespaces)
139 * if editor is used, and only the whitespaces if the message
140 * is specified explicitly.
142 static enum commit_msg_cleanup_mode cleanup_mode
;
143 static char *cleanup_config
;
145 static enum commit_whence whence
;
146 static int use_editor
= 1, include_status
= 1;
147 static int have_option_m
;
148 static struct strbuf message
= STRBUF_INIT
;
150 static enum wt_status_format status_format
= STATUS_FORMAT_UNSPECIFIED
;
152 static int opt_parse_porcelain(const struct option
*opt
, const char *arg
, int unset
)
154 enum wt_status_format
*value
= (enum wt_status_format
*)opt
->value
;
156 *value
= STATUS_FORMAT_NONE
;
158 *value
= STATUS_FORMAT_PORCELAIN
;
159 else if (!strcmp(arg
, "v1") || !strcmp(arg
, "1"))
160 *value
= STATUS_FORMAT_PORCELAIN
;
161 else if (!strcmp(arg
, "v2") || !strcmp(arg
, "2"))
162 *value
= STATUS_FORMAT_PORCELAIN_V2
;
164 die("unsupported porcelain version '%s'", arg
);
169 static int opt_parse_m(const struct option
*opt
, const char *arg
, int unset
)
171 struct strbuf
*buf
= opt
->value
;
174 strbuf_setlen(buf
, 0);
178 strbuf_addch(buf
, '\n');
179 strbuf_addstr(buf
, arg
);
180 strbuf_complete_line(buf
);
185 static int opt_parse_rename_score(const struct option
*opt
, const char *arg
, int unset
)
187 const char **value
= opt
->value
;
189 BUG_ON_OPT_NEG(unset
);
191 if (arg
!= NULL
&& *arg
== '=')
198 static void determine_whence(struct wt_status
*s
)
200 if (file_exists(git_path_merge_head(the_repository
)))
202 else if (!sequencer_determine_whence(the_repository
, &whence
))
203 whence
= FROM_COMMIT
;
208 static void status_init_config(struct wt_status
*s
, config_fn_t fn
)
210 wt_status_prepare(the_repository
, s
);
211 init_diff_ui_defaults();
212 repo_config(the_repository
, fn
, s
);
214 s
->hints
= advice_enabled(ADVICE_STATUS_HINTS
); /* must come after repo_config() */
217 static void rollback_index_files(void)
219 switch (commit_style
) {
221 break; /* nothing to do */
223 rollback_lock_file(&index_lock
);
226 rollback_lock_file(&index_lock
);
227 rollback_lock_file(&false_lock
);
232 static int commit_index_files(void)
236 switch (commit_style
) {
238 break; /* nothing to do */
240 err
= commit_lock_file(&index_lock
);
243 err
= commit_lock_file(&index_lock
);
244 rollback_lock_file(&false_lock
);
252 * Take a union of paths in the index and the named tree (typically, "HEAD"),
253 * and return the paths that match the given pattern in list.
255 static int list_paths(struct string_list
*list
, const char *with_tree
,
256 const struct pathspec
*pattern
)
264 m
= xcalloc(1, pattern
->nr
);
267 char *max_prefix
= common_prefix(pattern
);
268 overlay_tree_on_index(the_repository
->index
, with_tree
, max_prefix
);
272 /* TODO: audit for interaction with sparse-index. */
273 ensure_full_index(the_repository
->index
);
274 for (i
= 0; i
< the_repository
->index
->cache_nr
; i
++) {
275 const struct cache_entry
*ce
= the_repository
->index
->cache
[i
];
276 struct string_list_item
*item
;
278 if (ce
->ce_flags
& CE_UPDATE
)
280 if (!ce_path_match(the_repository
->index
, ce
, pattern
, m
))
282 item
= string_list_insert(list
, ce
->name
);
283 if (ce_skip_worktree(ce
))
284 item
->util
= item
; /* better a valid pointer than a fake one */
287 ret
= report_path_error(m
, pattern
);
292 static void add_remove_files(struct string_list
*list
)
295 for (i
= 0; i
< list
->nr
; i
++) {
297 struct string_list_item
*p
= &(list
->items
[i
]);
299 /* p->util is skip-worktree */
303 if (!lstat(p
->string
, &st
)) {
304 if (add_to_index(the_repository
->index
, p
->string
, &st
, 0))
305 die(_("updating files failed"));
307 remove_file_from_index(the_repository
->index
, p
->string
);
311 static void create_base_index(const struct commit
*current_head
)
314 struct unpack_trees_options opts
;
318 discard_index(the_repository
->index
);
322 memset(&opts
, 0, sizeof(opts
));
326 opts
.src_index
= the_repository
->index
;
327 opts
.dst_index
= the_repository
->index
;
329 opts
.fn
= oneway_merge
;
330 tree
= parse_tree_indirect(¤t_head
->object
.oid
);
332 die(_("failed to unpack HEAD tree object"));
333 if (parse_tree(tree
) < 0)
335 init_tree_desc(&t
, &tree
->object
.oid
, tree
->buffer
, tree
->size
);
336 if (unpack_trees(1, &t
, &opts
))
337 exit(128); /* We've already reported the error, finish dying */
340 static void refresh_cache_or_die(int refresh_flags
)
343 * refresh_flags contains REFRESH_QUIET, so the only errors
344 * are for unmerged entries.
346 if (refresh_index(the_repository
->index
, refresh_flags
| REFRESH_IN_PORCELAIN
, NULL
, NULL
, NULL
))
347 die_resolve_conflict("commit");
350 static const char *prepare_index(const char **argv
, const char *prefix
,
351 const struct commit
*current_head
, int is_status
)
353 struct string_list partial
= STRING_LIST_INIT_DUP
;
354 struct pathspec pathspec
;
355 int refresh_flags
= REFRESH_QUIET
;
359 if (add_p_opt
.context
< -1)
360 die(_("'%s' cannot be negative"), "--unified");
361 if (add_p_opt
.interhunkcontext
< -1)
362 die(_("'%s' cannot be negative"), "--inter-hunk-context");
365 refresh_flags
|= REFRESH_UNMERGED
;
366 parse_pathspec(&pathspec
, 0,
367 PATHSPEC_PREFER_FULL
,
370 if (pathspec_from_file
) {
372 die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "--interactive/--patch");
375 die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "-a");
378 die(_("'%s' and pathspec arguments cannot be used together"), "--pathspec-from-file");
380 parse_pathspec_file(&pathspec
, 0,
381 PATHSPEC_PREFER_FULL
,
382 prefix
, pathspec_from_file
, pathspec_file_nul
);
383 } else if (pathspec_file_nul
) {
384 die(_("the option '%s' requires '%s'"), "--pathspec-file-nul", "--pathspec-from-file");
387 if (!pathspec
.nr
&& (also
|| (only
&& !allow_empty
&&
388 (!amend
|| (fixup_message
&& strcmp(fixup_prefix
, "amend"))))))
389 die(_("No paths with --include/--only does not make sense."));
391 if (repo_read_index_preload(the_repository
, &pathspec
, 0) < 0)
392 die(_("index file corrupt"));
395 char *old_index_env
= NULL
, *old_repo_index_file
;
396 repo_hold_locked_index(the_repository
, &index_lock
,
399 refresh_cache_or_die(refresh_flags
);
401 if (write_locked_index(the_repository
->index
, &index_lock
, 0))
402 die(_("unable to create temporary index"));
404 old_repo_index_file
= the_repository
->index_file
;
405 the_repository
->index_file
=
406 (char *)get_lock_file_path(&index_lock
);
407 old_index_env
= xstrdup_or_null(getenv(INDEX_ENVIRONMENT
));
408 setenv(INDEX_ENVIRONMENT
, the_repository
->index_file
, 1);
410 if (interactive_add(the_repository
, argv
, prefix
, patch_interactive
, &add_p_opt
) != 0)
411 die(_("interactive add failed"));
413 the_repository
->index_file
= old_repo_index_file
;
414 if (old_index_env
&& *old_index_env
)
415 setenv(INDEX_ENVIRONMENT
, old_index_env
, 1);
417 unsetenv(INDEX_ENVIRONMENT
);
418 FREE_AND_NULL(old_index_env
);
420 discard_index(the_repository
->index
);
421 read_index_from(the_repository
->index
, get_lock_file_path(&index_lock
),
422 repo_get_git_dir(the_repository
));
423 if (cache_tree_update(the_repository
->index
, WRITE_TREE_SILENT
) == 0) {
424 if (reopen_lock_file(&index_lock
) < 0)
425 die(_("unable to write index file"));
426 if (write_locked_index(the_repository
->index
, &index_lock
, 0))
427 die(_("unable to update temporary index"));
429 warning(_("Failed to update main cache tree"));
431 commit_style
= COMMIT_NORMAL
;
432 ret
= get_lock_file_path(&index_lock
);
435 if (add_p_opt
.context
!= -1)
436 die(_("the option '%s' requires '%s'"), "--unified", "--interactive/--patch");
437 if (add_p_opt
.interhunkcontext
!= -1)
438 die(_("the option '%s' requires '%s'"), "--inter-hunk-context", "--interactive/--patch");
442 * Non partial, non as-is commit.
444 * (1) get the real index;
445 * (2) update the_index as necessary;
446 * (3) write the_index out to the real index (still locked);
447 * (4) return the name of the locked index file.
449 * The caller should run hooks on the locked real index, and
450 * (A) if all goes well, commit the real index;
451 * (B) on failure, rollback the real index.
453 if (all
|| (also
&& pathspec
.nr
)) {
454 char *ps_matched
= xcalloc(pathspec
.nr
, 1);
455 repo_hold_locked_index(the_repository
, &index_lock
,
457 add_files_to_cache(the_repository
, also
? prefix
: NULL
,
458 &pathspec
, ps_matched
, 0, 0);
459 if (!all
&& report_path_error(ps_matched
, &pathspec
))
462 refresh_cache_or_die(refresh_flags
);
463 cache_tree_update(the_repository
->index
, WRITE_TREE_SILENT
);
464 if (write_locked_index(the_repository
->index
, &index_lock
, 0))
465 die(_("unable to write new index file"));
466 commit_style
= COMMIT_NORMAL
;
467 ret
= get_lock_file_path(&index_lock
);
475 * (1) return the name of the real index file.
477 * The caller should run hooks on the real index,
478 * and create commit from the_index.
479 * We still need to refresh the index here.
481 if (!only
&& !pathspec
.nr
) {
482 repo_hold_locked_index(the_repository
, &index_lock
,
484 refresh_cache_or_die(refresh_flags
);
485 if (the_repository
->index
->cache_changed
486 || !cache_tree_fully_valid(the_repository
->index
->cache_tree
))
487 cache_tree_update(the_repository
->index
, WRITE_TREE_SILENT
);
488 if (write_locked_index(the_repository
->index
, &index_lock
,
489 COMMIT_LOCK
| SKIP_IF_UNCHANGED
))
490 die(_("unable to write new index file"));
491 commit_style
= COMMIT_AS_IS
;
492 ret
= repo_get_index_file(the_repository
);
499 * (0) find the set of affected paths;
500 * (1) get lock on the real index file;
501 * (2) update the_index with the given paths;
502 * (3) write the_index out to the real index (still locked);
503 * (4) get lock on the false index file;
504 * (5) reset the_index from HEAD;
505 * (6) update the_index the same way as (2);
506 * (7) write the_index out to the false index file;
507 * (8) return the name of the false index file (still locked);
509 * The caller should run hooks on the locked false index, and
510 * create commit from it. Then
511 * (A) if all goes well, commit the real index;
512 * (B) on failure, rollback the real index;
513 * In either case, rollback the false index.
515 commit_style
= COMMIT_PARTIAL
;
517 if (whence
!= FROM_COMMIT
) {
518 if (whence
== FROM_MERGE
)
519 die(_("cannot do a partial commit during a merge."));
520 else if (is_from_cherry_pick(whence
))
521 die(_("cannot do a partial commit during a cherry-pick."));
522 else if (is_from_rebase(whence
))
523 die(_("cannot do a partial commit during a rebase."));
526 if (list_paths(&partial
, !current_head
? NULL
: "HEAD", &pathspec
))
529 discard_index(the_repository
->index
);
530 if (repo_read_index(the_repository
) < 0)
531 die(_("cannot read the index"));
533 repo_hold_locked_index(the_repository
, &index_lock
, LOCK_DIE_ON_ERROR
);
534 add_remove_files(&partial
);
535 refresh_index(the_repository
->index
, REFRESH_QUIET
, NULL
, NULL
, NULL
);
536 cache_tree_update(the_repository
->index
, WRITE_TREE_SILENT
);
537 if (write_locked_index(the_repository
->index
, &index_lock
, 0))
538 die(_("unable to write new index file"));
540 path
= repo_git_path(the_repository
, "next-index-%"PRIuMAX
,
541 (uintmax_t) getpid());
542 hold_lock_file_for_update(&false_lock
, path
,
545 create_base_index(current_head
);
546 add_remove_files(&partial
);
547 refresh_index(the_repository
->index
, REFRESH_QUIET
, NULL
, NULL
, NULL
);
549 if (write_locked_index(the_repository
->index
, &false_lock
, 0))
550 die(_("unable to write temporary index file"));
552 discard_index(the_repository
->index
);
553 ret
= get_lock_file_path(&false_lock
);
554 read_index_from(the_repository
->index
, ret
, repo_get_git_dir(the_repository
));
556 string_list_clear(&partial
, 0);
557 clear_pathspec(&pathspec
);
562 static int run_status(FILE *fp
, const char *index_file
, const char *prefix
, int nowarn
,
565 struct object_id oid
;
567 if (s
->relative_paths
)
572 s
->reference
= "HEAD^1";
574 s
->verbose
= verbose
;
575 s
->index_file
= index_file
;
578 s
->is_initial
= repo_get_oid(the_repository
, s
->reference
, &oid
) ? 1 : 0;
580 oidcpy(&s
->oid_commit
, &oid
);
581 s
->status_format
= status_format
;
582 s
->ignore_submodule_arg
= ignore_submodule_arg
;
584 wt_status_collect(s
);
586 wt_status_collect_free_buffers(s
);
588 return s
->committable
;
591 static int is_a_merge(const struct commit
*current_head
)
593 return !!(current_head
->parents
&& current_head
->parents
->next
);
596 static void assert_split_ident(struct ident_split
*id
, const struct strbuf
*buf
)
598 if (split_ident_line(id
, buf
->buf
, buf
->len
) || !id
->date_begin
)
599 BUG("unable to parse our own ident: %s", buf
->buf
);
602 static void export_one(const char *var
, const char *s
, const char *e
, int hack
)
604 struct strbuf buf
= STRBUF_INIT
;
606 strbuf_addch(&buf
, hack
);
607 strbuf_add(&buf
, s
, e
- s
);
608 setenv(var
, buf
.buf
, 1);
609 strbuf_release(&buf
);
612 static int parse_force_date(const char *in
, struct strbuf
*out
)
614 strbuf_addch(out
, '@');
616 if (parse_date(in
, out
) < 0) {
618 unsigned long t
= approxidate_careful(in
, &errors
);
621 strbuf_addf(out
, "%lu", t
);
627 static void set_ident_var(char **buf
, char *val
)
633 static void determine_author_info(struct strbuf
*author_ident
)
635 char *name
, *email
, *date
;
636 struct ident_split author
;
638 name
= xstrdup_or_null(getenv("GIT_AUTHOR_NAME"));
639 email
= xstrdup_or_null(getenv("GIT_AUTHOR_EMAIL"));
640 date
= xstrdup_or_null(getenv("GIT_AUTHOR_DATE"));
642 if (author_message
) {
643 struct ident_split ident
;
647 a
= find_commit_header(author_message_buffer
, "author", &len
);
649 die(_("commit '%s' lacks author header"), author_message
);
650 if (split_ident_line(&ident
, a
, len
) < 0)
651 die(_("commit '%s' has malformed author line"), author_message
);
653 set_ident_var(&name
, xmemdupz(ident
.name_begin
, ident
.name_end
- ident
.name_begin
));
654 set_ident_var(&email
, xmemdupz(ident
.mail_begin
, ident
.mail_end
- ident
.mail_begin
));
656 if (ident
.date_begin
) {
657 struct strbuf date_buf
= STRBUF_INIT
;
658 strbuf_addch(&date_buf
, '@');
659 strbuf_add(&date_buf
, ident
.date_begin
, ident
.date_end
- ident
.date_begin
);
660 strbuf_addch(&date_buf
, ' ');
661 strbuf_add(&date_buf
, ident
.tz_begin
, ident
.tz_end
- ident
.tz_begin
);
662 set_ident_var(&date
, strbuf_detach(&date_buf
, NULL
));
667 struct ident_split ident
;
669 if (split_ident_line(&ident
, force_author
, strlen(force_author
)) < 0)
670 die(_("malformed --author parameter"));
671 set_ident_var(&name
, xmemdupz(ident
.name_begin
, ident
.name_end
- ident
.name_begin
));
672 set_ident_var(&email
, xmemdupz(ident
.mail_begin
, ident
.mail_end
- ident
.mail_begin
));
676 struct strbuf date_buf
= STRBUF_INIT
;
677 if (parse_force_date(force_date
, &date_buf
))
678 die(_("invalid date format: %s"), force_date
);
679 set_ident_var(&date
, strbuf_detach(&date_buf
, NULL
));
682 strbuf_addstr(author_ident
, fmt_ident(name
, email
, WANT_AUTHOR_IDENT
, date
,
684 assert_split_ident(&author
, author_ident
);
685 export_one("GIT_AUTHOR_NAME", author
.name_begin
, author
.name_end
, 0);
686 export_one("GIT_AUTHOR_EMAIL", author
.mail_begin
, author
.mail_end
, 0);
687 export_one("GIT_AUTHOR_DATE", author
.date_begin
, author
.tz_end
, '@');
693 static int author_date_is_interesting(void)
695 return author_message
|| force_date
;
698 #ifndef WITH_BREAKING_CHANGES
699 static void adjust_comment_line_char(const struct strbuf
*sb
)
701 char candidates
[] = "#;@!$%^&|:";
706 /* Ignore comment chars in trailing comments (e.g., Conflicts:) */
707 cutoff
= sb
->len
- ignored_log_message_bytes(sb
->buf
, sb
->len
);
709 if (!memchr(sb
->buf
, candidates
[0], sb
->len
)) {
710 free(comment_line_str_to_free
);
711 comment_line_str
= comment_line_str_to_free
=
712 xstrfmt("%c", candidates
[0]);
717 candidate
= strchr(candidates
, *p
);
720 for (p
= sb
->buf
; p
+ 1 < sb
->buf
+ cutoff
; p
++) {
721 if ((p
[0] == '\n' || p
[0] == '\r') && p
[1]) {
722 candidate
= strchr(candidates
, p
[1]);
728 for (p
= candidates
; *p
== ' '; p
++)
731 die(_("unable to select a comment character that is not used\n"
732 "in the current commit message"));
733 free(comment_line_str_to_free
);
734 comment_line_str
= comment_line_str_to_free
= xstrfmt("%c", *p
);
736 #endif /* !WITH_BREAKING_CHANGES */
738 static void prepare_amend_commit(struct commit
*commit
, struct strbuf
*sb
,
739 struct pretty_print_context
*ctx
)
741 const char *buffer
, *subject
, *fmt
;
743 buffer
= repo_get_commit_buffer(the_repository
, commit
, NULL
);
744 find_commit_subject(buffer
, &subject
);
746 * If we amend the 'amend!' commit then we don't want to
747 * duplicate the subject line.
749 fmt
= starts_with(subject
, "amend!") ? "%b" : "%B";
750 repo_format_commit_message(the_repository
, commit
, fmt
, sb
, ctx
);
751 repo_unuse_commit_buffer(the_repository
, commit
, buffer
);
754 static void change_data_free(void *util
, const char *str UNUSED
)
756 struct wt_status_change_data
*d
= util
;
757 free(d
->rename_source
);
761 static int prepare_to_commit(const char *index_file
, const char *prefix
,
762 struct commit
*current_head
,
764 struct strbuf
*author_ident
)
767 struct strbuf committer_ident
= STRBUF_INIT
;
769 struct strbuf sb
= STRBUF_INIT
;
770 const char *hook_arg1
= NULL
;
771 const char *hook_arg2
= NULL
;
772 int clean_message_contents
= (cleanup_mode
!= COMMIT_MSG_CLEANUP_NONE
);
773 int old_display_comment_prefix
;
776 /* This checks and barfs if author is badly specified */
777 determine_author_info(author_ident
);
779 if (!no_verify
&& run_commit_hook(use_editor
, index_file
, &invoked_hook
,
783 if (squash_message
) {
785 * Insert the proper subject line before other commit
786 * message options add their content.
788 if (use_message
&& !strcmp(use_message
, squash_message
))
789 strbuf_addstr(&sb
, "squash! ");
791 struct pretty_print_context ctx
= {0};
793 c
= lookup_commit_reference_by_name(squash_message
);
795 die(_("could not lookup commit '%s'"), squash_message
);
796 ctx
.output_encoding
= get_commit_output_encoding();
797 repo_format_commit_message(the_repository
, c
,
798 "squash! %s\n\n", &sb
,
803 if (have_option_m
&& !fixup_message
) {
804 strbuf_addbuf(&sb
, &message
);
805 hook_arg1
= "message";
806 } else if (logfile
&& !strcmp(logfile
, "-")) {
808 fprintf(stderr
, _("(reading log message from standard input)\n"));
809 if (strbuf_read(&sb
, 0, 0) < 0)
810 die_errno(_("could not read log from standard input"));
811 hook_arg1
= "message";
812 } else if (logfile
) {
813 if (strbuf_read_file(&sb
, logfile
, 0) < 0)
814 die_errno(_("could not read log file '%s'"),
816 hook_arg1
= "message";
817 } else if (use_message
) {
819 buffer
= strstr(use_message_buffer
, "\n\n");
821 strbuf_addstr(&sb
, skip_blank_lines(buffer
+ 2));
822 hook_arg1
= "commit";
823 hook_arg2
= use_message
;
824 } else if (fixup_message
) {
825 struct pretty_print_context ctx
= {0};
826 struct commit
*commit
;
828 commit
= lookup_commit_reference_by_name(fixup_commit
);
830 die(_("could not lookup commit '%s'"), fixup_commit
);
831 ctx
.output_encoding
= get_commit_output_encoding();
832 fmt
= xstrfmt("%s! %%s\n\n", fixup_prefix
);
833 repo_format_commit_message(the_repository
, commit
, fmt
, &sb
,
836 hook_arg1
= "message";
839 * Only `-m` commit message option is checked here, as
840 * it supports `--fixup` to append the commit message.
842 * The other commit message options `-c`/`-C`/`-F` are
843 * incompatible with all the forms of `--fixup` and
844 * have already errored out while parsing the `git commit`
847 if (have_option_m
&& !strcmp(fixup_prefix
, "fixup"))
848 strbuf_addbuf(&sb
, &message
);
850 if (!strcmp(fixup_prefix
, "amend")) {
852 die(_("options '%s' and '%s:%s' cannot be used together"), "-m", "--fixup", fixup_message
);
853 prepare_amend_commit(commit
, &sb
, &ctx
);
855 } else if (!stat(git_path_merge_msg(the_repository
), &statbuf
)) {
856 size_t merge_msg_start
;
859 * prepend SQUASH_MSG here if it exists and a
860 * "merge --squash" was originally performed
862 if (!stat(git_path_squash_msg(the_repository
), &statbuf
)) {
863 if (strbuf_read_file(&sb
, git_path_squash_msg(the_repository
), 0) < 0)
864 die_errno(_("could not read SQUASH_MSG"));
865 hook_arg1
= "squash";
869 merge_msg_start
= sb
.len
;
870 if (strbuf_read_file(&sb
, git_path_merge_msg(the_repository
), 0) < 0)
871 die_errno(_("could not read MERGE_MSG"));
873 if (cleanup_mode
== COMMIT_MSG_CLEANUP_SCISSORS
&&
874 wt_status_locate_end(sb
.buf
+ merge_msg_start
,
875 sb
.len
- merge_msg_start
) <
876 sb
.len
- merge_msg_start
)
877 s
->added_cut_line
= 1;
878 } else if (!stat(git_path_squash_msg(the_repository
), &statbuf
)) {
879 if (strbuf_read_file(&sb
, git_path_squash_msg(the_repository
), 0) < 0)
880 die_errno(_("could not read SQUASH_MSG"));
881 hook_arg1
= "squash";
882 } else if (template_file
) {
883 if (strbuf_read_file(&sb
, template_file
, 0) < 0)
884 die_errno(_("could not read '%s'"), template_file
);
885 hook_arg1
= "template";
886 clean_message_contents
= 0;
890 * The remaining cases don't modify the template message, but
891 * just set the argument(s) to the prepare-commit-msg hook.
893 else if (whence
== FROM_MERGE
)
895 else if (is_from_cherry_pick(whence
) || whence
== FROM_REBASE_PICK
) {
896 hook_arg1
= "commit";
897 hook_arg2
= "CHERRY_PICK_HEAD";
900 if (squash_message
) {
902 * If squash_commit was used for the commit subject,
903 * then we're possibly hijacking other commit log options.
904 * Reset the hook args to tell the real story.
906 hook_arg1
= "message";
910 s
->fp
= fopen_for_writing(git_path_commit_editmsg());
912 die_errno(_("could not open '%s'"), git_path_commit_editmsg());
914 /* Ignore status.displayCommentPrefix: we do need comments in COMMIT_EDITMSG. */
915 old_display_comment_prefix
= s
->display_comment_prefix
;
916 s
->display_comment_prefix
= 1;
919 * Most hints are counter-productive when the commit has
924 if (clean_message_contents
)
925 strbuf_stripspace(&sb
, NULL
);
928 append_signoff(&sb
, ignored_log_message_bytes(sb
.buf
, sb
.len
), 0);
930 if (fwrite(sb
.buf
, 1, sb
.len
, s
->fp
) < sb
.len
)
931 die_errno(_("could not write commit template"));
933 #ifndef WITH_BREAKING_CHANGES
934 if (auto_comment_line_char
)
935 adjust_comment_line_char(&sb
);
936 #endif /* !WITH_BREAKING_CHANGES */
939 /* This checks if committer ident is explicitly given */
940 strbuf_addstr(&committer_ident
, git_committer_info(IDENT_STRICT
));
941 if (use_editor
&& include_status
) {
943 enum git_colorbool saved_color_setting
;
944 struct ident_split ci
, ai
;
945 const char *hint_cleanup_all
= allow_empty_message
?
946 _("Please enter the commit message for your changes."
947 " Lines starting\nwith '%s' will be ignored.\n") :
948 _("Please enter the commit message for your changes."
949 " Lines starting\nwith '%s' will be ignored, and an empty"
950 " message aborts the commit.\n");
951 const char *hint_cleanup_space
= allow_empty_message
?
952 _("Please enter the commit message for your changes."
954 "with '%s' will be kept; you may remove them"
955 " yourself if you want to.\n") :
956 _("Please enter the commit message for your changes."
958 "with '%s' will be kept; you may remove them"
959 " yourself if you want to.\n"
960 "An empty message aborts the commit.\n");
961 if (whence
!= FROM_COMMIT
) {
962 if (cleanup_mode
== COMMIT_MSG_CLEANUP_SCISSORS
)
963 wt_status_add_cut_line(s
);
966 whence
== FROM_MERGE
?
968 "It looks like you may be committing a merge.\n"
969 "If this is not correct, please run\n"
970 " git update-ref -d MERGE_HEAD\n"
971 "and try again.\n") :
973 "It looks like you may be committing a cherry-pick.\n"
974 "If this is not correct, please run\n"
975 " git update-ref -d CHERRY_PICK_HEAD\n"
976 "and try again.\n"));
979 fprintf(s
->fp
, "\n");
980 if (cleanup_mode
== COMMIT_MSG_CLEANUP_ALL
)
981 status_printf(s
, GIT_COLOR_NORMAL
, hint_cleanup_all
, comment_line_str
);
982 else if (cleanup_mode
== COMMIT_MSG_CLEANUP_SCISSORS
) {
983 if (whence
== FROM_COMMIT
)
984 wt_status_add_cut_line(s
);
985 } else /* COMMIT_MSG_CLEANUP_SPACE, that is. */
986 status_printf(s
, GIT_COLOR_NORMAL
, hint_cleanup_space
, comment_line_str
);
989 * These should never fail because they come from our own
990 * fmt_ident. They may fail the sane_ident test, but we know
991 * that the name and mail pointers will at least be valid,
992 * which is enough for our tests and printing here.
994 assert_split_ident(&ai
, author_ident
);
995 assert_split_ident(&ci
, &committer_ident
);
997 if (ident_cmp(&ai
, &ci
))
998 status_printf_ln(s
, GIT_COLOR_NORMAL
,
1000 "Author: %.*s <%.*s>"),
1001 ident_shown
++ ? "" : "\n",
1002 (int)(ai
.name_end
- ai
.name_begin
), ai
.name_begin
,
1003 (int)(ai
.mail_end
- ai
.mail_begin
), ai
.mail_begin
);
1005 if (author_date_is_interesting())
1006 status_printf_ln(s
, GIT_COLOR_NORMAL
,
1009 ident_shown
++ ? "" : "\n",
1010 show_ident_date(&ai
, DATE_MODE(NORMAL
)));
1012 if (!committer_ident_sufficiently_given())
1013 status_printf_ln(s
, GIT_COLOR_NORMAL
,
1015 "Committer: %.*s <%.*s>"),
1016 ident_shown
++ ? "" : "\n",
1017 (int)(ci
.name_end
- ci
.name_begin
), ci
.name_begin
,
1018 (int)(ci
.mail_end
- ci
.mail_begin
), ci
.mail_begin
);
1020 status_printf_ln(s
, GIT_COLOR_NORMAL
, "%s", ""); /* Add new line for clarity */
1022 saved_color_setting
= s
->use_color
;
1023 s
->use_color
= GIT_COLOR_NEVER
;
1024 committable
= run_status(s
->fp
, index_file
, prefix
, 1, s
);
1025 s
->use_color
= saved_color_setting
;
1026 string_list_clear_func(&s
->change
, change_data_free
);
1028 struct object_id oid
;
1029 const char *parent
= "HEAD";
1031 if (!the_repository
->index
->initialized
&& repo_read_index(the_repository
) < 0)
1032 die(_("Cannot read index"));
1037 if (repo_get_oid(the_repository
, parent
, &oid
)) {
1040 /* TODO: audit for interaction with sparse-index. */
1041 ensure_full_index(the_repository
->index
);
1042 for (i
= 0; i
< the_repository
->index
->cache_nr
; i
++)
1043 if (ce_intent_to_add(the_repository
->index
->cache
[i
]))
1045 committable
= the_repository
->index
->cache_nr
> ita_nr
;
1048 * Unless the user did explicitly request a submodule
1049 * ignore mode by passing a command line option we do
1050 * not ignore any changed submodule SHA-1s when
1051 * comparing index and parent, no matter what is
1052 * configured. Otherwise we won't commit any
1053 * submodules which were manually staged, which would
1054 * be really confusing.
1056 struct diff_flags flags
= DIFF_FLAGS_INIT
;
1057 flags
.override_submodule_config
= 1;
1058 if (ignore_submodule_arg
&&
1059 !strcmp(ignore_submodule_arg
, "all"))
1060 flags
.ignore_submodules
= 1;
1061 committable
= index_differs_from(the_repository
,
1065 strbuf_release(&committer_ident
);
1069 if (trailer_args
.nr
) {
1070 if (amend_file_with_trailers(git_path_commit_editmsg(), &trailer_args
))
1071 die(_("unable to pass trailers to --trailers"));
1072 strvec_clear(&trailer_args
);
1076 * Reject an attempt to record a non-merge empty commit without
1077 * explicit --allow-empty. In the cherry-pick case, it may be
1078 * empty due to conflict resolution, which the user should okay.
1080 if (!committable
&& whence
!= FROM_MERGE
&& !allow_empty
&&
1081 !(amend
&& is_a_merge(current_head
))) {
1082 s
->hints
= advice_enabled(ADVICE_STATUS_HINTS
);
1083 s
->display_comment_prefix
= old_display_comment_prefix
;
1084 run_status(stdout
, index_file
, prefix
, 0, s
);
1086 fputs(_(empty_amend_advice
), stderr
);
1087 else if (is_from_cherry_pick(whence
) ||
1088 whence
== FROM_REBASE_PICK
) {
1089 fputs(_(empty_cherry_pick_advice
), stderr
);
1090 if (whence
== FROM_CHERRY_PICK_SINGLE
)
1091 fputs(_(empty_cherry_pick_advice_single
), stderr
);
1092 else if (whence
== FROM_CHERRY_PICK_MULTI
)
1093 fputs(_(empty_cherry_pick_advice_multi
), stderr
);
1095 fputs(_(empty_rebase_pick_advice
), stderr
);
1100 if (!no_verify
&& invoked_hook
) {
1102 * Re-read the index as the pre-commit-commit hook was invoked
1103 * and could have updated it. We must do this before we invoke
1104 * the editor and after we invoke run_status above.
1106 discard_index(the_repository
->index
);
1108 read_index_from(the_repository
->index
, index_file
, repo_get_git_dir(the_repository
));
1110 if (cache_tree_update(the_repository
->index
, 0)) {
1111 error(_("Error building trees"));
1115 if (run_commit_hook(use_editor
, index_file
, NULL
, "prepare-commit-msg",
1116 git_path_commit_editmsg(), hook_arg1
, hook_arg2
, NULL
))
1120 struct strvec env
= STRVEC_INIT
;
1122 strvec_pushf(&env
, "GIT_INDEX_FILE=%s", index_file
);
1123 if (launch_editor(git_path_commit_editmsg(), NULL
, env
.v
)) {
1125 _("Please supply the message using either -m or -F option.\n"));
1132 run_commit_hook(use_editor
, index_file
, NULL
, "commit-msg",
1133 git_path_commit_editmsg(), NULL
)) {
1140 static const char *find_author_by_nickname(const char *name
)
1142 struct rev_info revs
;
1143 struct commit
*commit
;
1144 struct strbuf buf
= STRBUF_INIT
;
1148 repo_init_revisions(the_repository
, &revs
, NULL
);
1149 strbuf_addf(&buf
, "--author=%s", name
);
1154 setup_revisions(ac
, av
, &revs
, NULL
);
1155 revs
.mailmap
= xmalloc(sizeof(struct string_list
));
1156 string_list_init_nodup(revs
.mailmap
);
1157 read_mailmap(revs
.mailmap
);
1159 if (prepare_revision_walk(&revs
))
1160 die(_("revision walk setup failed"));
1161 commit
= get_revision(&revs
);
1163 struct pretty_print_context ctx
= {0};
1164 ctx
.date_mode
.type
= DATE_NORMAL
;
1165 strbuf_release(&buf
);
1166 repo_format_commit_message(the_repository
, commit
,
1167 "%aN <%aE>", &buf
, &ctx
);
1168 release_revisions(&revs
);
1169 return strbuf_detach(&buf
, NULL
);
1171 die(_("--author '%s' is not 'Name <email>' and matches no existing author"), name
);
1174 static void handle_ignored_arg(struct wt_status
*s
)
1177 ; /* default already initialized */
1178 else if (!strcmp(ignored_arg
, "traditional"))
1179 s
->show_ignored_mode
= SHOW_TRADITIONAL_IGNORED
;
1180 else if (!strcmp(ignored_arg
, "no"))
1181 s
->show_ignored_mode
= SHOW_NO_IGNORED
;
1182 else if (!strcmp(ignored_arg
, "matching"))
1183 s
->show_ignored_mode
= SHOW_MATCHING_IGNORED
;
1185 die(_("Invalid ignored mode '%s'"), ignored_arg
);
1188 static enum untracked_status_type
parse_untracked_setting_name(const char *u
)
1191 * Please update $__git_untracked_file_modes in
1192 * git-completion.bash when you add new options
1194 switch (git_parse_maybe_bool(u
)) {
1205 if (!strcmp(u
, "no"))
1206 return SHOW_NO_UNTRACKED_FILES
;
1207 else if (!strcmp(u
, "normal"))
1208 return SHOW_NORMAL_UNTRACKED_FILES
;
1209 else if (!strcmp(u
, "all"))
1210 return SHOW_ALL_UNTRACKED_FILES
;
1212 return SHOW_UNTRACKED_FILES_ERROR
;
1215 static void handle_untracked_files_arg(struct wt_status
*s
)
1217 enum untracked_status_type u
;
1219 if (!untracked_files_arg
)
1220 return; /* default already initialized */
1222 u
= parse_untracked_setting_name(untracked_files_arg
);
1223 if (u
== SHOW_UNTRACKED_FILES_ERROR
)
1224 die(_("Invalid untracked files mode '%s'"),
1225 untracked_files_arg
);
1226 s
->show_untracked_files
= u
;
1229 static const char *read_commit_message(const char *name
)
1231 const char *out_enc
;
1232 struct commit
*commit
;
1234 commit
= lookup_commit_reference_by_name(name
);
1236 die(_("could not lookup commit '%s'"), name
);
1237 out_enc
= get_commit_output_encoding();
1238 return repo_logmsg_reencode(the_repository
, commit
, NULL
, out_enc
);
1242 * Enumerate what needs to be propagated when --porcelain
1243 * is not in effect here.
1245 static struct status_deferred_config
{
1246 enum wt_status_format status_format
;
1248 enum ahead_behind_flags ahead_behind
;
1249 } status_deferred_config
= {
1250 STATUS_FORMAT_UNSPECIFIED
,
1251 -1, /* unspecified */
1252 AHEAD_BEHIND_UNSPECIFIED
,
1255 static void finalize_deferred_config(struct wt_status
*s
)
1257 int use_deferred_config
= (status_format
!= STATUS_FORMAT_PORCELAIN
&&
1258 status_format
!= STATUS_FORMAT_PORCELAIN_V2
&&
1259 !s
->null_termination
);
1261 if (s
->null_termination
) {
1262 if (status_format
== STATUS_FORMAT_NONE
||
1263 status_format
== STATUS_FORMAT_UNSPECIFIED
)
1264 status_format
= STATUS_FORMAT_PORCELAIN
;
1265 else if (status_format
== STATUS_FORMAT_LONG
)
1266 die(_("options '%s' and '%s' cannot be used together"), "--long", "-z");
1269 if (use_deferred_config
&& status_format
== STATUS_FORMAT_UNSPECIFIED
)
1270 status_format
= status_deferred_config
.status_format
;
1271 if (status_format
== STATUS_FORMAT_UNSPECIFIED
)
1272 status_format
= STATUS_FORMAT_NONE
;
1274 if (use_deferred_config
&& s
->show_branch
< 0)
1275 s
->show_branch
= status_deferred_config
.show_branch
;
1276 if (s
->show_branch
< 0)
1280 * If the user did not give a "--[no]-ahead-behind" command
1281 * line argument *AND* we will print in a human-readable format
1282 * (short, long etc.) then we inherit from the status.aheadbehind
1283 * config setting. In all other cases (and porcelain V[12] formats
1284 * in particular), we inherit _FULL for backwards compatibility.
1286 if (use_deferred_config
&&
1287 s
->ahead_behind_flags
== AHEAD_BEHIND_UNSPECIFIED
)
1288 s
->ahead_behind_flags
= status_deferred_config
.ahead_behind
;
1290 if (s
->ahead_behind_flags
== AHEAD_BEHIND_UNSPECIFIED
)
1291 s
->ahead_behind_flags
= AHEAD_BEHIND_FULL
;
1294 static void check_fixup_reword_options(int argc
, const char *argv
[]) {
1295 if (whence
!= FROM_COMMIT
) {
1296 if (whence
== FROM_MERGE
)
1297 die(_("You are in the middle of a merge -- cannot reword."));
1298 else if (is_from_cherry_pick(whence
))
1299 die(_("You are in the middle of a cherry-pick -- cannot reword."));
1302 die(_("reword option of '%s' and path '%s' cannot be used together"), "--fixup", *argv
);
1303 if (patch_interactive
|| interactive
|| all
|| also
|| only
)
1304 die(_("reword option of '%s' and '%s' cannot be used together"),
1305 "--fixup", "--patch/--interactive/--all/--include/--only");
1308 static int parse_and_validate_options(int argc
, const char *argv
[],
1309 const struct option
*options
,
1310 const char * const usage
[],
1312 struct commit
*current_head
,
1313 struct wt_status
*s
)
1315 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
1316 finalize_deferred_config(s
);
1318 if (force_author
&& !strchr(force_author
, '>'))
1319 force_author
= find_author_by_nickname(force_author
);
1321 if (force_author
&& renew_authorship
)
1322 die(_("options '%s' and '%s' cannot be used together"), "--reset-author", "--author");
1324 if (logfile
|| have_option_m
|| use_message
)
1327 /* Sanity check options */
1328 if (amend
&& !current_head
)
1329 die(_("You have nothing to amend."));
1330 if (amend
&& whence
!= FROM_COMMIT
) {
1331 if (whence
== FROM_MERGE
)
1332 die(_("You are in the middle of a merge -- cannot amend."));
1333 else if (is_from_cherry_pick(whence
))
1334 die(_("You are in the middle of a cherry-pick -- cannot amend."));
1335 else if (whence
== FROM_REBASE_PICK
)
1336 die(_("You are in the middle of a rebase -- cannot amend."));
1338 if (fixup_message
&& squash_message
)
1339 die(_("options '%s' and '%s' cannot be used together"), "--squash", "--fixup");
1340 die_for_incompatible_opt4(!!use_message
, "-C",
1341 !!edit_message
, "-c",
1343 !!fixup_message
, "--fixup");
1344 die_for_incompatible_opt4(have_option_m
, "-m",
1345 !!edit_message
, "-c",
1346 !!use_message
, "-C",
1348 if (use_message
|| edit_message
|| logfile
||fixup_message
|| have_option_m
)
1349 FREE_AND_NULL(template_file
);
1351 use_message
= edit_message
;
1352 if (amend
&& !use_message
&& !fixup_message
)
1353 use_message
= "HEAD";
1354 if (!use_message
&& !is_from_cherry_pick(whence
) &&
1355 !is_from_rebase(whence
) && renew_authorship
)
1356 die(_("--reset-author can be used only with -C, -c or --amend."));
1358 use_message_buffer
= read_commit_message(use_message
);
1359 if (!renew_authorship
) {
1360 author_message
= use_message
;
1361 author_message_buffer
= use_message_buffer
;
1364 if ((is_from_cherry_pick(whence
) || whence
== FROM_REBASE_PICK
) &&
1365 !renew_authorship
) {
1366 author_message
= "CHERRY_PICK_HEAD";
1367 author_message_buffer
= read_commit_message(author_message
);
1370 if (patch_interactive
)
1373 die_for_incompatible_opt4(also
, "-i/--include",
1376 interactive
, "--interactive/-p/--patch");
1377 if (fixup_message
) {
1379 * We limit --fixup's suboptions to only alpha characters.
1380 * If the first character after a run of alpha is colon,
1381 * then the part before the colon may be a known suboption
1382 * name like `amend` or `reword`, or a misspelt suboption
1383 * name. In either case, we treat it as
1384 * --fixup=<suboption>:<arg>.
1386 * Otherwise, we are dealing with --fixup=<commit>.
1388 char *p
= fixup_message
;
1391 if (p
> fixup_message
&& *p
== ':') {
1393 fixup_commit
= p
+ 1;
1394 if (!strcmp("amend", fixup_message
) ||
1395 !strcmp("reword", fixup_message
)) {
1396 fixup_prefix
= "amend";
1398 if (*fixup_message
== 'r') {
1399 check_fixup_reword_options(argc
, argv
);
1403 die(_("unknown option: --fixup=%s:%s"), fixup_message
, fixup_commit
);
1406 fixup_commit
= fixup_message
;
1407 fixup_prefix
= "fixup";
1413 use_editor
= edit_flag
;
1415 handle_untracked_files_arg(s
);
1417 if (all
&& argc
> 0)
1418 die(_("paths '%s ...' with -a does not make sense"),
1421 if (status_format
!= STATUS_FORMAT_NONE
)
1427 static int dry_run_commit(const char **argv
, const char *prefix
,
1428 const struct commit
*current_head
, struct wt_status
*s
)
1431 const char *index_file
;
1433 index_file
= prepare_index(argv
, prefix
, current_head
, 1);
1434 committable
= run_status(stdout
, index_file
, prefix
, 0, s
);
1435 rollback_index_files();
1437 return committable
? 0 : 1;
1440 define_list_config_array_extra(color_status_slots
, {"added"});
1442 static int parse_status_slot(const char *slot
)
1444 if (!strcasecmp(slot
, "added"))
1445 return WT_STATUS_UPDATED
;
1447 return LOOKUP_CONFIG(color_status_slots
, slot
);
1450 static int git_status_config(const char *k
, const char *v
,
1451 const struct config_context
*ctx
, void *cb
)
1453 struct wt_status
*s
= cb
;
1454 const char *slot_name
;
1456 if (starts_with(k
, "column."))
1457 return git_column_config(k
, v
, "status", &s
->colopts
);
1458 if (!strcmp(k
, "status.submodulesummary")) {
1460 s
->submodule_summary
= git_config_bool_or_int(k
, v
, ctx
->kvi
,
1462 if (is_bool
&& s
->submodule_summary
)
1463 s
->submodule_summary
= -1;
1466 if (!strcmp(k
, "status.short")) {
1467 if (git_config_bool(k
, v
))
1468 status_deferred_config
.status_format
= STATUS_FORMAT_SHORT
;
1470 status_deferred_config
.status_format
= STATUS_FORMAT_NONE
;
1473 if (!strcmp(k
, "status.branch")) {
1474 status_deferred_config
.show_branch
= git_config_bool(k
, v
);
1477 if (!strcmp(k
, "status.aheadbehind")) {
1478 status_deferred_config
.ahead_behind
= git_config_bool(k
, v
);
1481 if (!strcmp(k
, "status.showstash")) {
1482 s
->show_stash
= git_config_bool(k
, v
);
1485 if (!strcmp(k
, "status.color") || !strcmp(k
, "color.status")) {
1486 s
->use_color
= git_config_colorbool(k
, v
);
1489 if (!strcmp(k
, "status.displaycommentprefix")) {
1490 s
->display_comment_prefix
= git_config_bool(k
, v
);
1493 if (skip_prefix(k
, "status.color.", &slot_name
) ||
1494 skip_prefix(k
, "color.status.", &slot_name
)) {
1495 int slot
= parse_status_slot(slot_name
);
1499 return config_error_nonbool(k
);
1500 return color_parse(v
, s
->color_palette
[slot
]);
1502 if (!strcmp(k
, "status.relativepaths")) {
1503 s
->relative_paths
= git_config_bool(k
, v
);
1506 if (!strcmp(k
, "status.showuntrackedfiles")) {
1507 enum untracked_status_type u
;
1509 u
= parse_untracked_setting_name(v
);
1510 if (u
== SHOW_UNTRACKED_FILES_ERROR
)
1511 return error(_("Invalid untracked files mode '%s'"), v
);
1512 s
->show_untracked_files
= u
;
1515 if (!strcmp(k
, "diff.renamelimit")) {
1516 if (s
->rename_limit
== -1)
1517 s
->rename_limit
= git_config_int(k
, v
, ctx
->kvi
);
1520 if (!strcmp(k
, "status.renamelimit")) {
1521 s
->rename_limit
= git_config_int(k
, v
, ctx
->kvi
);
1524 if (!strcmp(k
, "diff.renames")) {
1525 if (s
->detect_rename
== -1)
1526 s
->detect_rename
= git_config_rename(k
, v
);
1529 if (!strcmp(k
, "status.renames")) {
1530 s
->detect_rename
= git_config_rename(k
, v
);
1533 return git_diff_ui_config(k
, v
, ctx
, NULL
);
1536 int cmd_status(int argc
,
1539 struct repository
*repo UNUSED
)
1541 static int no_renames
= -1;
1542 static const char *rename_score_arg
= (const char *)-1;
1543 static struct wt_status s
;
1544 unsigned int progress_flag
= 0;
1546 struct object_id oid
;
1547 static struct option builtin_status_options
[] = {
1548 OPT__VERBOSE(&verbose
, N_("be verbose")),
1549 OPT_SET_INT('s', "short", &status_format
,
1550 N_("show status concisely"), STATUS_FORMAT_SHORT
),
1551 OPT_BOOL('b', "branch", &s
.show_branch
,
1552 N_("show branch information")),
1553 OPT_BOOL(0, "show-stash", &s
.show_stash
,
1554 N_("show stash information")),
1555 OPT_BOOL(0, "ahead-behind", &s
.ahead_behind_flags
,
1556 N_("compute full ahead/behind values")),
1557 OPT_CALLBACK_F(0, "porcelain", &status_format
,
1558 N_("version"), N_("machine-readable output"),
1559 PARSE_OPT_OPTARG
, opt_parse_porcelain
),
1560 OPT_SET_INT(0, "long", &status_format
,
1561 N_("show status in long format (default)"),
1562 STATUS_FORMAT_LONG
),
1563 OPT_BOOL('z', "null", &s
.null_termination
,
1564 N_("terminate entries with NUL")),
1566 .type
= OPTION_STRING
,
1568 .long_name
= "untracked-files",
1569 .value
= &untracked_files_arg
,
1571 .help
= N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1572 .flags
= PARSE_OPT_OPTARG
,
1573 .defval
= (intptr_t)"all",
1576 .type
= OPTION_STRING
,
1577 .long_name
= "ignored",
1578 .value
= &ignored_arg
,
1580 .help
= N_("show ignored files, optional modes: traditional, matching, no. (Default: traditional)"),
1581 .flags
= PARSE_OPT_OPTARG
,
1582 .defval
= (intptr_t)"traditional",
1585 .type
= OPTION_STRING
,
1586 .long_name
= "ignore-submodules",
1587 .value
= &ignore_submodule_arg
,
1589 .help
= N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
1590 .flags
= PARSE_OPT_OPTARG
,
1591 .defval
= (intptr_t)"all",
1593 OPT_COLUMN(0, "column", &s
.colopts
, N_("list untracked files in columns")),
1594 OPT_BOOL(0, "no-renames", &no_renames
, N_("do not detect renames")),
1595 OPT_CALLBACK_F('M', "find-renames", &rename_score_arg
,
1596 N_("n"), N_("detect renames, optionally set similarity index"),
1597 PARSE_OPT_OPTARG
| PARSE_OPT_NONEG
, opt_parse_rename_score
),
1601 show_usage_with_options_if_asked(argc
, argv
,
1602 builtin_status_usage
, builtin_status_options
);
1604 prepare_repo_settings(the_repository
);
1605 the_repository
->settings
.command_requires_full_index
= 0;
1607 status_init_config(&s
, git_status_config
);
1608 argc
= parse_options(argc
, argv
, prefix
,
1609 builtin_status_options
,
1610 builtin_status_usage
, 0);
1611 finalize_colopts(&s
.colopts
, -1);
1612 finalize_deferred_config(&s
);
1614 handle_untracked_files_arg(&s
);
1615 handle_ignored_arg(&s
);
1617 if (s
.show_ignored_mode
== SHOW_MATCHING_IGNORED
&&
1618 s
.show_untracked_files
== SHOW_NO_UNTRACKED_FILES
)
1619 die(_("Unsupported combination of ignored and untracked-files arguments"));
1621 parse_pathspec(&s
.pathspec
, 0,
1622 PATHSPEC_PREFER_FULL
,
1625 if (status_format
!= STATUS_FORMAT_PORCELAIN
&&
1626 status_format
!= STATUS_FORMAT_PORCELAIN_V2
)
1627 progress_flag
= REFRESH_PROGRESS
;
1628 repo_read_index(the_repository
);
1629 refresh_index(the_repository
->index
,
1630 REFRESH_QUIET
|REFRESH_UNMERGED
|progress_flag
,
1631 &s
.pathspec
, NULL
, NULL
);
1633 if (use_optional_locks())
1634 fd
= repo_hold_locked_index(the_repository
, &index_lock
, 0);
1638 s
.is_initial
= repo_get_oid(the_repository
, s
.reference
, &oid
) ? 1 : 0;
1640 oidcpy(&s
.oid_commit
, &oid
);
1642 s
.ignore_submodule_arg
= ignore_submodule_arg
;
1643 s
.status_format
= status_format
;
1644 s
.verbose
= verbose
;
1645 if (no_renames
!= -1)
1646 s
.detect_rename
= !no_renames
;
1647 if ((intptr_t)rename_score_arg
!= -1) {
1648 if (s
.detect_rename
< DIFF_DETECT_RENAME
)
1649 s
.detect_rename
= DIFF_DETECT_RENAME
;
1650 if (rename_score_arg
)
1651 s
.rename_score
= parse_rename_score(&rename_score_arg
);
1654 wt_status_collect(&s
);
1657 repo_update_index_if_able(the_repository
, &index_lock
);
1659 if (s
.relative_paths
)
1662 wt_status_print(&s
);
1663 wt_status_collect_free_buffers(&s
);
1668 static int git_commit_config(const char *k
, const char *v
,
1669 const struct config_context
*ctx
, void *cb
)
1671 struct wt_status
*s
= cb
;
1673 if (!strcmp(k
, "commit.template"))
1674 return git_config_pathname(&template_file
, k
, v
);
1675 if (!strcmp(k
, "commit.status")) {
1676 include_status
= git_config_bool(k
, v
);
1679 if (!strcmp(k
, "commit.cleanup")) {
1680 FREE_AND_NULL(cleanup_config
);
1681 return git_config_string(&cleanup_config
, k
, v
);
1683 if (!strcmp(k
, "commit.gpgsign")) {
1684 sign_commit
= git_config_bool(k
, v
) ? "" : NULL
;
1687 if (!strcmp(k
, "commit.verbose")) {
1689 config_commit_verbose
= git_config_bool_or_int(k
, v
, ctx
->kvi
,
1694 return git_status_config(k
, v
, ctx
, s
);
1697 int cmd_commit(int argc
,
1700 struct repository
*repo UNUSED
)
1702 static struct wt_status s
;
1703 static const char *cleanup_arg
= NULL
;
1704 static struct option builtin_commit_options
[] = {
1705 OPT__QUIET(&quiet
, N_("suppress summary after successful commit")),
1706 OPT__VERBOSE(&verbose
, N_("show diff in commit message template")),
1708 OPT_GROUP(N_("Commit message options")),
1709 OPT_FILENAME('F', "file", &logfile
, N_("read message from file")),
1710 OPT_STRING(0, "author", &force_author
, N_("author"), N_("override author for commit")),
1711 OPT_STRING(0, "date", &force_date
, N_("date"), N_("override date for commit")),
1712 OPT_CALLBACK('m', "message", &message
, N_("message"), N_("commit message"), opt_parse_m
),
1713 OPT_STRING('c', "reedit-message", &edit_message
, N_("commit"), N_("reuse and edit message from specified commit")),
1714 OPT_STRING('C', "reuse-message", &use_message
, N_("commit"), N_("reuse message from specified commit")),
1716 * TRANSLATORS: Leave "[(amend|reword):]" as-is,
1717 * and only translate <commit>.
1719 OPT_STRING(0, "fixup", &fixup_message
, N_("[(amend|reword):]commit"), N_("use autosquash formatted message to fixup or amend/reword specified commit")),
1720 OPT_STRING(0, "squash", &squash_message
, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
1721 OPT_BOOL(0, "reset-author", &renew_authorship
, N_("the commit is authored by me now (used with -C/-c/--amend)")),
1722 OPT_PASSTHRU_ARGV(0, "trailer", &trailer_args
, N_("trailer"), N_("add custom trailer(s)"), PARSE_OPT_NONEG
),
1723 OPT_BOOL('s', "signoff", &signoff
, N_("add a Signed-off-by trailer")),
1724 OPT_FILENAME('t', "template", &template_file
, N_("use specified template file")),
1725 OPT_BOOL('e', "edit", &edit_flag
, N_("force edit of commit")),
1726 OPT_CLEANUP(&cleanup_arg
),
1727 OPT_BOOL(0, "status", &include_status
, N_("include status in commit message template")),
1729 .type
= OPTION_STRING
,
1731 .long_name
= "gpg-sign",
1732 .value
= &sign_commit
,
1733 .argh
= N_("key-id"),
1734 .help
= N_("GPG sign commit"),
1735 .flags
= PARSE_OPT_OPTARG
,
1736 .defval
= (intptr_t) "",
1738 /* end commit message options */
1740 OPT_GROUP(N_("Commit contents options")),
1741 OPT_BOOL('a', "all", &all
, N_("commit all changed files")),
1742 OPT_BOOL('i', "include", &also
, N_("add specified files to index for commit")),
1743 OPT_BOOL(0, "interactive", &interactive
, N_("interactively add files")),
1744 OPT_BOOL('p', "patch", &patch_interactive
, N_("interactively add changes")),
1745 OPT_DIFF_UNIFIED(&add_p_opt
.context
),
1746 OPT_DIFF_INTERHUNK_CONTEXT(&add_p_opt
.interhunkcontext
),
1747 OPT_BOOL('o', "only", &only
, N_("commit only specified files")),
1748 OPT_BOOL('n', "no-verify", &no_verify
, N_("bypass pre-commit and commit-msg hooks")),
1749 OPT_BOOL(0, "dry-run", &dry_run
, N_("show what would be committed")),
1750 OPT_SET_INT(0, "short", &status_format
, N_("show status concisely"),
1751 STATUS_FORMAT_SHORT
),
1752 OPT_BOOL(0, "branch", &s
.show_branch
, N_("show branch information")),
1753 OPT_BOOL(0, "ahead-behind", &s
.ahead_behind_flags
,
1754 N_("compute full ahead/behind values")),
1755 OPT_SET_INT(0, "porcelain", &status_format
,
1756 N_("machine-readable output"), STATUS_FORMAT_PORCELAIN
),
1757 OPT_SET_INT(0, "long", &status_format
,
1758 N_("show status in long format (default)"),
1759 STATUS_FORMAT_LONG
),
1760 OPT_BOOL('z', "null", &s
.null_termination
,
1761 N_("terminate entries with NUL")),
1762 OPT_BOOL(0, "amend", &amend
, N_("amend previous commit")),
1763 OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite
, N_("bypass post-rewrite hook")),
1765 .type
= OPTION_STRING
,
1767 .long_name
= "untracked-files",
1768 .value
= &untracked_files_arg
,
1770 .help
= N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1771 .flags
= PARSE_OPT_OPTARG
,
1772 .defval
= (intptr_t)"all",
1774 OPT_PATHSPEC_FROM_FILE(&pathspec_from_file
),
1775 OPT_PATHSPEC_FILE_NUL(&pathspec_file_nul
),
1776 /* end commit contents options */
1778 OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty
,
1779 N_("ok to record an empty change")),
1780 OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message
,
1781 N_("ok to record a change with an empty message")),
1786 struct strbuf sb
= STRBUF_INIT
;
1787 struct strbuf author_ident
= STRBUF_INIT
;
1788 const char *index_file
, *reflog_msg
;
1789 struct object_id oid
;
1790 struct commit_list
*parents
= NULL
;
1791 struct stat statbuf
;
1792 struct commit
*current_head
= NULL
;
1793 struct commit_extra_header
*extra
= NULL
;
1794 struct strbuf err
= STRBUF_INIT
;
1797 show_usage_with_options_if_asked(argc
, argv
,
1798 builtin_commit_usage
, builtin_commit_options
);
1800 #ifndef WITH_BREAKING_CHANGES
1801 warn_on_auto_comment_char
= true;
1802 #endif /* !WITH_BREAKING_CHANGES */
1803 prepare_repo_settings(the_repository
);
1804 the_repository
->settings
.command_requires_full_index
= 0;
1806 status_init_config(&s
, git_commit_config
);
1807 s
.commit_template
= 1;
1808 status_format
= STATUS_FORMAT_NONE
; /* Ignore status.short */
1811 if (repo_get_oid(the_repository
, "HEAD", &oid
))
1812 current_head
= NULL
;
1814 current_head
= lookup_commit_or_die(&oid
, "HEAD");
1815 if (repo_parse_commit(the_repository
, current_head
))
1816 die(_("could not parse HEAD commit"));
1818 verbose
= -1; /* unspecified */
1819 argc
= parse_and_validate_options(argc
, argv
, builtin_commit_options
,
1820 builtin_commit_usage
,
1821 prefix
, current_head
, &s
);
1823 verbose
= (config_commit_verbose
< 0) ? 0 : config_commit_verbose
;
1826 free(cleanup_config
);
1827 cleanup_config
= xstrdup(cleanup_arg
);
1829 cleanup_mode
= get_cleanup_mode(cleanup_config
, use_editor
);
1832 return dry_run_commit(argv
, prefix
, current_head
, &s
);
1833 index_file
= prepare_index(argv
, prefix
, current_head
, 0);
1835 /* Set up everything for writing the commit object. This includes
1836 running hooks, writing the trees, and interacting with the user. */
1837 if (!prepare_to_commit(index_file
, prefix
,
1838 current_head
, &s
, &author_ident
)) {
1840 rollback_index_files();
1844 /* Determine parents */
1845 reflog_msg
= getenv("GIT_REFLOG_ACTION");
1846 if (!current_head
) {
1848 reflog_msg
= "commit (initial)";
1851 reflog_msg
= "commit (amend)";
1852 parents
= copy_commit_list(current_head
->parents
);
1853 } else if (whence
== FROM_MERGE
) {
1854 struct strbuf m
= STRBUF_INIT
;
1856 int allow_fast_forward
= 1;
1857 struct commit_list
**pptr
= &parents
;
1860 reflog_msg
= "commit (merge)";
1861 pptr
= commit_list_append(current_head
, pptr
);
1862 fp
= xfopen(git_path_merge_head(the_repository
), "r");
1863 while (strbuf_getline_lf(&m
, fp
) != EOF
) {
1864 struct commit
*parent
;
1866 parent
= get_merge_parent(m
.buf
);
1868 die(_("Corrupt MERGE_HEAD file (%s)"), m
.buf
);
1869 pptr
= commit_list_append(parent
, pptr
);
1873 if (!stat(git_path_merge_mode(the_repository
), &statbuf
)) {
1874 if (strbuf_read_file(&sb
, git_path_merge_mode(the_repository
), 0) < 0)
1875 die_errno(_("could not read MERGE_MODE"));
1876 if (!strcmp(sb
.buf
, "no-ff"))
1877 allow_fast_forward
= 0;
1879 if (allow_fast_forward
)
1880 reduce_heads_replace(&parents
);
1883 reflog_msg
= is_from_cherry_pick(whence
)
1884 ? "commit (cherry-pick)"
1885 : is_from_rebase(whence
)
1888 commit_list_insert(current_head
, &parents
);
1891 /* Finally, get the commit message */
1893 if (strbuf_read_file(&sb
, git_path_commit_editmsg(), 0) < 0) {
1894 int saved_errno
= errno
;
1895 rollback_index_files();
1896 die(_("could not read commit message: %s"), strerror(saved_errno
));
1899 cleanup_message(&sb
, cleanup_mode
, verbose
);
1901 if (message_is_empty(&sb
, cleanup_mode
) && !allow_empty_message
) {
1902 rollback_index_files();
1903 fprintf(stderr
, _("Aborting commit due to empty commit message.\n"));
1906 if (template_untouched(&sb
, template_file
, cleanup_mode
) && !allow_empty_message
) {
1907 rollback_index_files();
1908 fprintf(stderr
, _("Aborting commit; you did not edit the message.\n"));
1912 if (fixup_message
&& starts_with(sb
.buf
, "amend! ") &&
1913 !allow_empty_message
) {
1914 struct strbuf body
= STRBUF_INIT
;
1915 size_t len
= commit_subject_length(sb
.buf
);
1916 strbuf_addstr(&body
, sb
.buf
+ len
);
1917 if (message_is_empty(&body
, cleanup_mode
)) {
1918 rollback_index_files();
1919 fprintf(stderr
, _("Aborting commit due to empty commit message body.\n"));
1922 strbuf_release(&body
);
1926 const char *exclude_gpgsig
[3] = { "gpgsig", "gpgsig-sha256", NULL
};
1927 extra
= read_commit_extra_headers(current_head
, exclude_gpgsig
);
1929 struct commit_extra_header
**tail
= &extra
;
1930 append_merge_tag_headers(parents
, &tail
);
1933 if (commit_tree_extended(sb
.buf
, sb
.len
, &the_repository
->index
->cache_tree
->oid
,
1934 parents
, &oid
, author_ident
.buf
, NULL
,
1935 sign_commit
, extra
)) {
1936 rollback_index_files();
1937 die(_("failed to write commit object"));
1940 if (update_head_with_reflog(current_head
, &oid
, reflog_msg
, &sb
,
1942 rollback_index_files();
1946 sequencer_post_commit_cleanup(the_repository
, 0);
1947 unlink(git_path_merge_head(the_repository
));
1948 unlink(git_path_merge_msg(the_repository
));
1949 unlink(git_path_merge_mode(the_repository
));
1950 unlink(git_path_squash_msg(the_repository
));
1952 if (commit_index_files())
1953 die(_("repository has been updated, but unable to write\n"
1954 "new index file. Check that disk is not full and quota is\n"
1955 "not exceeded, and then \"git restore --staged :/\" to recover."));
1957 git_test_write_commit_graph_or_die(the_repository
->objects
->sources
);
1959 repo_rerere(the_repository
, 0);
1960 run_auto_maintenance(quiet
);
1961 run_commit_hook(use_editor
, repo_get_index_file(the_repository
),
1962 NULL
, "post-commit", NULL
);
1963 if (amend
&& !no_post_rewrite
) {
1964 commit_post_rewrite(the_repository
, current_head
, &oid
);
1967 unsigned int flags
= 0;
1970 flags
|= SUMMARY_INITIAL_COMMIT
;
1971 if (author_date_is_interesting())
1972 flags
|= SUMMARY_SHOW_AUTHOR_DATE
;
1973 print_commit_summary(the_repository
, prefix
,
1977 apply_autostash_ref(the_repository
, "MERGE_AUTOSTASH");
1980 free_commit_extra_headers(extra
);
1981 free_commit_list(parents
);
1982 strbuf_release(&author_ident
);
1983 strbuf_release(&err
);
1984 strbuf_release(&sb
);
1986 free(template_file
);