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

[PATCH v14 03/41] builtin/apply: make apply_patch() return -1 or -128 instead of die()ing

From
Christian Couder <christian.couder@gmail.com>
Date
Sep 4, 2016, 20:17 UTC
Message-ID
<20160904201833.21676-4-chriscool@tuxfamily.org>
In-Reply-To
<20160904201833.21676-1-chriscool@tuxfamily.org>

To libify `git apply` functionality we have to signal errors to the caller instead of die()ing.

As a first step in this direction, let's make apply_patch() return -1 or -128 in case of errors instead of dying. For now its only caller apply_all_patches() will exit(128) when apply_patch() return -128 and it will exit(1) when it returns -1.

We exit() with code 128 because that was what die() was doing and we want to keep the distinction between exiting with code 1 and exiting with code 128.

Helped-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
---
 builtin/apply.c | 60 ++++++++++++++++++++++++++++++++++++++++++---------------
 1 file changed, 45 insertions(+), 15 deletions(-)
diff --git a/builtin/apply.c b/builtin/apply.c
index ed923ca..435030a 100644
--- a/builtin/apply.c
+++ b/builtin/apply.c
@@ -4404,6 +4404,15 @@ static struct lock_file lock_file;
 #define INACCURATE_EOF	(1<<0)
 #define RECOUNT		(1<<1)
 
