From 26ae337be11e440420d8ec7ce415425daaabe573 Mon Sep 17 00:00:00 2001 From: Ramkumar Ramachandra Date: Thu, 4 Aug 2011 16:09:11 +0530 Subject: [PATCH] revert: Introduce --reset to remove sequencer state To explicitly remove the sequencer state for a fresh cherry-pick or revert invocation, introduce a new subcommand called "--reset" to remove the sequencer state. Take the opportunity to publicly expose the sequencer paths, and a generic function called "remove_sequencer_state" that various git programs can use to remove the sequencer state in a uniform manner; "git reset" uses it later in this series. Introducing this public API is also in line with our long-term goal of eventually factoring out functions from revert.c into a generic commit sequencer. Signed-off-by: Ramkumar Ramachandra Signed-off-by: Jonathan Nieder Signed-off-by: Junio C Hamano --- Documentation/git-cherry-pick.txt | 5 +++ Documentation/git-revert.txt | 5 +++ Documentation/sequencer.txt | 4 ++ Makefile | 2 + builtin/revert.c | 62 +++++++++++++++++++++---------- sequencer.c | 19 ++++++++++ sequencer.h | 20 ++++++++++ t/t3510-cherry-pick-sequence.sh | 14 ++++++- 8 files changed, 111 insertions(+), 20 deletions(-) create mode 100644 Documentation/sequencer.txt create mode 100644 sequencer.c create mode 100644 sequencer.h diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt index 9d8fe0d26..138a29284 100644 --- a/Documentation/git-cherry-pick.txt +++ b/Documentation/git-cherry-pick.txt @@ -8,6 +8,7 @@ git-cherry-pick - Apply the changes introduced by some existing commits SYNOPSIS -------- 'git cherry-pick' [--edit] [-n] [-m parent-number] [-s] [-x] [--ff] ... +'git cherry-pick' --reset DESCRIPTION ----------- @@ -109,6 +110,10 @@ effect to your index in a row. Pass the merge strategy-specific option through to the merge strategy. See linkgit:git-merge[1] for details. +SEQUENCER SUBCOMMANDS +--------------------- +include::sequencer.txt[] + EXAMPLES -------- git cherry-pick master:: diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt index ac10cfbb1..783ffb4a6 100644 --- a/Documentation/git-revert.txt +++ b/Documentation/git-revert.txt @@ -8,6 +8,7 @@ git-revert - Revert some existing commits SYNOPSIS -------- 'git revert' [--edit | --no-edit] [-n] [-m parent-number] [-s] ... +'git revert' --reset DESCRIPTION ----------- @@ -90,6 +91,10 @@ effect to your index in a row. Pass the merge strategy-specific option through to the merge strategy. See linkgit:git-merge[1] for details. +SEQUENCER SUBCOMMANDS +--------------------- +include::sequencer.txt[] + EXAMPLES -------- git revert HEAD~3:: diff --git a/Documentation/sequencer.txt b/Documentation/sequencer.txt new file mode 100644 index 000000000..16ce88ce6 --- /dev/null +++ b/Documentation/sequencer.txt @@ -0,0 +1,4 @@ +--reset:: + Forget about the current operation in progress. Can be used + to clear the sequencer state after a failed cherry-pick or + revert. diff --git a/Makefile b/Makefile index e40ac0c7f..f69eef254 100644 --- a/Makefile +++ b/Makefile @@ -551,6 +551,7 @@ LIB_H += rerere.h LIB_H += resolve-undo.h LIB_H += revision.h LIB_H += run-command.h +LIB_H += sequencer.h LIB_H += sha1-array.h LIB_H += sha1-lookup.h LIB_H += sideband.h @@ -654,6 +655,7 @@ LIB_OBJS += revision.o LIB_OBJS += run-command.o LIB_OBJS += server-info.o LIB_OBJS += setup.o +LIB_OBJS += sequencer.o LIB_OBJS += sha1-array.o LIB_OBJS += sha1-lookup.o LIB_OBJS += sha1_file.o diff --git a/builtin/revert.c b/builtin/revert.c index f088e1cc7..a8accd6c7 100644 --- a/builtin/revert.c +++ b/builtin/revert.c @@ -14,6 +14,7 @@ #include "merge-recursive.h" #include "refs.h" #include "dir.h" +#include "sequencer.h" /* * This implements the builtins revert and cherry-pick. @@ -28,18 +29,22 @@ static const char * const revert_usage[] = { "git revert [options] ", + "git revert ", NULL }; static const char * const cherry_pick_usage[] = { "git cherry-pick [options] ", + "git cherry-pick ", NULL }; enum replay_action { REVERT, CHERRY_PICK }; +enum replay_subcommand { REPLAY_NONE, REPLAY_RESET }; struct replay_opts { enum replay_action action; + enum replay_subcommand subcommand; /* Boolean options */ int edit; @@ -61,11 +66,6 @@ struct replay_opts { #define GIT_REFLOG_ACTION "GIT_REFLOG_ACTION" -#define SEQ_DIR "sequencer" -#define SEQ_HEAD_FILE "sequencer/head" -#define SEQ_TODO_FILE "sequencer/todo" -#define SEQ_OPTS_FILE "sequencer/opts" - static const char *action_name(const struct replay_opts *opts) { return opts->action == REVERT ? "revert" : "cherry-pick"; @@ -113,7 +113,9 @@ static void parse_args(int argc, const char **argv, struct replay_opts *opts) const char * const * usage_str = revert_or_cherry_pick_usage(opts); const char *me = action_name(opts); int noop; + int reset = 0; struct option options[] = { + OPT_BOOLEAN(0, "reset", &reset, "forget the current operation"), OPT_BOOLEAN('n', "no-commit", &opts->no_commit, "don't automatically commit"), OPT_BOOLEAN('e', "edit", &opts->edit, "edit the commit message"), { OPTION_BOOLEAN, 'r', NULL, &noop, NULL, "no-op (backward compatibility)", @@ -142,7 +144,27 @@ static void parse_args(int argc, const char **argv, struct replay_opts *opts) opts->commit_argc = parse_options(argc, argv, NULL, options, usage_str, PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN); - if (opts->commit_argc < 2) + + /* Set the subcommand */ + if (reset) + opts->subcommand = REPLAY_RESET; + else + opts->subcommand = REPLAY_NONE; + + /* Check for incompatible command line arguments */ + if (opts->subcommand == REPLAY_RESET) { + verify_opt_compatible(me, "--reset", + "--no-commit", opts->no_commit, + "--signoff", opts->signoff, + "--mainline", opts->mainline, + "--strategy", opts->strategy ? 1 : 0, + "--strategy-option", opts->xopts ? 1 : 0, + "-x", opts->record_origin, + "--ff", opts->allow_ff, + NULL); + } + + else if (opts->commit_argc < 2) usage_with_options(usage_str, options); if (opts->allow_ff) @@ -729,7 +751,6 @@ static void save_opts(struct replay_opts *opts) static int pick_commits(struct commit_list *todo_list, struct replay_opts *opts) { - struct strbuf buf = STRBUF_INIT; struct commit_list *cur; int res; @@ -750,9 +771,7 @@ static int pick_commits(struct commit_list *todo_list, struct replay_opts *opts) * Sequence of picks finished successfully; cleanup by * removing the .git/sequencer directory */ - strbuf_addf(&buf, "%s", git_path(SEQ_DIR)); - remove_dir_recursively(&buf, 0); - strbuf_release(&buf); + remove_sequencer_state(1); return 0; } @@ -768,16 +787,21 @@ static int pick_revisions(struct replay_opts *opts) * cherry-pick should be handled differently from an existing * one that is being continued */ - walk_revs_populate_todo(&todo_list, opts); - create_seq_dir(); - if (get_sha1("HEAD", sha1)) { - if (opts->action == REVERT) - die(_("Can't revert as initial commit")); - die(_("Can't cherry-pick into empty head")); + if (opts->subcommand == REPLAY_RESET) { + remove_sequencer_state(1); + return 0; + } else { + /* Start a new cherry-pick/ revert sequence */ + walk_revs_populate_todo(&todo_list, opts); + create_seq_dir(); + if (get_sha1("HEAD", sha1)) { + if (opts->action == REVERT) + die(_("Can't revert as initial commit")); + die(_("Can't cherry-pick into empty head")); + } + save_head(sha1_to_hex(sha1)); + save_opts(opts); } - save_head(sha1_to_hex(sha1)); - save_opts(opts); - return pick_commits(todo_list, opts); } diff --git a/sequencer.c b/sequencer.c new file mode 100644 index 000000000..bc2c046aa --- /dev/null +++ b/sequencer.c @@ -0,0 +1,19 @@ +#include "cache.h" +#include "sequencer.h" +#include "strbuf.h" +#include "dir.h" + +void remove_sequencer_state(int aggressive) +{ + struct strbuf seq_dir = STRBUF_INIT; + struct strbuf seq_old_dir = STRBUF_INIT; + + strbuf_addf(&seq_dir, "%s", git_path(SEQ_DIR)); + strbuf_addf(&seq_old_dir, "%s", git_path(SEQ_OLD_DIR)); + remove_dir_recursively(&seq_old_dir, 0); + rename(git_path(SEQ_DIR), git_path(SEQ_OLD_DIR)); + if (aggressive) + remove_dir_recursively(&seq_old_dir, 0); + strbuf_release(&seq_dir); + strbuf_release(&seq_old_dir); +} diff --git a/sequencer.h b/sequencer.h new file mode 100644 index 000000000..905d29501 --- /dev/null +++ b/sequencer.h @@ -0,0 +1,20 @@ +#ifndef SEQUENCER_H +#define SEQUENCER_H + +#define SEQ_DIR "sequencer" +#define SEQ_OLD_DIR "sequencer-old" +#define SEQ_HEAD_FILE "sequencer/head" +#define SEQ_TODO_FILE "sequencer/todo" +#define SEQ_OPTS_FILE "sequencer/opts" + +/* + * Removes SEQ_OLD_DIR and renames SEQ_DIR to SEQ_OLD_DIR, ignoring + * any errors. Intended to be used by 'git reset'. + * + * With the aggressive flag, it additionally removes SEQ_OLD_DIR, + * ignoring any errors. Inteded to be used by the sequencer's + * '--reset' subcommand. + */ +void remove_sequencer_state(int aggressive); + +#endif diff --git a/t/t3510-cherry-pick-sequence.sh b/t/t3510-cherry-pick-sequence.sh index 8ee000180..fd6986541 100755 --- a/t/t3510-cherry-pick-sequence.sh +++ b/t/t3510-cherry-pick-sequence.sh @@ -13,7 +13,7 @@ test_description='Test cherry-pick continuation features . ./test-lib.sh pristine_detach () { - rm -rf .git/sequencer && + git cherry-pick --reset && git checkout -f "$1^0" && git read-tree -u --reset HEAD && git clean -d -f -f -q -x @@ -70,4 +70,16 @@ test_expect_success 'cherry-pick cleans up sequencer state upon success' ' test_path_is_missing .git/sequencer ' +test_expect_success '--reset does not complain when no cherry-pick is in progress' ' + pristine_detach initial && + git cherry-pick --reset +' + +test_expect_success '--reset cleans up sequencer state' ' + pristine_detach initial && + test_must_fail git cherry-pick base..picked && + git cherry-pick --reset && + test_path_is_missing .git/sequencer +' + test_done -- 2.26.2