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
  14 #define APPEND_SIGNOFF_DEDUP (1u << 0)
  15
  16 enum replay_action {
  17         REPLAY_REVERT,
  18         REPLAY_PICK,
  19         REPLAY_INTERACTIVE_REBASE
  20 };
  21
  22 enum commit_msg_cleanup_mode {
  23         COMMIT_MSG_CLEANUP_SPACE,
  24         COMMIT_MSG_CLEANUP_NONE,
  25         COMMIT_MSG_CLEANUP_SCISSORS,
  26         COMMIT_MSG_CLEANUP_ALL
  27 };
  28
  29 struct replay_opts {
  30         enum replay_action action;
  31
  32         /* Boolean options */
  33         int edit;
  34         int record_origin;
  35         int no_commit;
  36         int signoff;
  37         int allow_ff;
  38         int allow_rerere_auto;
  39         int allow_empty;
  40         int allow_empty_message;
  41         int keep_redundant_commits;
  42         int verbose;
  43         int quiet;
  44         int reschedule_failed_exec;
  45
  46         int mainline;
  47
  48         char *gpg_sign;
  49         enum commit_msg_cleanup_mode default_msg_cleanup;
  50
  51         /* Merge strategy */
  52         char *strategy;
  53         char **xopts;
  54         size_t xopts_nr, xopts_alloc;
  55
  56         /* Used by fixup/squash */
  57         struct strbuf current_fixups;
  58         int current_fixup_count;
  59
  60         /* placeholder commit for -i --root */
  61         struct object_id squash_onto;
  62         int have_squash_onto;
  63
  64         /* Only used by REPLAY_NONE */
  65         struct rev_info *revs;
  66 };
  67 #define REPLAY_OPTS_INIT { .action = -1, .current_fixups = STRBUF_INIT }
  68
  69 enum missing_commit_check_level {
  70         MISSING_COMMIT_CHECK_IGNORE = 0,
  71         MISSING_COMMIT_CHECK_WARN,
  72         MISSING_COMMIT_CHECK_ERROR
  73 };
  74
  75 int write_message(const void *buf, size_t len, const char *filename,
  76                   int append_eol);
  77
  78 /* Call this to setup defaults before parsing command line options */
  79 void sequencer_init_config(struct replay_opts *opts);
  80 int sequencer_pick_revisions(struct repository *repo,
  81                              struct replay_opts *opts);
  82 int sequencer_continue(struct repository *repo, struct replay_opts *opts);
  83 int sequencer_rollback(struct repository *repo, struct replay_opts *opts);
  84 int sequencer_remove_state(struct replay_opts *opts);
  85
  86 #define TODO_LIST_KEEP_EMPTY (1U << 0)
  87 #define TODO_LIST_SHORTEN_IDS (1U << 1)
  88 #define TODO_LIST_ABBREVIATE_CMDS (1U << 2)
  89 #define TODO_LIST_REBASE_MERGES (1U << 3)
  90 /*
  91  * When rebasing merges, commits that do have the base commit as ancestor
  92  * ("cousins") are *not* rebased onto the new base by default. If those
  93  * commits should be rebased onto the new base, this flag needs to be passed.
  94  */
  95 #define TODO_LIST_REBASE_COUSINS (1U << 4)
  96 int sequencer_make_script(struct repository *repo, FILE *out,
  97                           int argc, const char **argv,
  98                           unsigned flags);
  99
 100 int sequencer_add_exec_commands(struct repository *r, const char *command);
 101 int transform_todos(struct repository *r, unsigned flags);
 102 enum missing_commit_check_level get_missing_commit_check_level(void);
 103 int check_todo_list(struct repository *r);
 104 int complete_action(struct repository *r, struct replay_opts *opts, unsigned flags,
 105                     const char *shortrevisions, const char *onto_name,
 106                     const char *onto, const char *orig_head, const char *cmd,
 107                     unsigned autosquash);
 108 int rearrange_squash(struct repository *r);
 109
 110 extern const char sign_off_header[];
 111
 112 /*
 113  * Append a signoff to the commit message in "msgbuf". The ignore_footer
 114  * parameter specifies the number of bytes at the end of msgbuf that should
 115  * not be considered at all. I.e., they are not checked for existing trailers,
 116  * and the new signoff will be spliced into the buffer before those bytes.
 117  */
 118 void append_signoff(struct strbuf *msgbuf, size_t ignore_footer, unsigned flag);
 119
 120 void append_conflicts_hint(struct index_state *istate, struct strbuf *msgbuf);
 121 int message_is_empty(const struct strbuf *sb,
 122                      enum commit_msg_cleanup_mode cleanup_mode);
 123 int template_untouched(const struct strbuf *sb, const char *template_file,
 124                        enum commit_msg_cleanup_mode cleanup_mode);
 125 int update_head_with_reflog(const struct commit *old_head,
 126                             const struct object_id *new_head,
 127                             const char *action, const struct strbuf *msg,
 128                             struct strbuf *err);
 129 void commit_post_rewrite(struct repository *r,
 130                          const struct commit *current_head,
 131                          const struct object_id *new_head);
 132
 133 int prepare_branch_to_be_rebased(struct replay_opts *opts, const char *commit);
 134
 135 #define SUMMARY_INITIAL_COMMIT   (1 << 0)
 136 #define SUMMARY_SHOW_AUTHOR_DATE (1 << 1)
 137 void print_commit_summary(struct repository *repo,
 138                           const char *prefix,
 139                           const struct object_id *oid,
 140                           unsigned int flags);
 141
 142 int read_author_script(const char *path, char **name, char **email, char **date,
 143                        int allow_missing);
 144 #endif
 145
 146 void parse_strategy_opts(struct replay_opts *opts, char *raw_opts);
 147 int write_basic_state(struct replay_opts *opts, const char *head_name,
 148                       const char *onto, const char *orig_head);