Git 2.39.4
[git.git] / sequencer.h
blob888c18aad7188e48985eb5c994b13853dc30c137
1 #ifndef SEQUENCER_H
2 #define SEQUENCER_H
4 #include "cache.h"
5 #include "strbuf.h"
6 #include "wt-status.h"
8 struct commit;
9 struct repository;
11 const char *git_path_commit_editmsg(void);
12 const char *rebase_path_todo(void);
13 const char *rebase_path_todo_backup(void);
14 const char *rebase_path_dropped(void);
16 #define APPEND_SIGNOFF_DEDUP (1u << 0)
18 enum replay_action {
19 REPLAY_REVERT,
20 REPLAY_PICK,
21 REPLAY_INTERACTIVE_REBASE
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
31 struct replay_opts {
32 enum replay_action action;
34 /* Tri-state options: unspecified, false, or true */
35 int edit;
37 /* Boolean options */
38 int record_origin;
39 int no_commit;
40 int signoff;
41 int allow_ff;
42 int allow_rerere_auto;
43 int allow_empty;
44 int allow_empty_message;
45 int drop_redundant_commits;
46 int keep_redundant_commits;
47 int verbose;
48 int quiet;
49 int reschedule_failed_exec;
50 int committer_date_is_author_date;
51 int ignore_date;
52 int commit_use_reference;
54 int mainline;
56 char *gpg_sign;
57 enum commit_msg_cleanup_mode default_msg_cleanup;
58 int explicit_cleanup;
60 /* Merge strategy */
61 char *default_strategy; /* from config options */
62 char *strategy;
63 char **xopts;
64 size_t xopts_nr, xopts_alloc;
66 /* Reflog */
67 char *reflog_action;
69 /* Used by fixup/squash */
70 struct strbuf current_fixups;
71 int current_fixup_count;
73 /* placeholder commit for -i --root */
74 struct object_id squash_onto;
75 int have_squash_onto;
77 /* Only used by REPLAY_NONE */
78 struct rev_info *revs;
80 /* Private use */
81 const char *reflog_message;
83 #define REPLAY_OPTS_INIT { .edit = -1, .action = -1, .current_fixups = STRBUF_INIT }
86 * Note that ordering matters in this enum. Not only must it match the mapping
87 * of todo_command_info (in sequencer.c), it is also divided into several
88 * sections that matter. When adding new commands, make sure you add it in the
89 * right section.
91 enum todo_command {
92 /* commands that handle commits */
93 TODO_PICK = 0,
94 TODO_REVERT,
95 TODO_EDIT,
96 TODO_REWORD,
97 TODO_FIXUP,
98 TODO_SQUASH,
99 /* commands that do something else than handling a single commit */
100 TODO_EXEC,
101 TODO_BREAK,
102 TODO_LABEL,
103 TODO_RESET,
104 TODO_MERGE,
105 TODO_UPDATE_REF,
106 /* commands that do nothing but are counted for reporting progress */
107 TODO_NOOP,
108 TODO_DROP,
109 /* comments (not counted for reporting progress) */
110 TODO_COMMENT
113 struct todo_item {
114 enum todo_command command;
115 struct commit *commit;
116 unsigned int flags;
117 int arg_len;
118 /* The offset of the command and its argument in the strbuf */
119 size_t offset_in_buf, arg_offset;
122 struct todo_list {
123 struct strbuf buf;
124 struct todo_item *items;
125 int nr, alloc, current;
126 int done_nr, total_nr;
129 #define TODO_LIST_INIT { \
130 .buf = STRBUF_INIT, \
133 int todo_list_parse_insn_buffer(struct repository *r, char *buf,
134 struct todo_list *todo_list);
135 int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list,
136 const char *file, const char *shortrevisions,
137 const char *shortonto, int num, unsigned flags);
138 void todo_list_release(struct todo_list *todo_list);
139 const char *todo_item_get_arg(struct todo_list *todo_list,
140 struct todo_item *item);
143 * Parse the update-refs file for the current rebase, then remove the
144 * refs that do not appear in the todo_list (and have not had updated
145 * values stored) and add refs that are in the todo_list but not
146 * represented in the update-refs file.
148 * If there are changes to the update-refs list, then write the new state
149 * to disk.
151 void todo_list_filter_update_refs(struct repository *r,
152 struct todo_list *todo_list);
154 /* Call this to setup defaults before parsing command line options */
155 void sequencer_init_config(struct replay_opts *opts);
156 int sequencer_pick_revisions(struct repository *repo,
157 struct replay_opts *opts);
158 int sequencer_continue(struct repository *repo, struct replay_opts *opts);
159 int sequencer_rollback(struct repository *repo, struct replay_opts *opts);
160 int sequencer_skip(struct repository *repo, struct replay_opts *opts);
161 int sequencer_remove_state(struct replay_opts *opts);
163 #define TODO_LIST_KEEP_EMPTY (1U << 0)
164 #define TODO_LIST_SHORTEN_IDS (1U << 1)
165 #define TODO_LIST_ABBREVIATE_CMDS (1U << 2)
166 #define TODO_LIST_REBASE_MERGES (1U << 3)
168 * When rebasing merges, commits that do have the base commit as ancestor
169 * ("cousins") are *not* rebased onto the new base by default. If those
170 * commits should be rebased onto the new base, this flag needs to be passed.
172 #define TODO_LIST_REBASE_COUSINS (1U << 4)
173 #define TODO_LIST_APPEND_TODO_HELP (1U << 5)
175 * When generating a script that rebases merges with `--root` *and* with
176 * `--onto`, we do not want to re-generate the root commits.
178 #define TODO_LIST_ROOT_WITH_ONTO (1U << 6)
179 #define TODO_LIST_REAPPLY_CHERRY_PICKS (1U << 7)
180 #define TODO_LIST_WARN_SKIPPED_CHERRY_PICKS (1U << 8)
182 int sequencer_make_script(struct repository *r, struct strbuf *out, int argc,
183 const char **argv, unsigned flags);
185 int complete_action(struct repository *r, struct replay_opts *opts, unsigned flags,
186 const char *shortrevisions, const char *onto_name,
187 struct commit *onto, const struct object_id *orig_head,
188 struct string_list *commands, unsigned autosquash,
189 unsigned update_refs,
190 struct todo_list *todo_list);
191 int todo_list_rearrange_squash(struct todo_list *todo_list);
194 * Append a signoff to the commit message in "msgbuf". The ignore_footer
195 * parameter specifies the number of bytes at the end of msgbuf that should
196 * not be considered at all. I.e., they are not checked for existing trailers,
197 * and the new signoff will be spliced into the buffer before those bytes.
199 void append_signoff(struct strbuf *msgbuf, size_t ignore_footer, unsigned flag);
201 void append_conflicts_hint(struct index_state *istate,
202 struct strbuf *msgbuf, enum commit_msg_cleanup_mode cleanup_mode);
203 enum commit_msg_cleanup_mode get_cleanup_mode(const char *cleanup_arg,
204 int use_editor);
206 void cleanup_message(struct strbuf *msgbuf,
207 enum commit_msg_cleanup_mode cleanup_mode, int verbose);
209 int message_is_empty(const struct strbuf *sb,
210 enum commit_msg_cleanup_mode cleanup_mode);
211 int template_untouched(const struct strbuf *sb, const char *template_file,
212 enum commit_msg_cleanup_mode cleanup_mode);
213 int update_head_with_reflog(const struct commit *old_head,
214 const struct object_id *new_head,
215 const char *action, const struct strbuf *msg,
216 struct strbuf *err);
217 void commit_post_rewrite(struct repository *r,
218 const struct commit *current_head,
219 const struct object_id *new_head);
221 void create_autostash(struct repository *r, const char *path);
222 int save_autostash(const char *path);
223 int apply_autostash(const char *path);
224 int apply_autostash_oid(const char *stash_oid);
226 #define SUMMARY_INITIAL_COMMIT (1 << 0)
227 #define SUMMARY_SHOW_AUTHOR_DATE (1 << 1)
228 void print_commit_summary(struct repository *repo,
229 const char *prefix,
230 const struct object_id *oid,
231 unsigned int flags);
233 #define READ_ONELINER_SKIP_IF_EMPTY (1 << 0)
234 #define READ_ONELINER_WARN_MISSING (1 << 1)
237 * Reads a file that was presumably written by a shell script, i.e. with an
238 * end-of-line marker that needs to be stripped.
240 * Note that only the last end-of-line marker is stripped, consistent with the
241 * behavior of "$(cat path)" in a shell script.
243 * Returns 1 if the file was read, 0 if it could not be read or does not exist.
245 int read_oneliner(struct strbuf *buf,
246 const char *path, unsigned flags);
247 int read_author_script(const char *path, char **name, char **email, char **date,
248 int allow_missing);
249 void parse_strategy_opts(struct replay_opts *opts, char *raw_opts);
250 int write_basic_state(struct replay_opts *opts, const char *head_name,
251 struct commit *onto, const struct object_id *orig_head);
252 void sequencer_post_commit_cleanup(struct repository *r, int verbose);
253 int sequencer_get_last_command(struct repository* r,
254 enum replay_action *action);
255 int sequencer_determine_whence(struct repository *r, enum commit_whence *whence);
258 * Append the set of ref-OID pairs that are currently stored for the 'git
259 * rebase --update-refs' feature if such a rebase is currently happening.
261 * Localized to a worktree's git dir.
263 int sequencer_get_update_refs_state(const char *wt_dir, struct string_list *refs);
265 #endif /* SEQUENCER_H */