Ramkumar Ramachandra | 26ae337 | 2011-08-04 16:09:11 +0530 | [diff] [blame] | 1 | #ifndef SEQUENCER_H |
| 2 | #define SEQUENCER_H |
| 3 | |
Elijah Newren | ef3ca95 | 2018-08-15 10:54:05 -0700 | [diff] [blame] | 4 | #include "cache.h" |
| 5 | #include "strbuf.h" |
| 6 | |
| 7 | struct commit; |
Nguyễn Thái Ngọc Duy | f11c958 | 2018-11-10 06:48:56 +0100 | [diff] [blame] | 8 | struct repository; |
Elijah Newren | ef3ca95 | 2018-08-15 10:54:05 -0700 | [diff] [blame] | 9 | |
Phillip Wood | 66618a5 | 2018-01-24 12:34:22 +0000 | [diff] [blame] | 10 | const char *git_path_commit_editmsg(void); |
Johannes Schindelin | 8a2a0f5 | 2016-10-14 15:17:12 +0200 | [diff] [blame] | 11 | const char *git_path_seq_dir(void); |
Alban Gruin | 44b776c | 2018-08-10 18:51:28 +0200 | [diff] [blame] | 12 | const char *rebase_path_todo(void); |
Alban Gruin | a930eb0 | 2019-03-05 20:18:03 +0100 | [diff] [blame] | 13 | const char *rebase_path_todo_backup(void); |
Alban Gruin | 5a5445d | 2020-01-28 22:12:46 +0100 | [diff] [blame] | 14 | const char *rebase_path_dropped(void); |
Ramkumar Ramachandra | 26ae337 | 2011-08-04 16:09:11 +0530 | [diff] [blame] | 15 | |
Brandon Casey | bab4d10 | 2013-02-12 02:17:35 -0800 | [diff] [blame] | 16 | #define APPEND_SIGNOFF_DEDUP (1u << 0) |
| 17 | |
Ramkumar Ramachandra | 043a449 | 2012-01-11 23:45:57 +0530 | [diff] [blame] | 18 | enum replay_action { |
| 19 | REPLAY_REVERT, |
Johannes Schindelin | 8458395 | 2017-01-02 16:26:28 +0100 | [diff] [blame] | 20 | REPLAY_PICK, |
| 21 | REPLAY_INTERACTIVE_REBASE |
Ramkumar Ramachandra | 043a449 | 2012-01-11 23:45:57 +0530 | [diff] [blame] | 22 | }; |
| 23 | |
Phillip Wood | 28d6dae | 2017-12-13 11:46:21 +0000 | [diff] [blame] | 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 | |
Ramkumar Ramachandra | 043a449 | 2012-01-11 23:45:57 +0530 | [diff] [blame] | 31 | struct replay_opts { |
| 32 | enum replay_action action; |
Ramkumar Ramachandra | 043a449 | 2012-01-11 23:45:57 +0530 | [diff] [blame] | 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; |
Neil Horman | df478b7 | 2012-04-11 16:21:53 -0400 | [diff] [blame] | 41 | int allow_empty; |
Chris Webb | 4bee958 | 2012-08-02 11:38:51 +0100 | [diff] [blame] | 42 | int allow_empty_message; |
Elijah Newren | e98c426 | 2020-02-15 21:36:25 +0000 | [diff] [blame] | 43 | int drop_redundant_commits; |
Neil Horman | b27cfb0 | 2012-04-20 10:36:15 -0400 | [diff] [blame] | 44 | int keep_redundant_commits; |
Johannes Schindelin | 556907f | 2017-01-02 16:26:53 +0100 | [diff] [blame] | 45 | int verbose; |
Elijah Newren | 899b49c | 2018-12-11 08:11:36 -0800 | [diff] [blame] | 46 | int quiet; |
Johannes Schindelin | d421afa | 2018-12-10 11:04:58 -0800 | [diff] [blame] | 47 | int reschedule_failed_exec; |
Ramkumar Ramachandra | 043a449 | 2012-01-11 23:45:57 +0530 | [diff] [blame] | 48 | |
| 49 | int mainline; |
| 50 | |
Johannes Schindelin | 03a4e26 | 2016-10-21 14:24:13 +0200 | [diff] [blame] | 51 | char *gpg_sign; |
Phillip Wood | 28d6dae | 2017-12-13 11:46:21 +0000 | [diff] [blame] | 52 | enum commit_msg_cleanup_mode default_msg_cleanup; |
Phillip Wood | d74f3e5 | 2019-03-29 11:08:42 +0000 | [diff] [blame] | 53 | int explicit_cleanup; |
Nicolas Vigier | 3253553 | 2014-01-24 00:50:58 +0000 | [diff] [blame] | 54 | |
Ramkumar Ramachandra | 043a449 | 2012-01-11 23:45:57 +0530 | [diff] [blame] | 55 | /* Merge strategy */ |
Johannes Schindelin | 03a4e26 | 2016-10-21 14:24:13 +0200 | [diff] [blame] | 56 | char *strategy; |
| 57 | char **xopts; |
Ramkumar Ramachandra | 043a449 | 2012-01-11 23:45:57 +0530 | [diff] [blame] | 58 | size_t xopts_nr, xopts_alloc; |
| 59 | |
Johannes Schindelin | e12a7ef | 2018-04-27 22:48:21 +0200 | [diff] [blame] | 60 | /* Used by fixup/squash */ |
| 61 | struct strbuf current_fixups; |
| 62 | int current_fixup_count; |
| 63 | |
Johannes Schindelin | d87d48b | 2018-05-04 01:01:17 +0200 | [diff] [blame] | 64 | /* placeholder commit for -i --root */ |
| 65 | struct object_id squash_onto; |
| 66 | int have_squash_onto; |
| 67 | |
Ramkumar Ramachandra | 043a449 | 2012-01-11 23:45:57 +0530 | [diff] [blame] | 68 | /* Only used by REPLAY_NONE */ |
| 69 | struct rev_info *revs; |
| 70 | }; |
Johannes Schindelin | e12a7ef | 2018-04-27 22:48:21 +0200 | [diff] [blame] | 71 | #define REPLAY_OPTS_INIT { .action = -1, .current_fixups = STRBUF_INIT } |
Ramkumar Ramachandra | 043a449 | 2012-01-11 23:45:57 +0530 | [diff] [blame] | 72 | |
Alban Gruin | 5d94d54 | 2018-12-29 17:03:59 +0100 | [diff] [blame] | 73 | /* |
| 74 | * Note that ordering matters in this enum. Not only must it match the mapping |
| 75 | * of todo_command_info (in sequencer.c), it is also divided into several |
| 76 | * sections that matter. When adding new commands, make sure you add it in the |
| 77 | * right section. |
| 78 | */ |
| 79 | enum todo_command { |
| 80 | /* commands that handle commits */ |
| 81 | TODO_PICK = 0, |
| 82 | TODO_REVERT, |
| 83 | TODO_EDIT, |
| 84 | TODO_REWORD, |
| 85 | TODO_FIXUP, |
| 86 | TODO_SQUASH, |
| 87 | /* commands that do something else than handling a single commit */ |
| 88 | TODO_EXEC, |
| 89 | TODO_BREAK, |
| 90 | TODO_LABEL, |
| 91 | TODO_RESET, |
| 92 | TODO_MERGE, |
| 93 | /* commands that do nothing but are counted for reporting progress */ |
| 94 | TODO_NOOP, |
| 95 | TODO_DROP, |
| 96 | /* comments (not counted for reporting progress) */ |
| 97 | TODO_COMMENT |
Alban Gruin | 44b776c | 2018-08-10 18:51:28 +0200 | [diff] [blame] | 98 | }; |
| 99 | |
Alban Gruin | 5d94d54 | 2018-12-29 17:03:59 +0100 | [diff] [blame] | 100 | struct todo_item { |
| 101 | enum todo_command command; |
| 102 | struct commit *commit; |
| 103 | unsigned int flags; |
Alban Gruin | 5d94d54 | 2018-12-29 17:03:59 +0100 | [diff] [blame] | 104 | int arg_len; |
Alban Gruin | 6ad656d | 2019-01-29 16:01:46 +0100 | [diff] [blame] | 105 | /* The offset of the command and its argument in the strbuf */ |
| 106 | size_t offset_in_buf, arg_offset; |
Alban Gruin | 5d94d54 | 2018-12-29 17:03:59 +0100 | [diff] [blame] | 107 | }; |
| 108 | |
| 109 | struct todo_list { |
| 110 | struct strbuf buf; |
| 111 | struct todo_item *items; |
| 112 | int nr, alloc, current; |
| 113 | int done_nr, total_nr; |
| 114 | struct stat_data stat; |
| 115 | }; |
| 116 | |
| 117 | #define TODO_LIST_INIT { STRBUF_INIT } |
| 118 | |
| 119 | int todo_list_parse_insn_buffer(struct repository *r, char *buf, |
| 120 | struct todo_list *todo_list); |
Alban Gruin | 616d774 | 2019-01-29 16:01:48 +0100 | [diff] [blame] | 121 | int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list, |
| 122 | const char *file, const char *shortrevisions, |
| 123 | const char *shortonto, int num, unsigned flags); |
Alban Gruin | 5d94d54 | 2018-12-29 17:03:59 +0100 | [diff] [blame] | 124 | void todo_list_release(struct todo_list *todo_list); |
Alban Gruin | 6ad656d | 2019-01-29 16:01:46 +0100 | [diff] [blame] | 125 | const char *todo_item_get_arg(struct todo_list *todo_list, |
| 126 | struct todo_item *item); |
Alban Gruin | 44b776c | 2018-08-10 18:51:28 +0200 | [diff] [blame] | 127 | |
Phillip Wood | 28d6dae | 2017-12-13 11:46:21 +0000 | [diff] [blame] | 128 | /* Call this to setup defaults before parsing command line options */ |
| 129 | void sequencer_init_config(struct replay_opts *opts); |
Nguyễn Thái Ngọc Duy | f11c958 | 2018-11-10 06:48:56 +0100 | [diff] [blame] | 130 | int sequencer_pick_revisions(struct repository *repo, |
| 131 | struct replay_opts *opts); |
| 132 | int sequencer_continue(struct repository *repo, struct replay_opts *opts); |
Nguyễn Thái Ngọc Duy | 005af33 | 2018-11-10 06:48:57 +0100 | [diff] [blame] | 133 | int sequencer_rollback(struct repository *repo, struct replay_opts *opts); |
Rohit Ashiwal | de81ca3 | 2019-07-02 14:41:28 +0530 | [diff] [blame] | 134 | int sequencer_skip(struct repository *repo, struct replay_opts *opts); |
Johannes Schindelin | 2863584 | 2016-10-21 14:24:55 +0200 | [diff] [blame] | 135 | int sequencer_remove_state(struct replay_opts *opts); |
Ramkumar Ramachandra | 043a449 | 2012-01-11 23:45:57 +0530 | [diff] [blame] | 136 | |
Elijah Newren | d48e5e2 | 2020-02-15 21:36:24 +0000 | [diff] [blame] | 137 | /* #define TODO_LIST_KEEP_EMPTY (1U << 0) */ /* No longer used */ |
Liam Beguin | 313a48e | 2017-12-05 12:52:32 -0500 | [diff] [blame] | 138 | #define TODO_LIST_SHORTEN_IDS (1U << 1) |
Liam Beguin | d8ae6c8 | 2017-12-05 12:52:34 -0500 | [diff] [blame] | 139 | #define TODO_LIST_ABBREVIATE_CMDS (1U << 2) |
Johannes Schindelin | 1644c73 | 2018-04-25 14:29:03 +0200 | [diff] [blame] | 140 | #define TODO_LIST_REBASE_MERGES (1U << 3) |
Johannes Schindelin | 7543f6f | 2018-04-25 14:29:40 +0200 | [diff] [blame] | 141 | /* |
| 142 | * When rebasing merges, commits that do have the base commit as ancestor |
| 143 | * ("cousins") are *not* rebased onto the new base by default. If those |
| 144 | * commits should be rebased onto the new base, this flag needs to be passed. |
| 145 | */ |
| 146 | #define TODO_LIST_REBASE_COUSINS (1U << 4) |
Alban Gruin | 616d774 | 2019-01-29 16:01:48 +0100 | [diff] [blame] | 147 | #define TODO_LIST_APPEND_TODO_HELP (1U << 5) |
Johannes Schindelin | e1fac53 | 2019-07-31 08:18:49 -0700 | [diff] [blame] | 148 | /* |
| 149 | * When generating a script that rebases merges with `--root` *and* with |
| 150 | * `--onto`, we do not want to re-generate the root commits. |
| 151 | */ |
| 152 | #define TODO_LIST_ROOT_WITH_ONTO (1U << 6) |
| 153 | |
Johannes Schindelin | 62db524 | 2017-07-14 16:44:58 +0200 | [diff] [blame] | 154 | |
Alban Gruin | d358fc2 | 2019-03-05 20:17:56 +0100 | [diff] [blame] | 155 | int sequencer_make_script(struct repository *r, struct strbuf *out, int argc, |
| 156 | const char **argv, unsigned flags); |
Brandon Casey | bab4d10 | 2013-02-12 02:17:35 -0800 | [diff] [blame] | 157 | |
Alban Gruin | 1ba204d | 2019-03-05 20:17:58 +0100 | [diff] [blame] | 158 | void todo_list_add_exec_commands(struct todo_list *todo_list, |
| 159 | struct string_list *commands); |
Nguyễn Thái Ngọc Duy | 005af33 | 2018-11-10 06:48:57 +0100 | [diff] [blame] | 160 | int complete_action(struct repository *r, struct replay_opts *opts, unsigned flags, |
Alban Gruin | b97e187 | 2018-08-28 14:10:36 +0200 | [diff] [blame] | 161 | const char *shortrevisions, const char *onto_name, |
Phillip Wood | 7d3488e | 2019-04-17 15:30:39 +0100 | [diff] [blame] | 162 | struct commit *onto, const char *orig_head, struct string_list *commands, |
Alban Gruin | 94bcad7 | 2019-03-05 20:17:57 +0100 | [diff] [blame] | 163 | unsigned autosquash, struct todo_list *todo_list); |
Alban Gruin | 79d7e88 | 2019-03-05 20:17:59 +0100 | [diff] [blame] | 164 | int todo_list_rearrange_squash(struct todo_list *todo_list); |
Johannes Schindelin | 3546c8d | 2017-07-14 16:45:11 +0200 | [diff] [blame] | 165 | |
Jeff King | 66e83d9 | 2018-08-22 20:50:51 -0400 | [diff] [blame] | 166 | /* |
| 167 | * Append a signoff to the commit message in "msgbuf". The ignore_footer |
| 168 | * parameter specifies the number of bytes at the end of msgbuf that should |
| 169 | * not be considered at all. I.e., they are not checked for existing trailers, |
| 170 | * and the new signoff will be spliced into the buffer before those bytes. |
| 171 | */ |
| 172 | void append_signoff(struct strbuf *msgbuf, size_t ignore_footer, unsigned flag); |
| 173 | |
Denton Liu | 1a2b985 | 2019-04-17 11:23:30 +0100 | [diff] [blame] | 174 | void append_conflicts_hint(struct index_state *istate, |
| 175 | struct strbuf *msgbuf, enum commit_msg_cleanup_mode cleanup_mode); |
Denton Liu | f29cd86 | 2019-04-17 11:23:25 +0100 | [diff] [blame] | 176 | enum commit_msg_cleanup_mode get_cleanup_mode(const char *cleanup_arg, |
| 177 | int use_editor); |
| 178 | |
| 179 | void cleanup_message(struct strbuf *msgbuf, |
| 180 | enum commit_msg_cleanup_mode cleanup_mode, int verbose); |
| 181 | |
Phillip Wood | d0aaa46 | 2017-11-10 11:09:42 +0000 | [diff] [blame] | 182 | int message_is_empty(const struct strbuf *sb, |
| 183 | enum commit_msg_cleanup_mode cleanup_mode); |
| 184 | int template_untouched(const struct strbuf *sb, const char *template_file, |
| 185 | enum commit_msg_cleanup_mode cleanup_mode); |
Phillip Wood | 0505d60 | 2017-11-17 11:34:47 +0000 | [diff] [blame] | 186 | int update_head_with_reflog(const struct commit *old_head, |
| 187 | const struct object_id *new_head, |
| 188 | const char *action, const struct strbuf *msg, |
| 189 | struct strbuf *err); |
Nguyễn Thái Ngọc Duy | 1d18d75 | 2019-01-12 09:13:23 +0700 | [diff] [blame] | 190 | void commit_post_rewrite(struct repository *r, |
| 191 | const struct commit *current_head, |
Phillip Wood | a87a6f3 | 2017-11-17 11:34:48 +0000 | [diff] [blame] | 192 | const struct object_id *new_head); |
Miklos Vajna | 5ed75e2 | 2012-09-14 08:52:03 +0200 | [diff] [blame] | 193 | |
Phillip Wood | e47c6ca | 2017-11-24 11:07:54 +0000 | [diff] [blame] | 194 | #define SUMMARY_INITIAL_COMMIT (1 << 0) |
| 195 | #define SUMMARY_SHOW_AUTHOR_DATE (1 << 1) |
Nguyễn Thái Ngọc Duy | f11c958 | 2018-11-10 06:48:56 +0100 | [diff] [blame] | 196 | void print_commit_summary(struct repository *repo, |
| 197 | const char *prefix, |
| 198 | const struct object_id *oid, |
Phillip Wood | e47c6ca | 2017-11-24 11:07:54 +0000 | [diff] [blame] | 199 | unsigned int flags); |
Phillip Wood | bcd33ec | 2018-10-31 10:15:55 +0000 | [diff] [blame] | 200 | |
| 201 | int read_author_script(const char *path, char **name, char **email, char **date, |
| 202 | int allow_missing); |
Alban Gruin | 6585068 | 2018-08-28 14:10:40 +0200 | [diff] [blame] | 203 | void parse_strategy_opts(struct replay_opts *opts, char *raw_opts); |
| 204 | int write_basic_state(struct replay_opts *opts, const char *head_name, |
Phillip Wood | 7d3488e | 2019-04-17 15:30:39 +0100 | [diff] [blame] | 205 | struct commit *onto, const char *orig_head); |
Junio C Hamano | f496b06 | 2019-07-09 15:25:44 -0700 | [diff] [blame] | 206 | void sequencer_post_commit_cleanup(struct repository *r, int verbose); |
Phillip Wood | 4a72486 | 2019-04-16 11:18:42 +0100 | [diff] [blame] | 207 | int sequencer_get_last_command(struct repository* r, |
| 208 | enum replay_action *action); |
Phillip Wood | 12bb7a5 | 2019-10-15 10:25:30 +0000 | [diff] [blame] | 209 | #endif /* SEQUENCER_H */ |