]>
Commit | Line | Data |
---|---|---|
26ae337b RR |
1 | #ifndef SEQUENCER_H |
2 | #define SEQUENCER_H | |
3 | ||
ef3ca954 EN |
4 | #include "cache.h" |
5 | #include "strbuf.h" | |
901ba7b1 | 6 | #include "wt-status.h" |
ef3ca954 EN |
7 | |
8 | struct commit; | |
f11c9580 | 9 | struct repository; |
ef3ca954 | 10 | |
66618a50 | 11 | const char *git_path_commit_editmsg(void); |
44b776c3 | 12 | const char *rebase_path_todo(void); |
a930eb03 | 13 | const char *rebase_path_todo_backup(void); |
5a5445d8 | 14 | const char *rebase_path_dropped(void); |
26ae337b | 15 | |
bab4d109 BC |
16 | #define APPEND_SIGNOFF_DEDUP (1u << 0) |
17 | ||
043a4492 RR |
18 | enum replay_action { |
19 | REPLAY_REVERT, | |
84583957 JS |
20 | REPLAY_PICK, |
21 | REPLAY_INTERACTIVE_REBASE | |
043a4492 RR |
22 | }; |
23 | ||
28d6daed PW |
24 | enum commit_msg_cleanup_mode { |
25 | COMMIT_MSG_CLEANUP_SPACE, | |
26 | COMMIT_MSG_CLEANUP_NONE, | |
27 | COMMIT_MSG_CLEANUP_SCISSORS, | |
28 | COMMIT_MSG_CLEANUP_ALL | |
29 | }; | |
30 | ||
043a4492 RR |
31 | struct replay_opts { |
32 | enum replay_action action; | |
043a4492 | 33 | |
39edfd5c | 34 | /* Tri-state options: unspecified, false, or true */ |
043a4492 | 35 | int edit; |
39edfd5c EN |
36 | |
37 | /* Boolean options */ | |
043a4492 RR |
38 | int record_origin; |
39 | int no_commit; | |
40 | int signoff; | |
41 | int allow_ff; | |
42 | int allow_rerere_auto; | |
df478b74 | 43 | int allow_empty; |
4bee9584 | 44 | int allow_empty_message; |
e98c4269 | 45 | int drop_redundant_commits; |
b27cfb0d | 46 | int keep_redundant_commits; |
556907f1 | 47 | int verbose; |
899b49c4 | 48 | int quiet; |
d421afa0 | 49 | int reschedule_failed_exec; |
7573cec5 | 50 | int committer_date_is_author_date; |
a3894aad | 51 | int ignore_date; |
43966ab3 | 52 | int commit_use_reference; |
043a4492 RR |
53 | |
54 | int mainline; | |
55 | ||
03a4e260 | 56 | char *gpg_sign; |
28d6daed | 57 | enum commit_msg_cleanup_mode default_msg_cleanup; |
d74f3e58 | 58 | int explicit_cleanup; |
3253553e | 59 | |
043a4492 | 60 | /* Merge strategy */ |
14c4586c | 61 | char *default_strategy; /* from config options */ |
03a4e260 JS |
62 | char *strategy; |
63 | char **xopts; | |
043a4492 RR |
64 | size_t xopts_nr, xopts_alloc; |
65 | ||
e12a7ef5 JS |
66 | /* Used by fixup/squash */ |
67 | struct strbuf current_fixups; | |
68 | int current_fixup_count; | |
69 | ||
d87d48b2 JS |
70 | /* placeholder commit for -i --root */ |
71 | struct object_id squash_onto; | |
72 | int have_squash_onto; | |
73 | ||
043a4492 RR |
74 | /* Only used by REPLAY_NONE */ |
75 | struct rev_info *revs; | |
76 | }; | |
39edfd5c | 77 | #define REPLAY_OPTS_INIT { .edit = -1, .action = -1, .current_fixups = STRBUF_INIT } |
043a4492 | 78 | |
5d94d545 AG |
79 | /* |
80 | * Note that ordering matters in this enum. Not only must it match the mapping | |
81 | * of todo_command_info (in sequencer.c), it is also divided into several | |
82 | * sections that matter. When adding new commands, make sure you add it in the | |
83 | * right section. | |
84 | */ | |
85 | enum todo_command { | |
86 | /* commands that handle commits */ | |
87 | TODO_PICK = 0, | |
88 | TODO_REVERT, | |
89 | TODO_EDIT, | |
90 | TODO_REWORD, | |
91 | TODO_FIXUP, | |
92 | TODO_SQUASH, | |
93 | /* commands that do something else than handling a single commit */ | |
94 | TODO_EXEC, | |
95 | TODO_BREAK, | |
96 | TODO_LABEL, | |
97 | TODO_RESET, | |
98 | TODO_MERGE, | |
99 | /* commands that do nothing but are counted for reporting progress */ | |
100 | TODO_NOOP, | |
101 | TODO_DROP, | |
102 | /* comments (not counted for reporting progress) */ | |
103 | TODO_COMMENT | |
44b776c3 AG |
104 | }; |
105 | ||
5d94d545 AG |
106 | struct todo_item { |
107 | enum todo_command command; | |
108 | struct commit *commit; | |
109 | unsigned int flags; | |
5d94d545 | 110 | int arg_len; |
6ad656db AG |
111 | /* The offset of the command and its argument in the strbuf */ |
112 | size_t offset_in_buf, arg_offset; | |
5d94d545 AG |
113 | }; |
114 | ||
115 | struct todo_list { | |
116 | struct strbuf buf; | |
117 | struct todo_item *items; | |
118 | int nr, alloc, current; | |
119 | int done_nr, total_nr; | |
5d94d545 AG |
120 | }; |
121 | ||
f69a6e4f ÆAB |
122 | #define TODO_LIST_INIT { \ |
123 | .buf = STRBUF_INIT, \ | |
124 | } | |
5d94d545 AG |
125 | |
126 | int todo_list_parse_insn_buffer(struct repository *r, char *buf, | |
127 | struct todo_list *todo_list); | |
616d7740 AG |
128 | int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list, |
129 | const char *file, const char *shortrevisions, | |
130 | const char *shortonto, int num, unsigned flags); | |
5d94d545 | 131 | void todo_list_release(struct todo_list *todo_list); |
6ad656db AG |
132 | const char *todo_item_get_arg(struct todo_list *todo_list, |
133 | struct todo_item *item); | |
44b776c3 | 134 | |
28d6daed PW |
135 | /* Call this to setup defaults before parsing command line options */ |
136 | void sequencer_init_config(struct replay_opts *opts); | |
f11c9580 NTND |
137 | int sequencer_pick_revisions(struct repository *repo, |
138 | struct replay_opts *opts); | |
139 | int sequencer_continue(struct repository *repo, struct replay_opts *opts); | |
005af339 | 140 | int sequencer_rollback(struct repository *repo, struct replay_opts *opts); |
de81ca3f | 141 | int sequencer_skip(struct repository *repo, struct replay_opts *opts); |
2863584f | 142 | int sequencer_remove_state(struct replay_opts *opts); |
043a4492 | 143 | |
b9cbd295 | 144 | #define TODO_LIST_KEEP_EMPTY (1U << 0) |
313a48ea | 145 | #define TODO_LIST_SHORTEN_IDS (1U << 1) |
d8ae6c84 | 146 | #define TODO_LIST_ABBREVIATE_CMDS (1U << 2) |
1644c73c | 147 | #define TODO_LIST_REBASE_MERGES (1U << 3) |
7543f6f4 JS |
148 | /* |
149 | * When rebasing merges, commits that do have the base commit as ancestor | |
150 | * ("cousins") are *not* rebased onto the new base by default. If those | |
151 | * commits should be rebased onto the new base, this flag needs to be passed. | |
152 | */ | |
153 | #define TODO_LIST_REBASE_COUSINS (1U << 4) | |
616d7740 | 154 | #define TODO_LIST_APPEND_TODO_HELP (1U << 5) |
e1fac531 JS |
155 | /* |
156 | * When generating a script that rebases merges with `--root` *and* with | |
157 | * `--onto`, we do not want to re-generate the root commits. | |
158 | */ | |
159 | #define TODO_LIST_ROOT_WITH_ONTO (1U << 6) | |
0fcb4f6b | 160 | #define TODO_LIST_REAPPLY_CHERRY_PICKS (1U << 7) |
767a4ca6 | 161 | #define TODO_LIST_WARN_SKIPPED_CHERRY_PICKS (1U << 8) |
616d7740 | 162 | |
d358fc28 AG |
163 | int sequencer_make_script(struct repository *r, struct strbuf *out, int argc, |
164 | const char **argv, unsigned flags); | |
62db5247 | 165 | |
005af339 | 166 | int complete_action(struct repository *r, struct replay_opts *opts, unsigned flags, |
b97e1873 | 167 | const char *shortrevisions, const char *onto_name, |
f3e27a02 PW |
168 | struct commit *onto, const struct object_id *orig_head, |
169 | struct string_list *commands, unsigned autosquash, | |
170 | struct todo_list *todo_list); | |
79d7e883 | 171 | int todo_list_rearrange_squash(struct todo_list *todo_list); |
3546c8d9 | 172 | |
66e83d9b JK |
173 | /* |
174 | * Append a signoff to the commit message in "msgbuf". The ignore_footer | |
175 | * parameter specifies the number of bytes at the end of msgbuf that should | |
176 | * not be considered at all. I.e., they are not checked for existing trailers, | |
177 | * and the new signoff will be spliced into the buffer before those bytes. | |
178 | */ | |
179 | void append_signoff(struct strbuf *msgbuf, size_t ignore_footer, unsigned flag); | |
180 | ||
1a2b985f DL |
181 | void append_conflicts_hint(struct index_state *istate, |
182 | struct strbuf *msgbuf, enum commit_msg_cleanup_mode cleanup_mode); | |
f29cd862 DL |
183 | enum commit_msg_cleanup_mode get_cleanup_mode(const char *cleanup_arg, |
184 | int use_editor); | |
185 | ||
186 | void cleanup_message(struct strbuf *msgbuf, | |
187 | enum commit_msg_cleanup_mode cleanup_mode, int verbose); | |
188 | ||
d0aaa46f PW |
189 | int message_is_empty(const struct strbuf *sb, |
190 | enum commit_msg_cleanup_mode cleanup_mode); | |
191 | int template_untouched(const struct strbuf *sb, const char *template_file, | |
192 | enum commit_msg_cleanup_mode cleanup_mode); | |
0505d604 PW |
193 | int update_head_with_reflog(const struct commit *old_head, |
194 | const struct object_id *new_head, | |
195 | const char *action, const struct strbuf *msg, | |
196 | struct strbuf *err); | |
1d18d758 NTND |
197 | void commit_post_rewrite(struct repository *r, |
198 | const struct commit *current_head, | |
a87a6f3c | 199 | const struct object_id *new_head); |
5ed75e2a | 200 | |
b7de153b | 201 | void create_autostash(struct repository *r, const char *path); |
12b6e136 | 202 | int save_autostash(const char *path); |
86ed00af | 203 | int apply_autostash(const char *path); |
804fe315 | 204 | int apply_autostash_oid(const char *stash_oid); |
86ed00af | 205 | |
e47c6caf PW |
206 | #define SUMMARY_INITIAL_COMMIT (1 << 0) |
207 | #define SUMMARY_SHOW_AUTHOR_DATE (1 << 1) | |
f11c9580 NTND |
208 | void print_commit_summary(struct repository *repo, |
209 | const char *prefix, | |
210 | const struct object_id *oid, | |
e47c6caf | 211 | unsigned int flags); |
bcd33ec2 | 212 | |
c20de8be DL |
213 | #define READ_ONELINER_SKIP_IF_EMPTY (1 << 0) |
214 | #define READ_ONELINER_WARN_MISSING (1 << 1) | |
215 | ||
216 | /* | |
217 | * Reads a file that was presumably written by a shell script, i.e. with an | |
218 | * end-of-line marker that needs to be stripped. | |
219 | * | |
220 | * Note that only the last end-of-line marker is stripped, consistent with the | |
221 | * behavior of "$(cat path)" in a shell script. | |
222 | * | |
223 | * Returns 1 if the file was read, 0 if it could not be read or does not exist. | |
224 | */ | |
225 | int read_oneliner(struct strbuf *buf, | |
226 | const char *path, unsigned flags); | |
bcd33ec2 PW |
227 | int read_author_script(const char *path, char **name, char **email, char **date, |
228 | int allow_missing); | |
65850686 AG |
229 | void parse_strategy_opts(struct replay_opts *opts, char *raw_opts); |
230 | int write_basic_state(struct replay_opts *opts, const char *head_name, | |
a2bb10d0 | 231 | struct commit *onto, const struct object_id *orig_head); |
f496b064 | 232 | void sequencer_post_commit_cleanup(struct repository *r, int verbose); |
4a72486d PW |
233 | int sequencer_get_last_command(struct repository* r, |
234 | enum replay_action *action); | |
901ba7b1 | 235 | int sequencer_determine_whence(struct repository *r, enum commit_whence *whence); |
12bb7a54 | 236 | #endif /* SEQUENCER_H */ |