git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v4 13/44] builtin-am: implement --abort

From
Paul Tan <pyokagan@gmail.com>
Date
Jun 28, 2015, 14:05 UTC
Message-ID
<1435500366-31700-14-git-send-email-pyokagan@gmail.com>
In-Reply-To
<1435500366-31700-1-git-send-email-pyokagan@gmail.com>

Since 3e5057a (git am --abort, 2008-07-16), git-am supported the --abort option that will rewind HEAD back to the original commit. Re-implement this through am_abort().

Since 7b3b7e3 (am --abort: keep unrelated commits since the last failure and warn, 2010-12-21), to prevent commits made since the last failure from being lost, git-am will not rewind HEAD back to the original commit if HEAD moved since the last failure. Re-implement this through safe_to_abort().

Signed-off-by: Paul Tan <pyokagan@gmail.com>
---
 builtin/am.c | 102 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 99 insertions(+), 3 deletions(-)
diff --git a/builtin/am.c b/builtin/am.c
index 5087094..1db95f2 100644
--- a/builtin/am.c
+++ b/builtin/am.c
@@ -507,6 +507,8 @@ static int split_mail(struct am_state *state, enum patch_format patch_format,
 static void am_setup(struct am_state *state, enum patch_format patch_format,
 			const char **paths)
 {
+	unsigned char curr_head[GIT_SHA1_RAWSZ];
+
 	if (!patch_format)
 		patch_format = detect_patch_format(paths);
 
@@ -523,6 +525,14 @@ static void am_setup(struct am_state *state, enum patch_format patch_format,
 		die(_("Failed to split patches."));
 	}
 
+	if (!get_sha1("HEAD", curr_head)) {
+		write_file(am_path(state, "abort-safety"), 1, "%s", sha1_to_hex(curr_head));
+		update_ref("am", "ORIG_HEAD", curr_head, NULL, 0, UPDATE_REFS_DIE_ON_ERR);
+	} else {
+		write_file(am_path(state, "abort-safety"), 1, "%s", "");
+		delete_ref("ORIG_HEAD", NULL, 0);
+	}
+
 	/*
 	 * NOTE: Since the "next" and "last" files determine if an am_state
 	 * session is in progress, they should be written last.
@@ -539,6 +549,8 @@ static void am_setup(struct am_state *state, enum patch_format patch_format,
  */
 static void am_next(struct am_state *state)
 {
+	unsigned char head[GIT_SHA1_RAWSZ];
+
 	if (state->author_name)
 		free(state->author_name);
 	state->author_name = NULL;
@@ -559,6 +571,11 @@ static void am_next(struct am_state *state)
 	unlink(am_path(state, "author-script"));
 	unlink(am_path(state, "final-commit"));
 
+	if (!get_sha1("HEAD", head))
+		write_file(am_path(state, "abort-safety"), 1, "%s", sha1_to_hex(head));
+	else
+		write_file(am_path(state, "abort-safety"), 1, "%s", "");
+
 	state->cur++;
 	write_file(am_path(state, "next"), 1, "%d", state->cur);
 }
@@ -791,10 +808,14 @@ static void am_run(struct am_state *state)
 	const char *argv_gc_auto[] = {"gc", "--auto", NULL};
 	struct strbuf sb = STRBUF_INIT;
 
+	unlink(am_path(state, "dirtyindex"));
+
 	refresh_and_write_cache();
 
-	if (index_has_changes(&sb))
+	if (index_has_changes(&sb)) {
+		write_file(am_path(state, "dirtyindex"), 1, "t");
 		die(_("Dirty index: cannot apply patches (dirty: %s)"), sb.buf);
+	}
 
 	strbuf_release(&sb);
 
@@ -982,6 +1003,74 @@ static void am_skip(struct am_state *state)
 }
 
 /**
+ * Returns true if it is safe to reset HEAD to the ORIG_HEAD, false otherwise.
+ *
+ * It is not safe to reset HEAD when:
+ * 1. git-am previously failed because the index was dirty.
+ * 2. HEAD has moved since git-am previously failed.
+ */
+static int safe_to_abort(const struct am_state *state)
+{
+	struct strbuf sb = STRBUF_INIT;
+	unsigned char abort_safety[GIT_SHA1_RAWSZ], head[GIT_SHA1_RAWSZ];
+
+	if (file_exists(am_path(state, "dirtyindex")))
+		return 0;
+
+	if (read_state_file(&sb, state, "abort-safety", 1) > 0) {
+		if (get_sha1_hex(sb.buf, abort_safety))
+			die(_("could not parse %s"), am_path(state, "abort_safety"));
+	} else
+		hashclr(abort_safety);
+
+	if (get_sha1("HEAD", head))
+		hashclr(head);
+
+	if (!hashcmp(head, abort_safety))
+		return 1;
+
+	error(_("You seem to have moved HEAD since the last 'am' failure.\n"
+		"Not rewinding to ORIG_HEAD"));
+
+	return 0;
+}
+
+/**
+ * Aborts the current am session if it is safe to do so.
+ */
+static void am_abort(struct am_state *state)
+{
+	unsigned char curr_head[GIT_SHA1_RAWSZ], orig_head[GIT_SHA1_RAWSZ];
+	int has_curr_head, has_orig_head;
+	const char *curr_branch;
+
+	if (!safe_to_abort(state)) {
+		am_destroy(state);
+		return;
+	}
+
+	curr_branch = resolve_refdup("HEAD", 0, curr_head, NULL);
+	has_curr_head = !is_null_sha1(curr_head);
+	if (!has_curr_head)
+		hashcpy(curr_head, EMPTY_TREE_SHA1_BIN);
+
+	has_orig_head = !get_sha1("ORIG_HEAD", orig_head);
+	if (!has_orig_head)
+		hashcpy(orig_head, EMPTY_TREE_SHA1_BIN);
+
+	clean_index(curr_head, orig_head);
+
+	if (has_orig_head)
+		update_ref("am --abort", "HEAD", orig_head,
+				has_curr_head ? curr_head : NULL, 0,
+				UPDATE_REFS_DIE_ON_ERR);
+	else if (curr_branch)
+		delete_ref(curr_branch, NULL, REF_NODEREF);
+
+	am_destroy(state);
+}
+
+/**
  * parse_options() callback that validates and sets opt->value to the
  * PATCH_FORMAT_* enum value corresponding to `arg`.
  */
@@ -999,7 +1088,8 @@ static int parse_opt_patchformat(const struct option *opt, const char *arg, int
 enum resume_mode {
 	RESUME_FALSE = 0,
 	RESUME_RESOLVED,
-	RESUME_SKIP
+	RESUME_SKIP,
+	RESUME_ABORT
 };
 
 int cmd_am(int argc, const char **argv, const char *prefix)
@@ -1010,7 +1100,7 @@ int cmd_am(int argc, const char **argv, const char *prefix)
 
 	const char * const usage[] = {
 		N_("git am [options] [(<mbox>|<Maildir>)...]"),
-		N_("git am [options] (--continue | --skip)"),
+		N_("git am [options] (--continue | --skip | --abort)"),
 		NULL
 	};
 
@@ -1027,6 +1117,9 @@ int cmd_am(int argc, const char **argv, const char *prefix)
 		OPT_CMDMODE(0, "skip", &resume,
 			N_("skip the current patch"),
 			RESUME_SKIP),
+		OPT_CMDMODE(0, "abort", &resume,
+			N_("restore the original branch and abort the patching operation."),
+			RESUME_ABORT),
 		OPT_END()
 	};
 
@@ -1085,6 +1178,9 @@ int cmd_am(int argc, const char **argv, const char *prefix)
 	case RESUME_SKIP:
 		am_skip(&state);
 		break;
+	case RESUME_ABORT:
+		am_abort(&state);
+		break;
 	default:
 		die("BUG: invalid resume value");
 	}
