sequencer.h

   1 #ifndef SEQUENCER_H
   2 #define SEQUENCER_H
   3
   4 #include "cache.h"
   5 #include "strbuf.h"
   6
   7 struct commit;
   8
   9 const char *git_path_commit_editmsg(void);
  10 const char *git_path_seq_dir(void);
  11 const char *rebase_path_todo(void);
  12
  13 #define APPEND_SIGNOFF_DEDUP (1u << 0)
  14
  15 enum replay_action {
  16         REPLAY_REVERT,
  17         REPLAY_PICK,
  18         REPLAY_INTERACTIVE_REBASE
  19 };
  20
  21 enum 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
  28 struct replay_opts {
  29         enum replay_action action;
  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;
  38         int allow_empty;
  39         int allow_empty_message;
  40         int keep_redundant_commits;
  41         int verbose;
  42         int quiet;
  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 replay_opts *opts);
  79 int sequencer_continue(struct replay_opts *opts);
  80 int sequencer_rollback(struct replay_opts *opts);
  81 int sequencer_remove_state(struct replay_opts *opts);
  82
  83 #define TODO_LIST_KEEP_EMPTY (1U << 0)
  84 #define TODO_LIST_SHORTEN_IDS (1U << 1)
  85 #define TODO_LIST_ABBREVIATE_CMDS (1U << 2)
  86 #define TODO_LIST_REBASE_MERGES (1U << 3)
  87 /*
  88  * When rebasing merges, commits that do have the base commit as ancestor
  89  * ("cousins") are *not* rebased onto the new base by default. If those
  90  * commits should be rebased onto the new base, this flag needs to be passed.
  91  */
  92 #define TODO_LIST_REBASE_COUSINS (1U << 4)
  93 int sequencer_make_script(FILE *out, int argc, const char **argv,
  94                           unsigned flags);
  95
  96 int sequencer_add_exec_commands(const char *command);
  97 int transform_todos(unsigned flags);
  98 enum missing_commit_check_level get_missing_commit_check_level(void);
  99 int check_todo_list(void);
 100 int complete_action(struct replay_opts *opts, unsigned flags,
 101                     const char *shortrevisions, const char *onto_name,
 102                     const char *onto, const char *orig_head, const char *cmd,
 103                     unsigned autosquash);
 104 int rearrange_squash(void);
 105
 106 extern const char sign_off_header[];
 107
 108 /*
 109  * Append a signoff to the commit message in "msgbuf". The ignore_footer
 110  * parameter specifies the number of bytes at the end of msgbuf that should
 111  * not be considered at all. I.e., they are not checked for existing trailers,
 112  * and the new signoff will be spliced into the buffer before those bytes.
 113  */
 114 void append_signoff(struct strbuf *msgbuf, size_t ignore_footer, unsigned flag);
 115
 116 void append_conflicts_hint(struct strbuf *msgbuf);
 117 int message_is_empty(const struct strbuf *sb,
 118                      enum commit_msg_cleanup_mode cleanup_mode);
 119 int template_untouched(const struct strbuf *sb, const char *template_file,
 120                        enum commit_msg_cleanup_mode cleanup_mode);
 121 int update_head_with_reflog(const struct commit *old_head,
 122                             const struct object_id *new_head,
 123                             const char *action, const struct strbuf *msg,
 124                             struct strbuf *err);
 125 void commit_post_rewrite(const struct commit *current_head,
 126                          const struct object_id *new_head);
 127
 128 int prepare_branch_to_be_rebased(struct replay_opts *opts, const char *commit);
 129
 130 #define SUMMARY_INITIAL_COMMIT   (1 << 0)
 131 #define SUMMARY_SHOW_AUTHOR_DATE (1 << 1)
 132 void print_commit_summary(const char *prefix, const struct object_id *oid,
 133                           unsigned int flags);
 134
 135 int read_author_script(const char *path, char **name, char **email, char **date,
 136                        int allow_missing);
 137 #endif
 138
 139 void parse_strategy_opts(struct replay_opts *opts, char *raw_opts);
 140 int write_basic_state(struct replay_opts *opts, const char *head_name,
 141                       const char *onto, const char *orig_head);