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