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