-- 
2.5.0.rc0.76.gb2c6e93
Previous: Paul TanNext: Paul Tan
Message 21 of 74 in “Make git-am a builtin”
  1. 00/44 Make git-am a builtinPaul Tan, Jun 28, 2015
  2. 01/44 wrapper: implement xopen()Paul Tan, Jun 28, 2015
  3. Torsten BögershausenJun 29, 2015
  4. Stefan BellerJun 29, 2015
  5. Junio C HamanoJun 29, 2015
  6. Paul TanJul 1, 2015
  7. Paul TanJul 1, 2015
  8. 02/44 wrapper: implement xfopen()Paul Tan, Jun 28, 2015
  9. 03/44 builtin-am: implement skeletal builtin amPaul Tan, Jun 28, 2015
  10. 04/44 builtin-am: implement patch queue mechanismPaul Tan, Jun 28, 2015
  11. Stefan BellerJun 29, 2015
  12. Paul TanJul 7, 2015
  13. 05/44 builtin-am: split out mbox/maildir patches with git-mailsplitPaul Tan, Jun 28, 2015
  14. 06/44 builtin-am: auto-detect mbox patchesPaul Tan, Jun 28, 2015
  15. 07/44 builtin-am: extract patch and commit info with git-mailinfoPaul Tan, Jun 28, 2015
  16. 08/44 builtin-am: apply patch with git-applyPaul Tan, Jun 28, 2015
  17. 09/44 builtin-am: implement committing applied patchPaul Tan, Jun 28, 2015
  18. 10/44 builtin-am: refuse to apply patches if index is dirtyPaul Tan, Jun 28, 2015
  19. 11/44 builtin-am: implement --resolved/--continuePaul Tan, Jun 28, 2015
  20. 12/44 builtin-am: implement --skipPaul Tan, Jun 28, 2015
  21. 13/44 builtin-am: implement --abortPaul Tan, Jun 28, 2015
  22. 14/44 builtin-am: reject patches when there's a session in progressPaul Tan, Jun 28, 2015
  23. 15/44 builtin-am: implement -q/--quiet, GIT_QUIETPaul Tan, Jun 28, 2015
  24. 16/44 builtin-am: exit with user friendly message on failurePaul Tan, Jun 28, 2015
  25. 17/44 builtin-am: implement -s/--signoffPaul Tan, Jun 28, 2015
  26. 18/44 cache-tree: introduce write_index_as_tree()Paul Tan, Jun 28, 2015
  27. 19/44 builtin-am: implement --3way, am.threewayPaul Tan, Jun 28, 2015
  28. Stefan BellerJun 30, 2015
  29. 20/44 builtin-am: implement --rebasing modePaul Tan, Jun 28, 2015
  30. 21/44 builtin-am: bypass git-mailinfo when --rebasingPaul Tan, Jun 28, 2015
  31. 22/44 builtin-am: handle stray state directoryPaul Tan, Jun 28, 2015
  32. 23/44 builtin-am: implement -u/--utf8Paul Tan, Jun 28, 2015
  33. 24/44 builtin-am: implement -k/--keep, --keep-non-patchPaul Tan, Jun 28, 2015
  34. 25/44 builtin-am: implement --[no-]message-id, am.messageidPaul Tan, Jun 28, 2015
  35. 26/44 builtin-am: support --keep-cr, am.keepcrPaul Tan, Jun 28, 2015
  36. 27/44 builtin-am: implement --[no-]scissorsPaul Tan, Jun 28, 2015
  37. Paul TanJul 7, 2015
  38. 28/44 builtin-am: pass git-apply's options to git-applyPaul Tan, Jun 28, 2015
  39. Stefan BellerJun 29, 2015
  40. Paul TanJul 1, 2015
  41. Stefan BellerJul 1, 2015
  42. 29/44 builtin-am: implement --ignore-datePaul Tan, Jun 28, 2015
  43. 30/44 builtin-am: implement --committer-date-is-author-datePaul Tan, Jun 28, 2015
  44. 31/44 builtin-am: implement -S/--gpg-sign, commit.gpgsignPaul Tan, Jun 28, 2015
  45. Stefan BellerJun 29, 2015
  46. Paul TanJul 1, 2015
  47. Stefan BellerJul 1, 2015
  48. 32/44 builtin-am: invoke post-rewrite hookPaul Tan, Jun 28, 2015
  49. 33/44 builtin-am: support automatic notes copyingPaul Tan, Jun 28, 2015
  50. 34/44 builtin-am: invoke applypatch-msg hookPaul Tan, Jun 28, 2015
  51. 35/44 builtin-am: invoke pre-applypatch hookPaul Tan, Jun 28, 2015
  52. 36/44 builtin-am: invoke post-applypatch hookPaul Tan, Jun 28, 2015
  53. 37/44 builtin-am: rerere supportPaul Tan, Jun 28, 2015
  54. 38/44 builtin-am: support and auto-detect StGit patchesPaul Tan, Jun 28, 2015
  55. Stefan BellerJun 29, 2015
  56. Eric SunshineJun 29, 2015
  57. Junio C HamanoJun 29, 2015
  58. Paul TanJul 1, 2015
  59. 39/44 builtin-am: support and auto-detect StGit series filesPaul Tan, Jun 28, 2015
  60. 40/44 builtin-am: support and auto-detect mercurial patchesPaul Tan, Jun 28, 2015
  61. Stefan BellerJun 29, 2015
  62. Stefan BellerJun 29, 2015
  63. Paul TanJul 1, 2015
  64. Paul TanJul 1, 2015
  65. 41/44 builtin-am: implement -i/--interactivePaul Tan, Jun 28, 2015
  66. 42/44 builtin-am: implement legacy -b/--binary optionPaul Tan, Jun 28, 2015
  67. Stefan BellerJun 29, 2015
  68. 43/44 builtin-am: check for valid committer identPaul Tan, Jun 28, 2015
  69. Stefan BellerJun 29, 2015
  70. Paul TanJul 1, 2015
  71. 44/44 builtin-am: remove redirection to git-am.shPaul Tan, Jun 28, 2015
  72. Stefan BellerJun 29, 2015
  73. Stefan BellerJun 30, 2015
  74. Paul TanJul 14, 2015

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.