git.oblomov.eu Git - git/blob - 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         int explicit_cleanup;
  51
  52         /* Merge strategy */
  53         char *strategy;
  54         char **xopts;
  55         size_t xopts_nr, xopts_alloc;
  56
  57         /* Used by fixup/squash */
  58         struct strbuf current_fixups;
  59         int current_fixup_count;
  60
  61         /* placeholder commit for -i --root */
  62         struct object_id squash_onto;
  63         int have_squash_onto;
  64
  65         /* Only used by REPLAY_NONE */
  66         struct rev_info *revs;
  67 };
  68 #define REPLAY_OPTS_INIT { .action = -1, .current_fixups = STRBUF_INIT }
  69
  70 enum missing_commit_check_level {
  71         MISSING_COMMIT_CHECK_IGNORE = 0,
  72         MISSING_COMMIT_CHECK_WARN,
  73         MISSING_COMMIT_CHECK_ERROR
  74 };
  75
  76 int write_message(const void *buf, size_t len, const char *filename,
  77                   int append_eol);
  78
  79 /* Call this to setup defaults before parsing command line options */
  80 void sequencer_init_config(struct replay_opts *opts);
  81 int sequencer_pick_revisions(struct repository *repo,
  82                              struct replay_opts *opts);
  83 int sequencer_continue(struct repository *repo, struct replay_opts *opts);
  84 int sequencer_rollback(struct repository *repo, struct replay_opts *opts);
  85 int sequencer_remove_state(struct replay_opts *opts);
  86
  87 #define TODO_LIST_KEEP_EMPTY (1U << 0)
  88 #define TODO_LIST_SHORTEN_IDS (1U << 1)
  89 #define TODO_LIST_ABBREVIATE_CMDS (1U << 2)
  90 #define TODO_LIST_REBASE_MERGES (1U << 3)
  91 /*
  92  * When rebasing merges, commits that do have the base commit as ancestor
  93  * ("cousins") are *not* rebased onto the new base by default. If those
  94  * commits should be rebased onto the new base, this flag needs to be passed.
  95  */
  96 #define TODO_LIST_REBASE_COUSINS (1U << 4)
  97 int sequencer_make_script(struct repository *repo, FILE *out,
  98                           int argc, const char **argv,
  99                           unsigned flags);
 100
 101 int sequencer_add_exec_commands(struct repository *r, const char *command);
 102 int transform_todos(struct repository *r, unsigned flags);
 103 enum missing_commit_check_level get_missing_commit_check_level(void);
 104 int check_todo_list(struct repository *r);
 105 int complete_action(struct repository *r, struct replay_opts *opts, unsigned flags,
 106                     const char *shortrevisions, const char *onto_name,
 107                     const char *onto, const char *orig_head, const char *cmd,
 108                     unsigned autosquash);
 109 int rearrange_squash(struct repository *r);
 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,
 120                 struct strbuf *msgbuf, enum commit_msg_cleanup_mode cleanup_mode);
 121 enum commit_msg_cleanup_mode get_cleanup_mode(const char *cleanup_arg,
 122         int use_editor);
 123
 124 void cleanup_message(struct strbuf *msgbuf,
 125         enum commit_msg_cleanup_mode cleanup_mode, int verbose);
 126
 127 int message_is_empty(const struct strbuf *sb,
 128                      enum commit_msg_cleanup_mode cleanup_mode);
 129 int template_untouched(const struct strbuf *sb, const char *template_file,
 130                        enum commit_msg_cleanup_mode cleanup_mode);
 131 int update_head_with_reflog(const struct commit *old_head,
 132                             const struct object_id *new_head,
 133                             const char *action, const struct strbuf *msg,
 134                             struct strbuf *err);
 135 void commit_post_rewrite(struct repository *r,
 136                          const struct commit *current_head,
 137                          const struct object_id *new_head);
 138
 139 int prepare_branch_to_be_rebased(struct replay_opts *opts, const char *commit);
 140
 141 #define SUMMARY_INITIAL_COMMIT   (1 << 0)
 142 #define SUMMARY_SHOW_AUTHOR_DATE (1 << 1)
 143 void print_commit_summary(struct repository *repo,
 144                           const char *prefix,
 145                           const struct object_id *oid,
 146                           unsigned int flags);
 147
 148 int read_author_script(const char *path, char **name, char **email, char **date,
 149                        int allow_missing);
 150 #endif
 151
 152 void parse_strategy_opts(struct replay_opts *opts, char *raw_opts);
 153 int write_basic_state(struct replay_opts *opts, const char *head_name,
 154                       const char *onto, const char *orig_head);