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

[PATCH v7 17/45] builtin-am: exit with user friendly message on failure

From
Paul Tan <pyokagan@gmail.com>
Date
Aug 4, 2015, 13:51 UTC
Message-ID
<1438696326-19590-18-git-send-email-pyokagan@gmail.com>
In-Reply-To
<1438696326-19590-1-git-send-email-pyokagan@gmail.com>

Since ced9456 (Give the user a hint for how to continue in the case that git-am fails because it requires user intervention, 2006-05-02), git-am prints additional information on how the user can re-invoke git-am to resume patch application after resolving the failure. Re-implement this through the die_user_resolve() function.

Since cc12005 (Make git rebase interactive help match documentation., 2006-05-13), git-am supports the --resolvemsg option which is used by git-rebase to override the message printed out when git-am fails. Re-implement this option.

Signed-off-by: Paul Tan <pyokagan@gmail.com>
---
 builtin/am.c | 30 ++++++++++++++++++++++++++----
 1 file changed, 26 insertions(+), 4 deletions(-)
diff --git a/builtin/am.c b/builtin/am.c
index 0875e69..8b8f2da 100644
--- a/builtin/am.c
+++ b/builtin/am.c
@@ -83,6 +83,7 @@ struct am_state {
 
 	/* various operating modes and command line options */
 	int quiet;
+	const char *resolvemsg;
 };
 
 /**
@@ -647,6 +648,25 @@ static int index_has_changes(struct strbuf *sb)
 }
 
 /**
+ * Dies with a user-friendly message on how to proceed after resolving the
+ * problem. This message can be overridden with state->resolvemsg.
+ */
+static void NORETURN die_user_resolve(const struct am_state *state)
+{
+	if (state->resolvemsg) {
+		printf_ln("%s", state->resolvemsg);
+	} else {
+		const char *cmdline = "git am";
+
+		printf_ln(_("When you have resolved this problem, run \"%s --continue\"."), cmdline);
+		printf_ln(_("If you prefer to skip this patch, run \"%s --skip\" instead."), cmdline);
+		printf_ln(_("To restore the original branch and stop patching, run \"%s --abort\"."), cmdline);
+	}
+
+	exit(128);
+}
+
+/**
  * Parses `mail` using git-mailinfo, extracting its patch and authorship info.
  * state->msg will be set to the patch message. state->author_name,
  * state->author_email and state->author_date will be set to the patch author's
@@ -706,7 +726,7 @@ static int parse_mail(struct am_state *state, const char *mail)
 
 	if (is_empty_file(am_path(state, "patch"))) {
 		printf_ln(_("Patch is empty. Was it split wrong?"));
-		exit(128);
+		die_user_resolve(state);
 	}
 
 	strbuf_addstr(&msg, "\n\n");
@@ -871,7 +891,7 @@ static void am_run(struct am_state *state, int resume)
 				printf_ln(_("The copy of the patch that failed is found in: %s"),
 						am_path(state, "patch"));
 
-			exit(128);
+			die_user_resolve(state);
 		}
 
 		do_commit(state);
@@ -899,13 +919,13 @@ static void am_resolve(struct am_state *state)
 		printf_ln(_("No changes - did you forget to use 'git add'?\n"
 			"If there is nothing left to stage, chances are that something else\n"
 			"already introduced the same changes; you might want to skip this patch."));
-		exit(128);
+		die_user_resolve(state);
 	}
 
 	if (unmerged_cache()) {
 		printf_ln(_("You still have unmerged paths in your index.\n"
 			"Did you forget to use 'git add'?"));
-		exit(128);
+		die_user_resolve(state);
 	}
 
 	do_commit(state);
@@ -1133,6 +1153,8 @@ int cmd_am(int argc, const char **argv, const char *prefix)
 		OPT_CALLBACK(0, "patch-format", &patch_format, N_("format"),
 			N_("format the patch(es) are in"),
 			parse_opt_patchformat),
+		OPT_STRING(0, "resolvemsg", &state.resolvemsg, NULL,
+			N_("override error message when patch failure occurs")),
 		OPT_CMDMODE(0, "continue", &resume,
 			N_("continue applying patches after resolving a conflict"),
 			RESUME_RESOLVED),

-- 
2.5.0.280.gd88bd6e
Previous: Paul TanNext: Paul Tan
Message 18 of 46 in “Make git-am a builtin”
  1. 00/45 Make git-am a builtinPaul Tan, Aug 4, 2015
  2. 01/45 wrapper: implement xopen()Paul Tan, Aug 4, 2015
  3. 02/45 wrapper: implement xfopen()Paul Tan, Aug 4, 2015
  4. 03/45 builtin-am: implement skeletal builtin amPaul Tan, Aug 4, 2015
  5. 04/45 builtin-am: implement patch queue mechanismPaul Tan, Aug 4, 2015
  6. 05/45 builtin-am: split out mbox/maildir patches with git-mailsplitPaul Tan, Aug 4, 2015
  7. 06/45 builtin-am: auto-detect mbox patchesPaul Tan, Aug 4, 2015
  8. 07/45 builtin-am: extract patch and commit info with git-mailinfoPaul Tan, Aug 4, 2015
  9. 08/45 builtin-am: apply patch with git-applyPaul Tan, Aug 4, 2015
  10. 09/45 builtin-am: implement committing applied patchPaul Tan, Aug 4, 2015
  11. 10/45 builtin-am: refuse to apply patches if index is dirtyPaul Tan, Aug 4, 2015
  12. 11/45 builtin-am: implement --resolved/--continuePaul Tan, Aug 4, 2015
  13. 12/45 builtin-am: don't parse mail when resumingPaul Tan, Aug 4, 2015
  14. 13/45 builtin-am: implement --skipPaul Tan, Aug 4, 2015
  15. 14/45 builtin-am: implement --abortPaul Tan, Aug 4, 2015
  16. 15/45 builtin-am: reject patches when there's a session in progressPaul Tan, Aug 4, 2015
  17. 16/45 builtin-am: implement -q/--quietPaul Tan, Aug 4, 2015
  18. 17/45 builtin-am: exit with user friendly message on failurePaul Tan, Aug 4, 2015
  19. 18/45 builtin-am: implement -s/--signoffPaul Tan, Aug 4, 2015
  20. 19/45 cache-tree: introduce write_index_as_tree()Paul Tan, Aug 4, 2015
  21. 20/45 builtin-am: implement --3wayPaul Tan, Aug 4, 2015
  22. 21/45 builtin-am: implement --rebasing modePaul Tan, Aug 4, 2015
  23. 22/45 builtin-am: bypass git-mailinfo when --rebasingPaul Tan, Aug 4, 2015
  24. 23/45 builtin-am: handle stray state directoryPaul Tan, Aug 4, 2015
  25. 24/45 builtin-am: implement -u/--utf8Paul Tan, Aug 4, 2015
  26. 25/45 builtin-am: implement -k/--keep, --keep-non-patchPaul Tan, Aug 4, 2015
  27. 26/45 builtin-am: implement --[no-]message-id, am.messageidPaul Tan, Aug 4, 2015
  28. 27/45 builtin-am: support --keep-cr, am.keepcrPaul Tan, Aug 4, 2015
  29. 28/45 builtin-am: implement --[no-]scissorsPaul Tan, Aug 4, 2015
  30. 29/45 builtin-am: pass git-apply's options to git-applyPaul Tan, Aug 4, 2015
  31. 30/45 builtin-am: implement --ignore-datePaul Tan, Aug 4, 2015
  32. 31/45 builtin-am: implement --committer-date-is-author-datePaul Tan, Aug 4, 2015
  33. 32/45 builtin-am: implement -S/--gpg-sign, commit.gpgsignPaul Tan, Aug 4, 2015
  34. 33/45 builtin-am: invoke post-rewrite hookPaul Tan, Aug 4, 2015
  35. 34/45 builtin-am: support automatic notes copyingPaul Tan, Aug 4, 2015
  36. 35/45 builtin-am: invoke applypatch-msg hookPaul Tan, Aug 4, 2015
  37. 36/45 builtin-am: invoke pre-applypatch hookPaul Tan, Aug 4, 2015
  38. 37/45 builtin-am: invoke post-applypatch hookPaul Tan, Aug 4, 2015
  39. 38/45 builtin-am: rerere supportPaul Tan, Aug 4, 2015
  40. 39/45 builtin-am: support and auto-detect StGit patchesPaul Tan, Aug 4, 2015
  41. 40/45 builtin-am: support and auto-detect StGit series filesPaul Tan, Aug 4, 2015
  42. 41/45 builtin-am: support and auto-detect mercurial patchesPaul Tan, Aug 4, 2015
  43. 42/45 builtin-am: implement -i/--interactivePaul Tan, Aug 4, 2015
  44. 43/45 builtin-am: implement legacy -b/--binary optionPaul Tan, Aug 4, 2015
  45. 44/45 builtin-am: check for valid committer identPaul Tan, Aug 4, 2015
  46. 45/45 builtin-am: remove redirection to git-am.shPaul Tan, Aug 4, 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.