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)
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
32 enum replay_action action
;
40 int allow_rerere_auto
;
42 int allow_empty_message
;
43 int drop_redundant_commits
;
44 int keep_redundant_commits
;
47 int reschedule_failed_exec
;
48 int committer_date_is_author_date
;
54 char *committer_email
;
56 enum commit_msg_cleanup_mode default_msg_cleanup
;
60 char *default_strategy
; /* from config options */
63 size_t xopts_nr
, xopts_alloc
;
65 /* Used by fixup/squash */
66 struct strbuf current_fixups
;
67 int current_fixup_count
;
69 /* placeholder commit for -i --root */
70 struct object_id squash_onto
;
73 /* Only used by REPLAY_NONE */
74 struct rev_info
*revs
;
76 #define REPLAY_OPTS_INIT { .action = -1, .current_fixups = STRBUF_INIT }
79 * Note that ordering matters in this enum. Not only must it match the mapping
80 * of todo_command_info (in sequencer.c), it is also divided into several
81 * sections that matter. When adding new commands, make sure you add it in the
85 /* commands that handle commits */
92 /* commands that do something else than handling a single commit */
98 /* commands that do nothing but are counted for reporting progress */
101 /* comments (not counted for reporting progress) */
106 enum todo_command command
;
107 struct commit
*commit
;
110 /* The offset of the command and its argument in the strbuf */
111 size_t offset_in_buf
, arg_offset
;
116 struct todo_item
*items
;
117 int nr
, alloc
, current
;
118 int done_nr
, total_nr
;
119 struct stat_data stat
;
122 #define TODO_LIST_INIT { STRBUF_INIT }
124 int todo_list_parse_insn_buffer(struct repository
*r
, char *buf
,
125 struct todo_list
*todo_list
);
126 int todo_list_write_to_file(struct repository
*r
, struct todo_list
*todo_list
,
127 const char *file
, const char *shortrevisions
,
128 const char *shortonto
, int num
, unsigned flags
);
129 void todo_list_release(struct todo_list
*todo_list
);
130 const char *todo_item_get_arg(struct todo_list
*todo_list
,
131 struct todo_item
*item
);
133 /* Call this to setup defaults before parsing command line options */
134 void sequencer_init_config(struct replay_opts
*opts
);
135 int sequencer_pick_revisions(struct repository
*repo
,
136 struct replay_opts
*opts
);
137 int sequencer_continue(struct repository
*repo
, struct replay_opts
*opts
);
138 int sequencer_rollback(struct repository
*repo
, struct replay_opts
*opts
);
139 int sequencer_skip(struct repository
*repo
, struct replay_opts
*opts
);
140 int sequencer_remove_state(struct replay_opts
*opts
);
142 #define TODO_LIST_KEEP_EMPTY (1U << 0)
143 #define TODO_LIST_SHORTEN_IDS (1U << 1)
144 #define TODO_LIST_ABBREVIATE_CMDS (1U << 2)
145 #define TODO_LIST_REBASE_MERGES (1U << 3)
147 * When rebasing merges, commits that do have the base commit as ancestor
148 * ("cousins") are *not* rebased onto the new base by default. If those
149 * commits should be rebased onto the new base, this flag needs to be passed.
151 #define TODO_LIST_REBASE_COUSINS (1U << 4)
152 #define TODO_LIST_APPEND_TODO_HELP (1U << 5)
154 * When generating a script that rebases merges with `--root` *and* with
155 * `--onto`, we do not want to re-generate the root commits.
157 #define TODO_LIST_ROOT_WITH_ONTO (1U << 6)
158 #define TODO_LIST_REAPPLY_CHERRY_PICKS (1U << 7)
160 int sequencer_make_script(struct repository
*r
, struct strbuf
*out
, int argc
,
161 const char **argv
, unsigned flags
);
163 void todo_list_add_exec_commands(struct todo_list
*todo_list
,
164 struct string_list
*commands
);
165 int complete_action(struct repository
*r
, struct replay_opts
*opts
, unsigned flags
,
166 const char *shortrevisions
, const char *onto_name
,
167 struct commit
*onto
, const char *orig_head
, struct string_list
*commands
,
168 unsigned autosquash
, struct todo_list
*todo_list
);
169 int todo_list_rearrange_squash(struct todo_list
*todo_list
);
172 * Append a signoff to the commit message in "msgbuf". The ignore_footer
173 * parameter specifies the number of bytes at the end of msgbuf that should
174 * not be considered at all. I.e., they are not checked for existing trailers,
175 * and the new signoff will be spliced into the buffer before those bytes.
177 void append_signoff(struct strbuf
*msgbuf
, size_t ignore_footer
, unsigned flag
);
179 void append_conflicts_hint(struct index_state
*istate
,
180 struct strbuf
*msgbuf
, enum commit_msg_cleanup_mode cleanup_mode
);
181 enum commit_msg_cleanup_mode
get_cleanup_mode(const char *cleanup_arg
,
184 void cleanup_message(struct strbuf
*msgbuf
,
185 enum commit_msg_cleanup_mode cleanup_mode
, int verbose
);
187 int message_is_empty(const struct strbuf
*sb
,
188 enum commit_msg_cleanup_mode cleanup_mode
);
189 int template_untouched(const struct strbuf
*sb
, const char *template_file
,
190 enum commit_msg_cleanup_mode cleanup_mode
);
191 int update_head_with_reflog(const struct commit
*old_head
,
192 const struct object_id
*new_head
,
193 const char *action
, const struct strbuf
*msg
,
195 void commit_post_rewrite(struct repository
*r
,
196 const struct commit
*current_head
,
197 const struct object_id
*new_head
);
199 void create_autostash(struct repository
*r
, const char *path
,
200 const char *default_reflog_action
);
201 int save_autostash(const char *path
);
202 int apply_autostash(const char *path
);
203 int apply_autostash_oid(const char *stash_oid
);
205 #define SUMMARY_INITIAL_COMMIT (1 << 0)
206 #define SUMMARY_SHOW_AUTHOR_DATE (1 << 1)
207 void print_commit_summary(struct repository
*repo
,
209 const struct object_id
*oid
,
212 #define READ_ONELINER_SKIP_IF_EMPTY (1 << 0)
213 #define READ_ONELINER_WARN_MISSING (1 << 1)
216 * Reads a file that was presumably written by a shell script, i.e. with an
217 * end-of-line marker that needs to be stripped.
219 * Note that only the last end-of-line marker is stripped, consistent with the
220 * behavior of "$(cat path)" in a shell script.
222 * Returns 1 if the file was read, 0 if it could not be read or does not exist.
224 int read_oneliner(struct strbuf
*buf
,
225 const char *path
, unsigned flags
);
226 int read_author_script(const char *path
, char **name
, char **email
, char **date
,
228 void parse_strategy_opts(struct replay_opts
*opts
, char *raw_opts
);
229 int write_basic_state(struct replay_opts
*opts
, const char *head_name
,
230 struct commit
*onto
, const char *orig_head
);
231 void sequencer_post_commit_cleanup(struct repository
*r
, int verbose
);
232 int sequencer_get_last_command(struct repository
* r
,
233 enum replay_action
*action
);
234 int sequencer_determine_whence(struct repository
*r
, enum commit_whence
*whence
);
235 #endif /* SEQUENCER_H */