+/*
+ * Try to apply a patch.
+ *
+ * Returns:
+ *  -128 if a bad error happened (like patch unreadable)
+ *  -1 if patch did not apply and user cannot deal with it
+ *   0 if the patch applied
+ *   1 if the patch did not apply but user might fix it
+ */
 static int apply_patch(struct apply_state *state,
 		       int fd,
 		       const char *filename,
@@ -4413,6 +4422,7 @@ static int apply_patch(struct apply_state *state,
 	struct strbuf buf = STRBUF_INIT; /* owns the patch text */
 	struct patch *list = NULL, **listp = &list;
 	int skipped_patch = 0;
+	int res = 0;
 
 	state->patch_input_file = filename;
 	read_patch_file(&buf, fd);
@@ -4445,8 +4455,11 @@ static int apply_patch(struct apply_state *state,
 		offset += nr;
 	}
 
-	if (!list && !skipped_patch)
-		die(_("unrecognized input"));
+	if (!list && !skipped_patch) {
+		error(_("unrecognized input"));
+		res = -128;
+		goto end;
+	}
 
 	if (state->whitespace_error && (state->ws_error_action == die_on_ws_error))
 		state->apply = 0;
@@ -4455,21 +4468,23 @@ static int apply_patch(struct apply_state *state,
 	if (state->update_index && state->newfd < 0)
 		state->newfd = hold_locked_index(state->lock_file, 1);
 
-	if (state->check_index) {
-		if (read_cache() < 0)
-			die(_("unable to read index file"));
+	if (state->check_index && read_cache() < 0) {
+		error(_("unable to read index file"));
+		res = -128;
+		goto end;
 	}
 
 	if ((state->check || state->apply) &&
 	    check_patch_list(state, list) < 0 &&
-	    !state->apply_with_reject)
-		exit(1);
+	    !state->apply_with_reject) {
+		res = -1;
+		goto end;
+	}
 
 	if (state->apply && write_out_results(state, list)) {
-		if (state->apply_with_reject)
-			exit(1);
 		/* with --3way, we still need to write the index out */
-		return 1;
+		res = state->apply_with_reject ? -1 : 1;
+		goto end;
 	}
 
 	if (state->fake_ancestor)
@@ -4484,10 +4499,11 @@ static int apply_patch(struct apply_state *state,
 	if (state->summary)
 		summary_patch_list(list);
 
+end:
 	free_patch_list(list);
 	strbuf_release(&buf);
 	string_list_clear(&state->fn_table, 0);
-	return 0;
+	return res;
 }
 
 static void git_apply_config(void)
@@ -4628,6 +4644,7 @@ static int apply_all_patches(struct apply_state *state,
 			     int options)
 {
 	int i;
+	int res;
 	int errs = 0;
 	int read_stdin = 1;
 
@@ -4636,7 +4653,10 @@ static int apply_all_patches(struct apply_state *state,
 		int fd;
 
 		if (!strcmp(arg, "-")) {
-			errs |= apply_patch(state, 0, "<stdin>", options);
+			res = apply_patch(state, 0, "<stdin>", options);
+			if (res < 0)
+				goto end;
+			errs |= res;
 			read_stdin = 0;
 			continue;
 		} else if (0 < state->prefix_length)
@@ -4649,12 +4669,19 @@ static int apply_all_patches(struct apply_state *state,
 			die_errno(_("can't open patch '%s'"), arg);
 		read_stdin = 0;
 		set_default_whitespace_mode(state);
-		errs |= apply_patch(state, fd, arg, options);
+		res = apply_patch(state, fd, arg, options);
+		if (res < 0)
+			goto end;
+		errs |= res;
 		close(fd);
 	}
 	set_default_whitespace_mode(state);
-	if (read_stdin)
-		errs |= apply_patch(state, 0, "<stdin>", options);
+	if (read_stdin) {
+		res = apply_patch(state, 0, "<stdin>", options);
+		if (res < 0)
+			goto end;
+		errs |= res;
+	}
 
 	if (state->whitespace_error) {
 		if (state->squelch_whitespace_errors &&
@@ -4690,6 +4717,9 @@ static int apply_all_patches(struct apply_state *state,
 	}
 
 	return !!errs;
+
+end:
+	exit(res == -1 ? 1 : 128);
 }
 
 int cmd_apply(int argc, const char **argv, const char *prefix)

-- 
2.10.0.41.g9df52c3
Previous: Christian CouderNext: Christian Couder
Message 5 of 44 in “libify apply and use lib in am, part 2”
  1. 00/41 libify apply and use lib in am, part 2Christian Couder, Sep 4, 2016
  2. 01/41 apply: make some names more specificChristian Couder, Sep 4, 2016
  3. 02/41 apply: move 'struct apply_state' to apply.hChristian Couder, Sep 4, 2016
  4. 04/41 builtin/apply: read_patch_file() return -1 instead of die()ingChristian Couder, Sep 4, 2016
  5. 03/41 builtin/apply: make apply_patch() return -1 or -128 instead of die()ingChristian Couder, Sep 4, 2016
  6. 12/41 builtin/apply: make check_apply_state() return -1 instead of die()ingChristian Couder, Sep 4, 2016
  7. 11/41 apply: make init_apply_state() return -1 instead of exit()ingChristian Couder, Sep 4, 2016
  8. 14/41 builtin/apply: make apply_all_patches() return 128 or 1 on errorChristian Couder, Sep 4, 2016
  9. 15/41 builtin/apply: make parse_traditional_patch() return -1 on errorChristian Couder, Sep 4, 2016
  10. 17/41 builtin/apply: make gitdiff_*() return -1 on errorChristian Couder, Sep 4, 2016
  11. 13/41 builtin/apply: move check_apply_state() to apply.cChristian Couder, Sep 4, 2016
  12. 19/41 builtin/apply: make build_fake_ancestor() return -1 on errorChristian Couder, Sep 4, 2016
  13. 20/41 builtin/apply: make remove_file() return -1 on errorChristian Couder, Sep 4, 2016
  14. 16/41 builtin/apply: make gitdiff_*() return 1 at end of headerChristian Couder, Sep 4, 2016
  15. 23/41 builtin/apply: make create_file() return -1 on errorChristian Couder, Sep 4, 2016
  16. 22/41 builtin/apply: make add_index_file() return -1 on errorChristian Couder, Sep 4, 2016
  17. 18/41 builtin/apply: change die_on_unsafe_path() to check_unsafe_path()Christian Couder, Sep 4, 2016
  18. 24/41 builtin/apply: make write_out_one_result() return -1 on errorChristian Couder, Sep 4, 2016
  19. 21/41 builtin/apply: make add_conflicted_stages_file() return -1 on errorChristian Couder, Sep 4, 2016
  20. 25/41 builtin/apply: make write_out_results() return -1 on errorChristian Couder, Sep 4, 2016
  21. 29/41 apply: rename and move opt constants to apply.hChristian Couder, Sep 4, 2016
  22. 27/41 builtin/apply: make create_one_file() return -1 on errorChristian Couder, Sep 4, 2016
  23. 31/41 apply: make some parsing functions static againChristian Couder, Sep 4, 2016
  24. 32/41 apply: use error_errno() where possibleChristian Couder, Sep 4, 2016
  25. 28/41 builtin/apply: rename option parsing functionsChristian Couder, Sep 4, 2016
  26. 33/41 apply: make it possible to silently applyChristian Couder, Sep 4, 2016
  27. 34/41 apply: don't print on stdout in verbosity_silent modeChristian Couder, Sep 4, 2016
  28. 26/41 builtin/apply: make try_create_file() return -1 on errorChristian Couder, Sep 4, 2016
  29. 35/41 usage: add set_warn_routine()Christian Couder, Sep 4, 2016
  30. 41/41 builtin/am: use apply API in run_apply()Christian Couder, Sep 4, 2016
  31. 40/41 apply: learn to use a different index fileChristian Couder, Sep 4, 2016
  32. 39/41 apply: pass apply state to build_fake_ancestor()Christian Couder, Sep 4, 2016
  33. 38/41 apply: refactor `git apply` option parsingChristian Couder, Sep 4, 2016
  34. 37/41 apply: change error_routine when silentChristian Couder, Sep 4, 2016
  35. 36/41 usage: add get_error_routine() and get_warn_routine()Christian Couder, Sep 4, 2016
  36. 06/41 builtin/apply: make parse_chunk() return a negative integer on errorChristian Couder, Sep 4, 2016
  37. 10/41 builtin/apply: move init_apply_state() to apply.cChristian Couder, Sep 4, 2016
  38. 09/41 builtin/apply: make parse_ignorewhitespace_option() return -1 instead of die()ingChristian Couder, Sep 4, 2016
  39. 07/41 builtin/apply: make parse_single_patch() return -1 on errorChristian Couder, Sep 4, 2016
  40. 08/41 builtin/apply: make parse_whitespace_option() return -1 instead of die()ingChristian Couder, Sep 4, 2016
  41. 05/41 builtin/apply: make find_header() return -128 instead of die()ingChristian Couder, Sep 4, 2016
  42. Stefan BellerSep 6, 2016
  43. Junio C HamanoSep 7, 2016
  44. Stefan BellerSep 6, 2016

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.