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

[PATCH v7 05/45] builtin-am: split out mbox/maildir patches with git-mailsplit

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

git-am.sh supports mbox, stgit and mercurial patches. Re-implement support for splitting out mbox/maildirs using git-mailsplit, while also implementing the framework required to support other patch formats in the future.

Re-implement support for the --patch-format option (since a5a6755 (git-am foreign patch support: introduce patch_format, 2009-05-27)) to allow the user to choose between the different patch formats.

Helped-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Paul Tan <pyokagan@gmail.com>
---
 builtin/am.c | 107 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 104 insertions(+), 3 deletions(-)
diff --git a/builtin/am.c b/builtin/am.c
index ac172c4..5f3c131 100644
--- a/builtin/am.c
+++ b/builtin/am.c
@@ -8,6 +8,12 @@
 #include "exec_cmd.h"
 #include "parse-options.h"
 #include "dir.h"
+#include "run-command.h"
+
+enum patch_format {
+	PATCH_FORMAT_UNKNOWN = 0,
+	PATCH_FORMAT_MBOX
+};
 
 struct am_state {
 	/* state directory path */
@@ -16,6 +22,9 @@ struct am_state {
 	/* current and last patch numbers, 1-indexed */
 	int cur;
 	int last;
+
+	/* number of digits in patch filename */
+	int prec;
 };
 
 /**
@@ -28,6 +37,8 @@ static void am_state_init(struct am_state *state, const char *dir)
 
 	assert(dir);
 	state->dir = xstrdup(dir);
+
+	state->prec = 4;
 }
 
 /**
@@ -117,13 +128,71 @@ static void am_destroy(const struct am_state *state)
 }
 
 /**
+ * Splits out individual email patches from `paths`, where each path is either
+ * a mbox file or a Maildir. Returns 0 on success, -1 on failure.
+ */
+static int split_mail_mbox(struct am_state *state, const char **paths)
+{
+	struct child_process cp = CHILD_PROCESS_INIT;
+	struct strbuf last = STRBUF_INIT;
+
+	cp.git_cmd = 1;
+	argv_array_push(&cp.args, "mailsplit");
+	argv_array_pushf(&cp.args, "-d%d", state->prec);
+	argv_array_pushf(&cp.args, "-o%s", state->dir);
+	argv_array_push(&cp.args, "-b");
+	argv_array_push(&cp.args, "--");
+	argv_array_pushv(&cp.args, paths);
+
+	if (capture_command(&cp, &last, 8))
+		return -1;
+
+	state->cur = 1;
+	state->last = strtol(last.buf, NULL, 10);
+
+	return 0;
+}
+
+/**
+ * Splits a list of files/directories into individual email patches. Each path
+ * in `paths` must be a file/directory that is formatted according to
+ * `patch_format`.
+ *
+ * Once split out, the individual email patches will be stored in the state
+ * directory, with each patch's filename being its index, padded to state->prec
+ * digits.
+ *
+ * state->cur will be set to the index of the first mail, and state->last will
+ * be set to the index of the last mail.
+ *
+ * Returns 0 on success, -1 on failure.
+ */
+static int split_mail(struct am_state *state, enum patch_format patch_format,
+			const char **paths)
+{
+	switch (patch_format) {
+	case PATCH_FORMAT_MBOX:
+		return split_mail_mbox(state, paths);
+	default:
+		die("BUG: invalid patch_format");
+	}
+	return -1;
+}
+
+/**
  * Setup a new am session for applying patches
  */
-static void am_setup(struct am_state *state)
+static void am_setup(struct am_state *state, enum patch_format patch_format,
+			const char **paths)
 {
 	if (mkdir(state->dir, 0777) < 0 && errno != EEXIST)
 		die_errno(_("failed to create directory '%s'"), state->dir);
 
+	if (split_mail(state, patch_format, paths) < 0) {
+		am_destroy(state);
+		die(_("Failed to split patches."));
+	}
+
 	/*
 	 * NOTE: Since the "next" and "last" files determine if an am_state
 	 * session is in progress, they should be written last.
@@ -159,9 +228,25 @@ static void am_run(struct am_state *state)
 	am_destroy(state);
 }
 
+/**
+ * parse_options() callback that validates and sets opt->value to the
+ * PATCH_FORMAT_* enum value corresponding to `arg`.
+ */
+static int parse_opt_patchformat(const struct option *opt, const char *arg, int unset)
+{
+	int *opt_value = opt->value;
+
+	if (!strcmp(arg, "mbox"))
+		*opt_value = PATCH_FORMAT_MBOX;
+	else
+		return error(_("Invalid value for --patch-format: %s"), arg);
+	return 0;
+}
+
 int cmd_am(int argc, const char **argv, const char *prefix)
 {
 	struct am_state state;
+	int patch_format = PATCH_FORMAT_UNKNOWN;
 
 	const char * const usage[] = {
 		N_("git am [options] [(<mbox>|<Maildir>)...]"),
@@ -169,6 +254,9 @@ int cmd_am(int argc, const char **argv, const char *prefix)
 	};
 
 	struct option options[] = {
+		OPT_CALLBACK(0, "patch-format", &patch_format, N_("format"),
+			N_("format the patch(es) are in"),
+			parse_opt_patchformat),
 		OPT_END()
 	};
 
@@ -195,8 +283,21 @@ int cmd_am(int argc, const char **argv, const char *prefix)
 
 	if (am_in_progress(&state))
 		am_load(&state);
-	else
-		am_setup(&state);
+	else {
+		struct argv_array paths = ARGV_ARRAY_INIT;
+		int i;
+
+		for (i = 0; i < argc; i++) {
+			if (is_absolute_path(argv[i]) || !prefix)
+				argv_array_push(&paths, argv[i]);
+			else
+				argv_array_push(&paths, mkpath("%s/%s", prefix, argv[i]));
+		}
+
+		am_setup(&state, patch_format, paths.argv);
+
+		argv_array_clear(&paths);
+	}
 
 	am_run(&state);
 
-- 
2.5.0.280.gd88bd6e
Previous: Paul TanNext: Paul Tan
Message 6 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.