commit/reset: try to clean up sequencer state
[git/git.git] / sequencer.h
CommitLineData
26ae337b
RR
1#ifndef SEQUENCER_H
2#define SEQUENCER_H
3
ef3ca954
EN
4#include "cache.h"
5#include "strbuf.h"
6
7struct commit;
f11c9580 8struct repository;
ef3ca954 9
66618a50 10const char *git_path_commit_editmsg(void);
8a2a0f53 11const char *git_path_seq_dir(void);
44b776c3 12const char *rebase_path_todo(void);
26ae337b 13
bab4d109
BC
14#define APPEND_SIGNOFF_DEDUP (1u << 0)
15
043a4492
RR
16enum replay_action {
17 REPLAY_REVERT,
84583957
JS
18 REPLAY_PICK,
19 REPLAY_INTERACTIVE_REBASE
043a4492
RR
20};
21
28d6daed
PW
22enum commit_msg_cleanup_mode {
23 COMMIT_MSG_CLEANUP_SPACE,
24 COMMIT_MSG_CLEANUP_NONE,
25 COMMIT_MSG_CLEANUP_SCISSORS,
26 COMMIT_MSG_CLEANUP_ALL
27};
28
043a4492
RR
29struct replay_opts {
30 enum replay_action action;
043a4492
RR
31
32 /* Boolean options */
33 int edit;
34 int record_origin;
35 int no_commit;
36 int signoff;
37 int allow_ff;
38 int allow_rerere_auto;
df478b74 39 int allow_empty;
4bee9584 40 int allow_empty_message;
b27cfb0d 41 int keep_redundant_commits;
556907f1 42 int verbose;
899b49c4 43 int quiet;
d421afa0 44 int reschedule_failed_exec;
043a4492
RR
45
46 int mainline;
47
03a4e260 48 char *gpg_sign;
28d6daed 49 enum commit_msg_cleanup_mode default_msg_cleanup;
3253553e 50
043a4492 51 /* Merge strategy */
03a4e260
JS
52 char *strategy;
53 char **xopts;
043a4492
RR
54 size_t xopts_nr, xopts_alloc;
55
e12a7ef5
JS
56 /* Used by fixup/squash */
57 struct strbuf current_fixups;
58 int current_fixup_count;
59
d87d48b2
JS
60 /* placeholder commit for -i --root */
61 struct object_id squash_onto;
62 int have_squash_onto;
63
043a4492
RR
64 /* Only used by REPLAY_NONE */
65 struct rev_info *revs;
66};
e12a7ef5 67#define REPLAY_OPTS_INIT { .action = -1, .current_fixups = STRBUF_INIT }
043a4492 68
44b776c3
AG
69enum missing_commit_check_level {
70 MISSING_COMMIT_CHECK_IGNORE = 0,
71 MISSING_COMMIT_CHECK_WARN,
72 MISSING_COMMIT_CHECK_ERROR
73};
74
75int write_message(const void *buf, size_t len, const char *filename,
76 int append_eol);
77
28d6daed
PW
78/* Call this to setup defaults before parsing command line options */
79void sequencer_init_config(struct replay_opts *opts);
f11c9580
NTND
80int sequencer_pick_revisions(struct repository *repo,
81 struct replay_opts *opts);
82int sequencer_continue(struct repository *repo, struct replay_opts *opts);
005af339 83int sequencer_rollback(struct repository *repo, struct replay_opts *opts);
2863584f 84int sequencer_remove_state(struct replay_opts *opts);
043a4492 85
313a48ea
LB
86#define TODO_LIST_KEEP_EMPTY (1U << 0)
87#define TODO_LIST_SHORTEN_IDS (1U << 1)
d8ae6c84 88#define TODO_LIST_ABBREVIATE_CMDS (1U << 2)
1644c73c 89#define TODO_LIST_REBASE_MERGES (1U << 3)
7543f6f4
JS
90/*
91 * When rebasing merges, commits that do have the base commit as ancestor
92 * ("cousins") are *not* rebased onto the new base by default. If those
93 * commits should be rebased onto the new base, this flag needs to be passed.
94 */
95#define TODO_LIST_REBASE_COUSINS (1U << 4)
f11c9580
NTND
96int sequencer_make_script(struct repository *repo, FILE *out,
97 int argc, const char **argv,
313a48ea 98 unsigned flags);
62db5247 99
005af339
NTND
100int sequencer_add_exec_commands(struct repository *r, const char *command);
101int transform_todos(struct repository *r, unsigned flags);
44b776c3 102enum missing_commit_check_level get_missing_commit_check_level(void);
005af339
NTND
103int check_todo_list(struct repository *r);
104int complete_action(struct repository *r, struct replay_opts *opts, unsigned flags,
b97e1873
AG
105 const char *shortrevisions, const char *onto_name,
106 const char *onto, const char *orig_head, const char *cmd,
107 unsigned autosquash);
005af339 108int rearrange_squash(struct repository *r);
3546c8d9 109
66e83d9b
JK
110/*
111 * Append a signoff to the commit message in "msgbuf". The ignore_footer
112 * parameter specifies the number of bytes at the end of msgbuf that should
113 * not be considered at all. I.e., they are not checked for existing trailers,
114 * and the new signoff will be spliced into the buffer before those bytes.
115 */
116void append_signoff(struct strbuf *msgbuf, size_t ignore_footer, unsigned flag);
117
f11c9580 118void append_conflicts_hint(struct index_state *istate, struct strbuf *msgbuf);
d0aaa46f
PW
119int message_is_empty(const struct strbuf *sb,
120 enum commit_msg_cleanup_mode cleanup_mode);
121int template_untouched(const struct strbuf *sb, const char *template_file,
122 enum commit_msg_cleanup_mode cleanup_mode);
0505d604
PW
123int update_head_with_reflog(const struct commit *old_head,
124 const struct object_id *new_head,
125 const char *action, const struct strbuf *msg,
126 struct strbuf *err);
1d18d758
NTND
127void commit_post_rewrite(struct repository *r,
128 const struct commit *current_head,
a87a6f3c 129 const struct object_id *new_head);
5ed75e2a 130
2c58483a
AG
131int prepare_branch_to_be_rebased(struct replay_opts *opts, const char *commit);
132
e47c6caf
PW
133#define SUMMARY_INITIAL_COMMIT (1 << 0)
134#define SUMMARY_SHOW_AUTHOR_DATE (1 << 1)
f11c9580
NTND
135void print_commit_summary(struct repository *repo,
136 const char *prefix,
137 const struct object_id *oid,
e47c6caf 138 unsigned int flags);
bcd33ec2
PW
139
140int read_author_script(const char *path, char **name, char **email, char **date,
141 int allow_missing);
26ae337b 142#endif
65850686
AG
143
144void parse_strategy_opts(struct replay_opts *opts, char *raw_opts);
145int write_basic_state(struct replay_opts *opts, const char *head_name,
146 const char *onto, const char *orig_head);
b07d9bfd 147void sequencer_post_commit_cleanup(struct repository *r);