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