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

[PATCH v4 41/44] builtin-am: implement -i/--interactive

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

Since d1c5f2a (Add git-am, applymbox replacement., 2005-10-07), git-am.sh supported the --interactive mode. After parsing the patch mail and extracting the patch, commit message and authorship info, an interactive session will begin that allows the user to choose between:

* applying the patch
* applying the patch and all subsequent patches (by disabling
  interactive mode in subsequent patches)
* skipping the patch
* editing the commit message

Since f89ad67 (Add [v]iew patch in git-am interactive., 2005-10-25), git-am.sh --interactive also supported viewing the patch to be applied.

When --resolved-ing in --interactive mode, we need to take care to update the patch with the contents of the index, such that the correct patch will be displayed when the patch is viewed in interactive mode.

Re-implement the above in builtin/am.c
Signed-off-by: Paul Tan <pyokagan@gmail.com>
---
Notes:
    Can't be tested because even with test_terminal isatty(0) still returns
    false.
 builtin/am.c | 106 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 105 insertions(+), 1 deletion(-)
diff --git a/builtin/am.c b/builtin/am.c
index 5c86e6f..f148f05 100644
--- a/builtin/am.c
+++ b/builtin/am.c
@@ -25,6 +25,7 @@
 #include "log-tree.h"
 #include "notes-utils.h"
 #include "rerere.h"
+#include "prompt.h"
 
 /**
  * Returns 1 if the file is empty or does not exist, 0 otherwise.
@@ -118,6 +119,8 @@ struct am_state {
 	/* number of digits in patch filename */
 	int prec;
 
+	int interactive;
+
 	int threeway;
 
 	int quiet;
@@ -1216,7 +1219,7 @@ 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";
+		const char *cmdline = state->interactive ? "git am -i" : "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);
@@ -1449,6 +1452,36 @@ static void write_commit_patch(const struct am_state *state, struct commit *comm
 }
 
 /**
+ * Writes the diff of the index against HEAD as a patch to the state
+ * directory's "patch" file.
+ */
+static void write_index_patch(const struct am_state *state)
+{
+	struct tree *tree;
+	unsigned char head[GIT_SHA1_RAWSZ];
+	struct rev_info rev_info;
+	FILE *fp;
+
+	if (!get_sha1_tree("HEAD", head))
+		tree = lookup_tree(head);
+	else
+		tree = lookup_tree(EMPTY_TREE_SHA1_BIN);
+
+	fp = xfopen(am_path(state, "patch"), "w");
+	init_revisions(&rev_info, NULL);
+	rev_info.diff = 1;
+	rev_info.disable_stdin = 1;
+	rev_info.no_commit_id = 1;
+	rev_info.diffopt.output_format = DIFF_FORMAT_PATCH;
+	rev_info.diffopt.use_color = 0;
+	rev_info.diffopt.file = fp;
+	rev_info.diffopt.close_file = 1;
+	add_pending_object(&rev_info, &tree->object, "");
+	diff_setup_done(&rev_info.diffopt);
+	run_diff_index(&rev_info, 1);
+}
+
+/**
  * Like parse_mail(), but parses the mail by looking up its commit ID
  * directly. This is used in --rebasing mode to bypass git-mailinfo's munging
  * of patches.
@@ -1685,6 +1718,65 @@ static void do_commit(const struct am_state *state)
 }
 
 /**
+ * Interactively prompt the user on whether the current patch should be
+ * applied.
+ *
+ * Returns 0 if the user chooses to apply the patch, 1 if the user chooses to
+ * skip it.
+ */
+static int do_interactive(struct am_state *state)
+{
+	assert(state->msg);
+
+	if (!isatty(0))
+		die(_("cannot be interactive without stdin connected to a terminal."));
+
+	for (;;) {
+		const char *reply;
+
+		puts(_("Commit Body is:"));
+		puts("--------------------------");
+		printf("%s", state->msg);
+		puts("--------------------------");
+
+		/*
+		 * TRANSLATORS: Make sure to include [y], [n], [e], [v] and [a]
+		 * in your translation. The program will only accept English
+		 * input at this point.
+		 */
+		reply = git_prompt(_("Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all: "), PROMPT_ECHO);
+
+		if (!reply) {
+			continue;
+		} else if (*reply == 'y' || *reply == 'Y') {
+			return 0;
+		} else if (*reply == 'a' || *reply == 'A') {
+			state->interactive = 0;
+			return 0;
+		} else if (*reply == 'n' || *reply == 'N') {
+			return 1;
+		} else if (*reply == 'e' || *reply == 'E') {
+			struct strbuf msg = STRBUF_INIT;
+
+			if (!launch_editor(am_path(state, "final-commit"), &msg, NULL)) {
+				free(state->msg);
+				state->msg = strbuf_detach(&msg, &state->msg_len);
+			}
+			strbuf_release(&msg);
+		} else if (*reply == 'v' || *reply == 'V') {
+			const char *pager = git_pager(1);
+			struct child_process cp = CHILD_PROCESS_INIT;
+
+			if (!pager)
+				pager = "cat";
+			argv_array_push(&cp.args, pager);
+			argv_array_push(&cp.args, am_path(state, "patch"));
+			run_command(&cp);
+		}
+	}
+}
+
+/**
  * Applies all queued mail.
  */
 static void am_run(struct am_state *state)
@@ -1721,6 +1813,9 @@ static void am_run(struct am_state *state)
 		write_author_script(state);
 		write_commit_msg(state);
 
+		if (state->interactive && do_interactive(state))
+			goto next;
+
 		if (run_applypatch_msg_hook(state))
 			exit(1);
 
@@ -1812,10 +1907,17 @@ static void am_resolve(struct am_state *state)
 		die_user_resolve(state);
 	}
 
+	if (state->interactive) {
+		write_index_patch(state);
+		if (do_interactive(state))
+			goto next;
+	}
+
 	rerere(0);
 
 	do_commit(state);
 
+next:
 	am_next(state);
 	am_run(state);
 }
@@ -2057,6 +2159,8 @@ int cmd_am(int argc, const char **argv, const char *prefix)
 	};
 
 	struct option options[] = {
+		OPT_BOOL('i', "interactive", &state.interactive,
+			N_("run interactively")),
 		OPT_BOOL('3', "3way", &state.threeway,
 			N_("allow fall back on 3way merging if needed")),
 		OPT__QUIET(&state.quiet, N_("be quiet")),
-- 
2.5.0.rc0.76.gb2c6e93
Previous: Paul TanNext: Paul Tan
Message 65 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.