Andrew's git - gitweb.git/blob

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