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

[PATCH/WIP v2 16/19] am: exit with user friendly message on patch failure

From
Paul Tan <pyokagan@gmail.com>
Date
Jun 11, 2015, 10:22 UTC
Message-ID
<1434018125-31804-17-git-send-email-pyokagan@gmail.com>
In-Reply-To
<1434018125-31804-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 | 26 +++++++++++++++++++++++---
 1 file changed, 23 insertions(+), 3 deletions(-)
diff --git a/builtin/am.c b/builtin/am.c
index 795b672..4cd21b8 100644
--- a/builtin/am.c
+++ b/builtin/am.c
@@ -70,6 +70,9 @@ struct am_state {
 	int prec;
 
 	int quiet;
+
+	/* override error message when patch failure occurs */
+	const char *resolvemsg;
 };
 
 /**
@@ -629,6 +632,21 @@ static int parse_patch(struct am_state *state, const char *patch)
 	return 0;
 }
 
+/**
+ * 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
+		printf_ln(_("When you have resolved this problem, run \"git am --continue\".\n"
+			"If you prefer to skip this patch, run \"git am --skip\" instead.\n"
+			"To restore the original branch and stop patching, run \"git am --abort\"."));
+	exit(128);
+}
+
 /*
  * Applies current patch with git-apply. Returns 0 on success, -1 otherwise.
  */
@@ -736,7 +754,7 @@ static void am_run(struct am_state *state)
 				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);
@@ -761,13 +779,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);
@@ -981,6 +999,8 @@ static struct option am_options[] = {
 	OPT__QUIET(&state.quiet, N_("be quiet")),
 	OPT_CALLBACK(0, "patch-format", &opt_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", &opt_resume,
 		N_("continue applying patches after resolving a conflict"),
 		RESUME_RESOLVED),
-- 
2.1.4
Previous: Paul TanNext: Paul Tan
Message 28 of 31 in “Make git-am a builtin”
  1. 00/19 Make git-am a builtinPaul Tan, Jun 11, 2015
  2. 01/19 wrapper: implement xopen()Paul Tan, Jun 11, 2015
  3. 02/19 wrapper: implement xfopen()Paul Tan, Jun 11, 2015
  4. 03/19 am: implement skeletal builtin amPaul Tan, Jun 11, 2015
  5. Junio C HamanoJun 14, 2015
  6. Paul TanJun 15, 2015
  7. Junio C HamanoJun 15, 2015
  8. Paul TanJun 15, 2015
  9. Junio C HamanoJun 15, 2015
  10. Paul TanJun 18, 2015
  11. 04/19 am: implement patch queue mechanismPaul Tan, Jun 11, 2015
  12. Stefan BellerJun 11, 2015
  13. Paul TanJun 15, 2015
  14. 05/19 am: split out mbox/maildir patches with git-mailsplitPaul Tan, Jun 11, 2015
  15. Stefan BellerJun 11, 2015
  16. Paul TanJun 15, 2015
  17. 06/19 am: detect mbox patchesPaul Tan, Jun 11, 2015
  18. 07/19 am: extract patch, message and authorship with git-mailinfoPaul Tan, Jun 11, 2015
  19. Junio C HamanoJun 14, 2015
  20. 08/19 am: apply patch with git-applyPaul Tan, Jun 11, 2015
  21. 09/19 am: commit applied patchPaul Tan, Jun 11, 2015
  22. 10/19 am: refresh the index at startPaul Tan, Jun 11, 2015
  23. 11/19 am: refuse to apply patches if index is dirtyPaul Tan, Jun 11, 2015
  24. 12/19 am: implement --resolved/--continuePaul Tan, Jun 11, 2015
  25. 13/19 am: implement --skipPaul Tan, Jun 11, 2015
  26. 14/19 am: implement --abortPaul Tan, Jun 11, 2015
  27. 15/19 am: implement quiet optionPaul Tan, Jun 11, 2015
  28. 16/19 am: exit with user friendly message on patch failurePaul Tan, Jun 11, 2015
  29. 17/19 am: implement am --signoffPaul Tan, Jun 11, 2015
  30. 18/19 cache-tree: introduce write_index_as_tree()Paul Tan, Jun 11, 2015
  31. 19/19 am: implement 3-way mergePaul Tan, Jun 11, 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.