Merge branch 'sg/t-helper-gitignore'
[git/git.git] / sequencer.h
1 #ifndef SEQUENCER_H
2 #define SEQUENCER_H
3
4 #include "cache.h"
5 #include "strbuf.h"
6
7 struct commit;
8 struct repository;
9
10 const char *git_path_commit_editmsg(void);
11 const char *git_path_seq_dir(void);
12 const char *rebase_path_todo(void);
13 const char *rebase_path_todo_backup(void);
14
15 #define APPEND_SIGNOFF_DEDUP (1u << 0)
16
17 enum replay_action {
18 REPLAY_REVERT,
19 REPLAY_PICK,
20 REPLAY_INTERACTIVE_REBASE
21 };
22
23 enum commit_msg_cleanup_mode {
24 COMMIT_MSG_CLEANUP_SPACE,
25 COMMIT_MSG_CLEANUP_NONE,
26 COMMIT_MSG_CLEANUP_SCISSORS,
27 COMMIT_MSG_CLEANUP_ALL
28 };
29
30 struct replay_opts {
31 enum replay_action action;
32
33 /* Boolean options */
34 int edit;
35 int record_origin;
36 int no_commit;
37 int signoff;
38 int allow_ff;
39 int allow_rerere_auto;
40 int allow_empty;
41 int allow_empty_message;
42 int keep_redundant_commits;
43 int verbose;
44 int quiet;
45 int reschedule_failed_exec;
46
47 int mainline;
48
49 char *gpg_sign;
50 enum commit_msg_cleanup_mode default_msg_cleanup;
51 int explicit_cleanup;
52
53 /* Merge strategy */
54 char *strategy;
55 char **xopts;
56 size_t xopts_nr, xopts_alloc;
57
58 /* Used by fixup/squash */
59 struct strbuf current_fixups;
60 int current_fixup_count;
61
62 /* placeholder commit for -i --root */
63 struct object_id squash_onto;
64 int have_squash_onto;
65
66 /* Only used by REPLAY_NONE */
67 struct rev_info *revs;
68 };
69 #define REPLAY_OPTS_INIT { .action = -1, .current_fixups = STRBUF_INIT }
70
71 /*
72 * Note that ordering matters in this enum. Not only must it match the mapping
73 * of todo_command_info (in sequencer.c), it is also divided into several
74 * sections that matter. When adding new commands, make sure you add it in the
75 * right section.
76 */
77 enum todo_command {
78 /* commands that handle commits */
79 TODO_PICK = 0,
80 TODO_REVERT,
81 TODO_EDIT,
82 TODO_REWORD,
83 TODO_FIXUP,
84 TODO_SQUASH,
85 /* commands that do something else than handling a single commit */
86 TODO_EXEC,
87 TODO_BREAK,
88 TODO_LABEL,
89 TODO_RESET,
90 TODO_MERGE,
91 /* commands that do nothing but are counted for reporting progress */
92 TODO_NOOP,
93 TODO_DROP,
94 /* comments (not counted for reporting progress) */
95 TODO_COMMENT
96 };
97
98 struct todo_item {
99 enum todo_command command;
100 struct commit *commit;
101 unsigned int flags;
102 int arg_len;
103 /* The offset of the command and its argument in the strbuf */
104 size_t offset_in_buf, arg_offset;
105 };
106
107 struct todo_list {
108 struct strbuf buf;
109 struct todo_item *items;
110 int nr, alloc, current;
111 int done_nr, total_nr;
112 struct stat_data stat;
113 };
114
115 #define TODO_LIST_INIT { STRBUF_INIT }
116
117 int todo_list_parse_insn_buffer(struct repository *r, char *buf,
118 struct todo_list *todo_list);
119 int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list,
120 const char *file, const char *shortrevisions,
121 const char *shortonto, int num, unsigned flags);
122 void todo_list_release(struct todo_list *todo_list);
123 const char *todo_item_get_arg(struct todo_list *todo_list,
124 struct todo_item *item);
125
126 /* Call this to setup defaults before parsing command line options */
127 void sequencer_init_config(struct replay_opts *opts);
128 int sequencer_pick_revisions(struct repository *repo,
129 struct replay_opts *opts);
130 int sequencer_continue(struct repository *repo, struct replay_opts *opts);
131 int sequencer_rollback(struct repository *repo, struct replay_opts *opts);
132 int sequencer_skip(struct repository *repo, struct replay_opts *opts);
133 int sequencer_remove_state(struct replay_opts *opts);
134
135 #define TODO_LIST_KEEP_EMPTY (1U << 0)
136 #define TODO_LIST_SHORTEN_IDS (1U << 1)
137 #define TODO_LIST_ABBREVIATE_CMDS (1U << 2)
138 #define TODO_LIST_REBASE_MERGES (1U << 3)
139 /*
140 * When rebasing merges, commits that do have the base commit as ancestor
141 * ("cousins") are *not* rebased onto the new base by default. If those
142 * commits should be rebased onto the new base, this flag needs to be passed.
143 */
144 #define TODO_LIST_REBASE_COUSINS (1U << 4)
145 #define TODO_LIST_APPEND_TODO_HELP (1U << 5)
146 /*
147 * When generating a script that rebases merges with `--root` *and* with
148 * `--onto`, we do not want to re-generate the root commits.
149 */
150 #define TODO_LIST_ROOT_WITH_ONTO (1U << 6)
151
152
153 int sequencer_make_script(struct repository *r, struct strbuf *out, int argc,
154 const char **argv, unsigned flags);
155
156 void todo_list_add_exec_commands(struct todo_list *todo_list,
157 struct string_list *commands);
158 int check_todo_list_from_file(struct repository *r);
159 int complete_action(struct repository *r, struct replay_opts *opts, unsigned flags,
160 const char *shortrevisions, const char *onto_name,
161 struct commit *onto, const char *orig_head, struct string_list *commands,
162 unsigned autosquash, struct todo_list *todo_list);
163 int todo_list_rearrange_squash(struct todo_list *todo_list);
164
165 /*
166 * Append a signoff to the commit message in "msgbuf". The ignore_footer
167 * parameter specifies the number of bytes at the end of msgbuf that should
168 * not be considered at all. I.e., they are not checked for existing trailers,
169 * and the new signoff will be spliced into the buffer before those bytes.
170 */
171 void append_signoff(struct strbuf *msgbuf, size_t ignore_footer, unsigned flag);
172
173 void append_conflicts_hint(struct index_state *istate,
174 struct strbuf *msgbuf, enum commit_msg_cleanup_mode cleanup_mode);
175 enum commit_msg_cleanup_mode get_cleanup_mode(const char *cleanup_arg,
176 int use_editor);
177
178 void cleanup_message(struct strbuf *msgbuf,
179 enum commit_msg_cleanup_mode cleanup_mode, int verbose);
180
181 int message_is_empty(const struct strbuf *sb,
182 enum commit_msg_cleanup_mode cleanup_mode);
183 int template_untouched(const struct strbuf *sb, const char *template_file,
184 enum commit_msg_cleanup_mode cleanup_mode);
185 int update_head_with_reflog(const struct commit *old_head,
186 const struct object_id *new_head,
187 const char *action, const struct strbuf *msg,
188 struct strbuf *err);
189 void commit_post_rewrite(struct repository *r,
190 const struct commit *current_head,
191 const struct object_id *new_head);
192
193 int prepare_branch_to_be_rebased(struct repository *r, struct replay_opts *opts,
194 const char *commit);
195
196 #define SUMMARY_INITIAL_COMMIT (1 << 0)
197 #define SUMMARY_SHOW_AUTHOR_DATE (1 << 1)
198 void print_commit_summary(struct repository *repo,
199 const char *prefix,
200 const struct object_id *oid,
201 unsigned int flags);
202
203 int read_author_script(const char *path, char **name, char **email, char **date,
204 int allow_missing);
205 #endif
206
207 void parse_strategy_opts(struct replay_opts *opts, char *raw_opts);
208 int write_basic_state(struct replay_opts *opts, const char *head_name,
209 struct commit *onto, const char *orig_head);
210 void sequencer_post_commit_cleanup(struct repository *r, int verbose);
211 int sequencer_get_last_command(struct repository* r,
212 enum replay_action *action);