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