blob: 718a07426dae930dc07417f902fa1ad5682eb337 [file] [log] [blame]
Ramkumar Ramachandra26ae3372011-08-04 16:09:11 +05301#ifndef SEQUENCER_H
2#define SEQUENCER_H
3
Elijah Newrenef3ca952018-08-15 10:54:05 -07004#include "cache.h"
5#include "strbuf.h"
6
7struct commit;
Nguyễn Thái Ngọc Duyf11c9582018-11-10 06:48:56 +01008struct repository;
Elijah Newrenef3ca952018-08-15 10:54:05 -07009
Phillip Wood66618a52018-01-24 12:34:22 +000010const char *git_path_commit_editmsg(void);
Johannes Schindelin8a2a0f52016-10-14 15:17:12 +020011const char *git_path_seq_dir(void);
Alban Gruin44b776c2018-08-10 18:51:28 +020012const char *rebase_path_todo(void);
Alban Gruina930eb02019-03-05 20:18:03 +010013const char *rebase_path_todo_backup(void);
Alban Gruin5a5445d2020-01-28 22:12:46 +010014const char *rebase_path_dropped(void);
Ramkumar Ramachandra26ae3372011-08-04 16:09:11 +053015
Brandon Caseybab4d102013-02-12 02:17:35 -080016#define APPEND_SIGNOFF_DEDUP (1u << 0)
17
Ramkumar Ramachandra043a4492012-01-11 23:45:57 +053018enum replay_action {
19 REPLAY_REVERT,
Johannes Schindelin84583952017-01-02 16:26:28 +010020 REPLAY_PICK,
21 REPLAY_INTERACTIVE_REBASE
Ramkumar Ramachandra043a4492012-01-11 23:45:57 +053022};
23
Phillip Wood28d6dae2017-12-13 11:46:21 +000024enum 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 Ramachandra043a4492012-01-11 23:45:57 +053031struct replay_opts {
32 enum replay_action action;
Ramkumar Ramachandra043a4492012-01-11 23:45:57 +053033
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 Hormandf478b72012-04-11 16:21:53 -040041 int allow_empty;
Chris Webb4bee9582012-08-02 11:38:51 +010042 int allow_empty_message;
Elijah Newrene98c4262020-02-15 21:36:25 +000043 int drop_redundant_commits;
Neil Hormanb27cfb02012-04-20 10:36:15 -040044 int keep_redundant_commits;
Johannes Schindelin556907f2017-01-02 16:26:53 +010045 int verbose;
Elijah Newren899b49c2018-12-11 08:11:36 -080046 int quiet;
Johannes Schindelind421afa2018-12-10 11:04:58 -080047 int reschedule_failed_exec;
Ramkumar Ramachandra043a4492012-01-11 23:45:57 +053048
49 int mainline;
50
Johannes Schindelin03a4e262016-10-21 14:24:13 +020051 char *gpg_sign;
Phillip Wood28d6dae2017-12-13 11:46:21 +000052 enum commit_msg_cleanup_mode default_msg_cleanup;
Phillip Woodd74f3e52019-03-29 11:08:42 +000053 int explicit_cleanup;
Nicolas Vigier32535532014-01-24 00:50:58 +000054
Ramkumar Ramachandra043a4492012-01-11 23:45:57 +053055 /* Merge strategy */
Johannes Schindelin03a4e262016-10-21 14:24:13 +020056 char *strategy;
57 char **xopts;
Ramkumar Ramachandra043a4492012-01-11 23:45:57 +053058 size_t xopts_nr, xopts_alloc;
59
Johannes Schindeline12a7ef2018-04-27 22:48:21 +020060 /* Used by fixup/squash */
61 struct strbuf current_fixups;
62 int current_fixup_count;
63
Johannes Schindelind87d48b2018-05-04 01:01:17 +020064 /* placeholder commit for -i --root */
65 struct object_id squash_onto;
66 int have_squash_onto;
67
Ramkumar Ramachandra043a4492012-01-11 23:45:57 +053068 /* Only used by REPLAY_NONE */
69 struct rev_info *revs;
70};
Johannes Schindeline12a7ef2018-04-27 22:48:21 +020071#define REPLAY_OPTS_INIT { .action = -1, .current_fixups = STRBUF_INIT }
Ramkumar Ramachandra043a4492012-01-11 23:45:57 +053072
Alban Gruin5d94d542018-12-29 17:03:59 +010073/*
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 */
79enum 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 Gruin44b776c2018-08-10 18:51:28 +020098};
99
Alban Gruin5d94d542018-12-29 17:03:59 +0100100struct todo_item {
101 enum todo_command command;
102 struct commit *commit;
103 unsigned int flags;
Alban Gruin5d94d542018-12-29 17:03:59 +0100104 int arg_len;
Alban Gruin6ad656d2019-01-29 16:01:46 +0100105 /* The offset of the command and its argument in the strbuf */
106 size_t offset_in_buf, arg_offset;
Alban Gruin5d94d542018-12-29 17:03:59 +0100107};
108
109struct 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
119int todo_list_parse_insn_buffer(struct repository *r, char *buf,
120 struct todo_list *todo_list);
Alban Gruin616d7742019-01-29 16:01:48 +0100121int 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 Gruin5d94d542018-12-29 17:03:59 +0100124void todo_list_release(struct todo_list *todo_list);
Alban Gruin6ad656d2019-01-29 16:01:46 +0100125const char *todo_item_get_arg(struct todo_list *todo_list,
126 struct todo_item *item);
Alban Gruin44b776c2018-08-10 18:51:28 +0200127
Phillip Wood28d6dae2017-12-13 11:46:21 +0000128/* Call this to setup defaults before parsing command line options */
129void sequencer_init_config(struct replay_opts *opts);
Nguyễn Thái Ngọc Duyf11c9582018-11-10 06:48:56 +0100130int sequencer_pick_revisions(struct repository *repo,
131 struct replay_opts *opts);
132int sequencer_continue(struct repository *repo, struct replay_opts *opts);
Nguyễn Thái Ngọc Duy005af332018-11-10 06:48:57 +0100133int sequencer_rollback(struct repository *repo, struct replay_opts *opts);
Rohit Ashiwalde81ca32019-07-02 14:41:28 +0530134int sequencer_skip(struct repository *repo, struct replay_opts *opts);
Johannes Schindelin28635842016-10-21 14:24:55 +0200135int sequencer_remove_state(struct replay_opts *opts);
Ramkumar Ramachandra043a4492012-01-11 23:45:57 +0530136
Elijah Newrend48e5e22020-02-15 21:36:24 +0000137/* #define TODO_LIST_KEEP_EMPTY (1U << 0) */ /* No longer used */
Liam Beguin313a48e2017-12-05 12:52:32 -0500138#define TODO_LIST_SHORTEN_IDS (1U << 1)
Liam Beguind8ae6c82017-12-05 12:52:34 -0500139#define TODO_LIST_ABBREVIATE_CMDS (1U << 2)
Johannes Schindelin1644c732018-04-25 14:29:03 +0200140#define TODO_LIST_REBASE_MERGES (1U << 3)
Johannes Schindelin7543f6f2018-04-25 14:29:40 +0200141/*
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 Gruin616d7742019-01-29 16:01:48 +0100147#define TODO_LIST_APPEND_TODO_HELP (1U << 5)
Johannes Schindeline1fac532019-07-31 08:18:49 -0700148/*
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 Schindelin62db5242017-07-14 16:44:58 +0200154
Alban Gruind358fc22019-03-05 20:17:56 +0100155int sequencer_make_script(struct repository *r, struct strbuf *out, int argc,
156 const char **argv, unsigned flags);
Brandon Caseybab4d102013-02-12 02:17:35 -0800157
Alban Gruin1ba204d2019-03-05 20:17:58 +0100158void todo_list_add_exec_commands(struct todo_list *todo_list,
159 struct string_list *commands);
Nguyễn Thái Ngọc Duy005af332018-11-10 06:48:57 +0100160int complete_action(struct repository *r, struct replay_opts *opts, unsigned flags,
Alban Gruinb97e1872018-08-28 14:10:36 +0200161 const char *shortrevisions, const char *onto_name,
Phillip Wood7d3488e2019-04-17 15:30:39 +0100162 struct commit *onto, const char *orig_head, struct string_list *commands,
Alban Gruin94bcad72019-03-05 20:17:57 +0100163 unsigned autosquash, struct todo_list *todo_list);
Alban Gruin79d7e882019-03-05 20:17:59 +0100164int todo_list_rearrange_squash(struct todo_list *todo_list);
Johannes Schindelin3546c8d2017-07-14 16:45:11 +0200165
Jeff King66e83d92018-08-22 20:50:51 -0400166/*
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 */
172void append_signoff(struct strbuf *msgbuf, size_t ignore_footer, unsigned flag);
173
Denton Liu1a2b9852019-04-17 11:23:30 +0100174void append_conflicts_hint(struct index_state *istate,
175 struct strbuf *msgbuf, enum commit_msg_cleanup_mode cleanup_mode);
Denton Liuf29cd862019-04-17 11:23:25 +0100176enum commit_msg_cleanup_mode get_cleanup_mode(const char *cleanup_arg,
177 int use_editor);
178
179void cleanup_message(struct strbuf *msgbuf,
180 enum commit_msg_cleanup_mode cleanup_mode, int verbose);
181
Phillip Woodd0aaa462017-11-10 11:09:42 +0000182int message_is_empty(const struct strbuf *sb,
183 enum commit_msg_cleanup_mode cleanup_mode);
184int template_untouched(const struct strbuf *sb, const char *template_file,
185 enum commit_msg_cleanup_mode cleanup_mode);
Phillip Wood0505d602017-11-17 11:34:47 +0000186int 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 Duy1d18d752019-01-12 09:13:23 +0700190void commit_post_rewrite(struct repository *r,
191 const struct commit *current_head,
Phillip Wooda87a6f32017-11-17 11:34:48 +0000192 const struct object_id *new_head);
Miklos Vajna5ed75e22012-09-14 08:52:03 +0200193
Phillip Woode47c6ca2017-11-24 11:07:54 +0000194#define SUMMARY_INITIAL_COMMIT (1 << 0)
195#define SUMMARY_SHOW_AUTHOR_DATE (1 << 1)
Nguyễn Thái Ngọc Duyf11c9582018-11-10 06:48:56 +0100196void print_commit_summary(struct repository *repo,
197 const char *prefix,
198 const struct object_id *oid,
Phillip Woode47c6ca2017-11-24 11:07:54 +0000199 unsigned int flags);
Phillip Woodbcd33ec2018-10-31 10:15:55 +0000200
201int read_author_script(const char *path, char **name, char **email, char **date,
202 int allow_missing);
Alban Gruin65850682018-08-28 14:10:40 +0200203void parse_strategy_opts(struct replay_opts *opts, char *raw_opts);
204int write_basic_state(struct replay_opts *opts, const char *head_name,
Phillip Wood7d3488e2019-04-17 15:30:39 +0100205 struct commit *onto, const char *orig_head);
Junio C Hamanof496b062019-07-09 15:25:44 -0700206void sequencer_post_commit_cleanup(struct repository *r, int verbose);
Phillip Wood4a724862019-04-16 11:18:42 +0100207int sequencer_get_last_command(struct repository* r,
208 enum replay_action *action);
Phillip Wood12bb7a52019-10-15 10:25:30 +0000209#endif /* SEQUENCER_H */