From mboxrd@z Thu Jan 1 00:00:00 1970 From: Ramkumar Ramachandra Subject: [PATCH 14/18] revert: Introduce --reset to remove sequencer state Date: Wed, 27 Jul 2011 08:49:11 +0530 Message-ID: <1311736755-24205-15-git-send-email-artagnon@gmail.com> References: <1311736755-24205-1-git-send-email-artagnon@gmail.com> Cc: Jonathan Nieder , Junio C Hamano , Christian Couder , Daniel Barkalow , Jeff King To: Git List X-From: git-owner@vger.kernel.org Wed Jul 27 05:23:32 2011 Return-path: Envelope-to: gcvg-git-2@lo.gmane.org Received: from vger.kernel.org ([209.132.180.67]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1QluiZ-00068x-6f for gcvg-git-2@lo.gmane.org; Wed, 27 Jul 2011 05:23:31 +0200 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1754128Ab1G0DXZ (ORCPT ); Tue, 26 Jul 2011 23:23:25 -0400 Received: from mail-pz0-f42.google.com ([209.85.210.42]:35904 "EHLO mail-pz0-f42.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753524Ab1G0DXY (ORCPT ); Tue, 26 Jul 2011 23:23:24 -0400 Received: by mail-pz0-f42.google.com with SMTP id 37so1938359pzk.1 for ; Tue, 26 Jul 2011 20:23:23 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references; bh=w21CiuDJ1SU1Uv8XOZwUAgQa6cDsirRMIK8ZNvdCfxI=; b=Xamy9BxQy/2WXjPFylCQ50r6G2Hp8mtERI4ZjluDGleILaPXDCXLgYAoA9zrL2gUrD 2J27fgUNV6YecQdnQc9pz2zkXfFKzYZmR7737yn5Y3loL1Qc43vYRiWV8um1T//aXTdt 67xdA2eDXvMD6tTNBizq7zJiLNLswNoTakpW8= Received: by 10.68.39.167 with SMTP id q7mr2846645pbk.415.1311737003820; Tue, 26 Jul 2011 20:23:23 -0700 (PDT) Received: from localhost.localdomain ([203.110.240.41]) by mx.google.com with ESMTPS id p7sm1210706pbn.65.2011.07.26.20.23.20 (version=TLSv1/SSLv3 cipher=OTHER); Tue, 26 Jul 2011 20:23:22 -0700 (PDT) X-Mailer: git-send-email 1.7.4.rc1.7.g2cf08.dirty In-Reply-To: <1311736755-24205-1-git-send-email-artagnon@gmail.com> Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Archived-At: 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. Helped-by: Jonathan Nieder Signed-off-by: Ramkumar Ramachandra --- Documentation/git-cherry-pick.txt | 5 +++ Documentation/git-revert.txt | 5 +++ Documentation/sequencer.txt | 4 ++ Makefile | 2 + builtin/revert.c | 65 +++++++++++++++++++++++++----------- sequencer.c | 19 +++++++++++ sequencer.h | 20 +++++++++++ t/t3510-cherry-pick-sequence.sh | 16 ++++++++- 8 files changed, 114 insertions(+), 22 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 9d8fe0d..138a292 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 6a21b37..b6789be 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 0000000..16ce88c --- /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 4ed7996..afd7673 100644 --- a/Makefile +++ b/Makefile @@ -554,6 +554,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 @@ -658,6 +659,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 46b1371..3c792fa 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; @@ -62,11 +67,6 @@ struct replay_opts { #define GIT_REFLOG_ACTION "GIT_REFLOG_ACTION" #define MAYBE_UNUSED __attribute__((__unused__)) -#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"; @@ -114,7 +114,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)", @@ -143,7 +145,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) @@ -853,7 +875,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; @@ -874,8 +895,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); + remove_sequencer_state(1); return 0; } @@ -886,17 +906,22 @@ static int pick_revisions(struct replay_opts *opts) read_and_refresh_cache(opts); - walk_revs_populate_todo(&todo_list, opts); - create_seq_dir(); - if (get_sha1("HEAD", sha1)) { - if (opts->action == REVERT) - return error(_("Can't revert as initial commit")); - return error(_("Can't cherry-pick into empty head")); - } else - save_head(sha1_to_hex(sha1)); - save_opts(opts); - save_todo(todo_list, opts); - + 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) + return error(_("Can't revert as initial commit")); + return error(_("Can't cherry-pick into empty head")); + } else + save_head(sha1_to_hex(sha1)); + save_opts(opts); + save_todo(todo_list, opts); + } return pick_commits(todo_list, opts); } diff --git a/sequencer.c b/sequencer.c new file mode 100644 index 0000000..bc2c046 --- /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 0000000..905d295 --- /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 79d868f..aea4f6c 100755 --- a/t/t3510-cherry-pick-sequence.sh +++ b/t/t3510-cherry-pick-sequence.sh @@ -37,7 +37,7 @@ test_expect_success 'cherry-pick persists data on failure' ' test_path_is_file .git/sequencer/head && test_path_is_file .git/sequencer/todo && test_path_is_file .git/sequencer/opts && - rm -rf .git/sequencer + git cherry-pick --reset ' test_expect_success 'cherry-pick persists opts correctly' ' @@ -62,7 +62,7 @@ test_expect_success 'cherry-pick persists opts correctly' ' EOF git config --file=.git/sequencer/opts --get-all core.strategy-option >actual && test_cmp expect actual && - rm -rf .git/sequencer + git cherry-pick --reset ' test_expect_success 'cherry-pick cleans up sequencer state upon success' ' @@ -71,4 +71,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 -- 1.7.4.rc1.7.g2cf08.dirty