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 const char *rebase_path_dropped(void);
  15
  16 #define APPEND_SIGNOFF_DEDUP (1u << 0)
  17
  18 enum replay_action {
  19         REPLAY_REVERT,
  20         REPLAY_PICK,
  21         REPLAY_INTERACTIVE_REBASE
  22 };
  23
  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
  29 };
  30
  31 struct replay_opts {
  32         enum replay_action action;
  33
  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;
  41         int allow_empty;
  42         int allow_empty_message;
  43         int keep_redundant_commits;
  44         int verbose;
  45         int quiet;
  46         int reschedule_failed_exec;
  47
  48         int mainline;
  49
  50         char *gpg_sign;
  51         enum commit_msg_cleanup_mode default_msg_cleanup;
  52         int explicit_cleanup;
  53
  54         /* Merge strategy */
  55         char *strategy;
  56         char **xopts;
  57         size_t xopts_nr, xopts_alloc;
  58
  59         /* Used by fixup/squash */
  60         struct strbuf current_fixups;
  61         int current_fixup_count;
  62
  63         /* placeholder commit for -i --root */
  64         struct object_id squash_onto;
  65         int have_squash_onto;
  66
  67         /* Only used by REPLAY_NONE */
  68         struct rev_info *revs;
  69 };
  70 #define REPLAY_OPTS_INIT { .action = -1, .current_fixups = STRBUF_INIT }
  71
  72 /*
  73  * Note that ordering matters in this enum. Not only must it match the mapping
  74  * of todo_command_info (in sequencer.c), it is also divided into several
  75  * sections that matter.  When adding new commands, make sure you add it in the
  76  * right section.
  77  */
  78 enum todo_command {
  79         /* commands that handle commits */
  80         TODO_PICK = 0,
  81         TODO_REVERT,
  82         TODO_EDIT,
  83         TODO_REWORD,
  84         TODO_FIXUP,
  85         TODO_SQUASH,
  86         /* commands that do something else than handling a single commit */
  87         TODO_EXEC,
  88         TODO_BREAK,
  89         TODO_LABEL,
  90         TODO_RESET,
  91         TODO_MERGE,
  92         /* commands that do nothing but are counted for reporting progress */
  93         TODO_NOOP,
  94         TODO_DROP,
  95         /* comments (not counted for reporting progress) */
  96         TODO_COMMENT
  97 };
  98
  99 struct todo_item {
 100         enum todo_command command;
 101         struct commit *commit;
 102         unsigned int flags;
 103         int arg_len;
 104         /* The offset of the command and its argument in the strbuf */
 105         size_t offset_in_buf, arg_offset;
 106 };
 107
 108 struct todo_list {
 109         struct strbuf buf;
 110         struct todo_item *items;
 111         int nr, alloc, current;
 112         int done_nr, total_nr;
 113         struct stat_data stat;
 114 };
 115
 116 #define TODO_LIST_INIT { STRBUF_INIT }
 117
 118 int todo_list_parse_insn_buffer(struct repository *r, char *buf,
 119                                 struct todo_list *todo_list);
 120 int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list,
 121                             const char *file, const char *shortrevisions,
 122                             const char *shortonto, int num, unsigned flags);
 123 void todo_list_release(struct todo_list *todo_list);
 124 const char *todo_item_get_arg(struct todo_list *todo_list,
 125                               struct todo_item *item);
 126
 127 /* Call this to setup defaults before parsing command line options */
 128 void sequencer_init_config(struct replay_opts *opts);
 129 int sequencer_pick_revisions(struct repository *repo,
 130                              struct replay_opts *opts);
 131 int sequencer_continue(struct repository *repo, struct replay_opts *opts);
 132 int sequencer_rollback(struct repository *repo, struct replay_opts *opts);
 133 int sequencer_skip(struct repository *repo, struct replay_opts *opts);
 134 int sequencer_remove_state(struct replay_opts *opts);
 135
 136 #define TODO_LIST_KEEP_EMPTY (1U << 0)
 137 #define TODO_LIST_SHORTEN_IDS (1U << 1)
 138 #define TODO_LIST_ABBREVIATE_CMDS (1U << 2)
 139 #define TODO_LIST_REBASE_MERGES (1U << 3)
 140 /*
 141  * When rebasing merges, commits that do have the base commit as ancestor
 142  * ("cousins") are *not* rebased onto the new base by default. If those
 143  * commits should be rebased onto the new base, this flag needs to be passed.
 144  */
 145 #define TODO_LIST_REBASE_COUSINS (1U << 4)
 146 #define TODO_LIST_APPEND_TODO_HELP (1U << 5)
 147 /*
 148  * When generating a script that rebases merges with `--root` *and* with
 149  * `--onto`, we do not want to re-generate the root commits.
 150  */
 151 #define TODO_LIST_ROOT_WITH_ONTO (1U << 6)
 152
 153
 154 int sequencer_make_script(struct repository *r, struct strbuf *out, int argc,
 155                           const char **argv, unsigned flags);
 156
 157 void todo_list_add_exec_commands(struct todo_list *todo_list,
 158                                  struct string_list *commands);
 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 #define SUMMARY_INITIAL_COMMIT   (1 << 0)
 194 #define SUMMARY_SHOW_AUTHOR_DATE (1 << 1)
 195 void print_commit_summary(struct repository *repo,
 196                           const char *prefix,
 197                           const struct object_id *oid,
 198                           unsigned int flags);
 199
 200 int read_author_script(const char *path, char **name, char **email, char **date,
 201                        int allow_missing);
 202 void parse_strategy_opts(struct replay_opts *opts, char *raw_opts);
 203 int write_basic_state(struct replay_opts *opts, const char *head_name,
 204                       struct commit *onto, const char *orig_head);
 205 void sequencer_post_commit_cleanup(struct repository *r, int verbose);
 206 int sequencer_get_last_command(struct repository* r,
 207                                enum replay_action *action);
 208 #endif /* SEQUENCER_H */