transport.c: remove implicit dependency on the_index
[git/git.git] / sequencer.h
CommitLineData
26ae337b
RR
1#ifndef SEQUENCER_H
2#define SEQUENCER_H
3
ef3ca954
EN
4#include "cache.h"
5#include "strbuf.h"
6
7struct commit;
8
66618a50 9const char *git_path_commit_editmsg(void);
8a2a0f53 10const char *git_path_seq_dir(void);
44b776c3 11const char *rebase_path_todo(void);
26ae337b 12
bab4d109
BC
13#define APPEND_SIGNOFF_DEDUP (1u << 0)
14
043a4492
RR
15enum replay_action {
16 REPLAY_REVERT,
84583957
JS
17 REPLAY_PICK,
18 REPLAY_INTERACTIVE_REBASE
043a4492
RR
19};
20
28d6daed
PW
21enum commit_msg_cleanup_mode {
22 COMMIT_MSG_CLEANUP_SPACE,
23 COMMIT_MSG_CLEANUP_NONE,
24 COMMIT_MSG_CLEANUP_SCISSORS,
25 COMMIT_MSG_CLEANUP_ALL
26};
27
043a4492
RR
28struct replay_opts {
29 enum replay_action action;
043a4492
RR
30
31 /* Boolean options */
32 int edit;
33 int record_origin;
34 int no_commit;
35 int signoff;
36 int allow_ff;
37 int allow_rerere_auto;
df478b74 38 int allow_empty;
4bee9584 39 int allow_empty_message;
b27cfb0d 40 int keep_redundant_commits;
556907f1 41 int verbose;
043a4492
RR
42
43 int mainline;
44
03a4e260 45 char *gpg_sign;
28d6daed 46 enum commit_msg_cleanup_mode default_msg_cleanup;
3253553e 47
043a4492 48 /* Merge strategy */
03a4e260
JS
49 char *strategy;
50 char **xopts;
043a4492
RR
51 size_t xopts_nr, xopts_alloc;
52
e12a7ef5
JS
53 /* Used by fixup/squash */
54 struct strbuf current_fixups;
55 int current_fixup_count;
56
d87d48b2
JS
57 /* placeholder commit for -i --root */
58 struct object_id squash_onto;
59 int have_squash_onto;
60
043a4492
RR
61 /* Only used by REPLAY_NONE */
62 struct rev_info *revs;
63};
e12a7ef5 64#define REPLAY_OPTS_INIT { .action = -1, .current_fixups = STRBUF_INIT }
043a4492 65
44b776c3
AG
66enum missing_commit_check_level {
67 MISSING_COMMIT_CHECK_IGNORE = 0,
68 MISSING_COMMIT_CHECK_WARN,
69 MISSING_COMMIT_CHECK_ERROR
70};
71
72int write_message(const void *buf, size_t len, const char *filename,
73 int append_eol);
74
28d6daed
PW
75/* Call this to setup defaults before parsing command line options */
76void sequencer_init_config(struct replay_opts *opts);
043a4492 77int sequencer_pick_revisions(struct replay_opts *opts);
2863584f
JS
78int sequencer_continue(struct replay_opts *opts);
79int sequencer_rollback(struct replay_opts *opts);
80int sequencer_remove_state(struct replay_opts *opts);
043a4492 81
313a48ea
LB
82#define TODO_LIST_KEEP_EMPTY (1U << 0)
83#define TODO_LIST_SHORTEN_IDS (1U << 1)
d8ae6c84 84#define TODO_LIST_ABBREVIATE_CMDS (1U << 2)
1644c73c 85#define TODO_LIST_REBASE_MERGES (1U << 3)
7543f6f4
JS
86/*
87 * When rebasing merges, commits that do have the base commit as ancestor
88 * ("cousins") are *not* rebased onto the new base by default. If those
89 * commits should be rebased onto the new base, this flag needs to be passed.
90 */
91#define TODO_LIST_REBASE_COUSINS (1U << 4)
313a48ea
LB
92int sequencer_make_script(FILE *out, int argc, const char **argv,
93 unsigned flags);
62db5247 94
0cce4a27 95int sequencer_add_exec_commands(const char *command);
313a48ea 96int transform_todos(unsigned flags);
44b776c3 97enum missing_commit_check_level get_missing_commit_check_level(void);
94399949 98int check_todo_list(void);
b97e1873
AG
99int complete_action(struct replay_opts *opts, unsigned flags,
100 const char *shortrevisions, const char *onto_name,
101 const char *onto, const char *orig_head, const char *cmd,
102 unsigned autosquash);
c44a4c65 103int rearrange_squash(void);
3546c8d9 104
5ed75e2a
MV
105extern const char sign_off_header[];
106
66e83d9b
JK
107/*
108 * Append a signoff to the commit message in "msgbuf". The ignore_footer
109 * parameter specifies the number of bytes at the end of msgbuf that should
110 * not be considered at all. I.e., they are not checked for existing trailers,
111 * and the new signoff will be spliced into the buffer before those bytes.
112 */
113void append_signoff(struct strbuf *msgbuf, size_t ignore_footer, unsigned flag);
114
75c961b7 115void append_conflicts_hint(struct strbuf *msgbuf);
d0aaa46f
PW
116int message_is_empty(const struct strbuf *sb,
117 enum commit_msg_cleanup_mode cleanup_mode);
118int template_untouched(const struct strbuf *sb, const char *template_file,
119 enum commit_msg_cleanup_mode cleanup_mode);
0505d604
PW
120int update_head_with_reflog(const struct commit *old_head,
121 const struct object_id *new_head,
122 const char *action, const struct strbuf *msg,
123 struct strbuf *err);
a87a6f3c
PW
124void commit_post_rewrite(const struct commit *current_head,
125 const struct object_id *new_head);
5ed75e2a 126
2c58483a
AG
127int prepare_branch_to_be_rebased(struct replay_opts *opts, const char *commit);
128
e47c6caf
PW
129#define SUMMARY_INITIAL_COMMIT (1 << 0)
130#define SUMMARY_SHOW_AUTHOR_DATE (1 << 1)
131void print_commit_summary(const char *prefix, const struct object_id *oid,
132 unsigned int flags);
26ae337b 133#endif
65850686
AG
134
135void parse_strategy_opts(struct replay_opts *opts, char *raw_opts);
136int write_basic_state(struct replay_opts *opts, const char *head_name,
137 const char *onto, const char *orig_head);