mirror of
https://github.com/git/git.git
synced 2024-05-19 22:16:21 +02:00
66e83d9b41
The append_signoff() function takes an "int" to specify the number of bytes to ignore. Most callers just pass 0, and the remainder use ignore_non_trailer() to skip over cruft. That function also returns an int, and uses them internally. On systems where size_t is larger than an int (i.e., most 64-bit systems), dealing with a ridiculously large commit message could end up overflowing an int, producing surprising results (e.g., returning a negative offset, which would cause us to look outside the original string). Let's consistently use size_t for these offsets through this whole stack. As a bonus, this makes the meaning of "ignore_footer" as an offset (and not a boolean) more clear. But while we're here, let's also document the interface. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
113 lines
3.3 KiB
C
113 lines
3.3 KiB
C
#ifndef SEQUENCER_H
|
|
#define SEQUENCER_H
|
|
|
|
const char *git_path_commit_editmsg(void);
|
|
const char *git_path_seq_dir(void);
|
|
|
|
#define APPEND_SIGNOFF_DEDUP (1u << 0)
|
|
|
|
enum replay_action {
|
|
REPLAY_REVERT,
|
|
REPLAY_PICK,
|
|
REPLAY_INTERACTIVE_REBASE
|
|
};
|
|
|
|
enum commit_msg_cleanup_mode {
|
|
COMMIT_MSG_CLEANUP_SPACE,
|
|
COMMIT_MSG_CLEANUP_NONE,
|
|
COMMIT_MSG_CLEANUP_SCISSORS,
|
|
COMMIT_MSG_CLEANUP_ALL
|
|
};
|
|
|
|
struct replay_opts {
|
|
enum replay_action action;
|
|
|
|
/* Boolean options */
|
|
int edit;
|
|
int record_origin;
|
|
int no_commit;
|
|
int signoff;
|
|
int allow_ff;
|
|
int allow_rerere_auto;
|
|
int allow_empty;
|
|
int allow_empty_message;
|
|
int keep_redundant_commits;
|
|
int verbose;
|
|
|
|
int mainline;
|
|
|
|
char *gpg_sign;
|
|
enum commit_msg_cleanup_mode default_msg_cleanup;
|
|
|
|
/* Merge strategy */
|
|
char *strategy;
|
|
char **xopts;
|
|
size_t xopts_nr, xopts_alloc;
|
|
|
|
/* Used by fixup/squash */
|
|
struct strbuf current_fixups;
|
|
int current_fixup_count;
|
|
|
|
/* placeholder commit for -i --root */
|
|
struct object_id squash_onto;
|
|
int have_squash_onto;
|
|
|
|
/* Only used by REPLAY_NONE */
|
|
struct rev_info *revs;
|
|
};
|
|
#define REPLAY_OPTS_INIT { .action = -1, .current_fixups = STRBUF_INIT }
|
|
|
|
/* Call this to setup defaults before parsing command line options */
|
|
void sequencer_init_config(struct replay_opts *opts);
|
|
int sequencer_pick_revisions(struct replay_opts *opts);
|
|
int sequencer_continue(struct replay_opts *opts);
|
|
int sequencer_rollback(struct replay_opts *opts);
|
|
int sequencer_remove_state(struct replay_opts *opts);
|
|
|
|
#define TODO_LIST_KEEP_EMPTY (1U << 0)
|
|
#define TODO_LIST_SHORTEN_IDS (1U << 1)
|
|
#define TODO_LIST_ABBREVIATE_CMDS (1U << 2)
|
|
#define TODO_LIST_REBASE_MERGES (1U << 3)
|
|
/*
|
|
* When rebasing merges, commits that do have the base commit as ancestor
|
|
* ("cousins") are *not* rebased onto the new base by default. If those
|
|
* commits should be rebased onto the new base, this flag needs to be passed.
|
|
*/
|
|
#define TODO_LIST_REBASE_COUSINS (1U << 4)
|
|
int sequencer_make_script(FILE *out, int argc, const char **argv,
|
|
unsigned flags);
|
|
|
|
int sequencer_add_exec_commands(const char *command);
|
|
int transform_todos(unsigned flags);
|
|
int check_todo_list(void);
|
|
int skip_unnecessary_picks(void);
|
|
int rearrange_squash(void);
|
|
|
|
extern const char sign_off_header[];
|
|
|
|
/*
|
|
* Append a signoff to the commit message in "msgbuf". The ignore_footer
|
|
* parameter specifies the number of bytes at the end of msgbuf that should
|
|
* not be considered at all. I.e., they are not checked for existing trailers,
|
|
* and the new signoff will be spliced into the buffer before those bytes.
|
|
*/
|
|
void append_signoff(struct strbuf *msgbuf, size_t ignore_footer, unsigned flag);
|
|
|
|
void append_conflicts_hint(struct strbuf *msgbuf);
|
|
int message_is_empty(const struct strbuf *sb,
|
|
enum commit_msg_cleanup_mode cleanup_mode);
|
|
int template_untouched(const struct strbuf *sb, const char *template_file,
|
|
enum commit_msg_cleanup_mode cleanup_mode);
|
|
int update_head_with_reflog(const struct commit *old_head,
|
|
const struct object_id *new_head,
|
|
const char *action, const struct strbuf *msg,
|
|
struct strbuf *err);
|
|
void commit_post_rewrite(const struct commit *current_head,
|
|
const struct object_id *new_head);
|
|
|
|
#define SUMMARY_INITIAL_COMMIT (1 << 0)
|
|
#define SUMMARY_SHOW_AUTHOR_DATE (1 << 1)
|
|
void print_commit_summary(const char *prefix, const struct object_id *oid,
|
|
unsigned int flags);
|
|
#endif
|