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

[PATCH v2 6/6] bisect--helper: `bisect_write` shell function in C

From
Pranit Bauva <pranit.bauva@gmail.com>
Date
Jun 15, 2016, 14:00 UTC
Message-ID
<20160615140026.10519-7-pranit.bauva@gmail.com>
In-Reply-To
<20160615140026.10519-1-pranit.bauva@gmail.com>

Reimplement the `bisect_write` shell function in C and add a `bisect-write` subcommand to `git bisect--helper` to call it from git-bisect.sh

Using `--bisect-write` subcommand is a temporary measure to port shell function in C so as to use the existing test suite. As more functions are ported, this subcommand will be retired and will be called by some other methods.

Note: bisect_write() uses two variables namely TERM_GOOD and TERM_BAD
from the global shell script thus we need to pass it to the subcommand
using the arguments. After the whole conversion, we can remove the extra
arguments and make the method use the two variables from the global scope
within the C code.
Mentored-by: Lars Schneider <larsxschneider@gmail.com>
Mentored-by: Christian Couder <chriscool@tuxfamily.org>
Signed-off-by: Pranit Bauva <pranit.bauva@gmail.com>
---
 builtin/bisect--helper.c | 61 +++++++++++++++++++++++++++++++++++++++++++++++-
 git-bisect.sh            | 25 ++++----------------
 2 files changed, 64 insertions(+), 22 deletions(-)
diff --git a/builtin/bisect--helper.c b/builtin/bisect--helper.c
index f11c247..eebfcf0 100644
--- a/builtin/bisect--helper.c
+++ b/builtin/bisect--helper.c
@@ -22,6 +22,7 @@ static const char * const git_bisect_helper_usage[] = {
 	N_("git bisect--helper --write-terms <bad_term> <good_term>"),
 	N_("git bisect--helper --bisect-clean-state"),
 	N_("git bisect--helper --bisect-reset [<commit>]"),
+	N_("git bisect--helper --bisect-write <state> <revision> <TERM_GOOD> <TERM_BAD> [<nolog>]"),
 	NULL
 };
 
@@ -192,6 +193,55 @@ static int check_expected_revs(const char **revs, int rev_nr)
 	return 0;
 }
 
+static int bisect_write(const char *state, const char *rev,
+			const char *term_good, const char *term_bad,
+			int nolog)
+{
+	struct strbuf tag = STRBUF_INIT;
+	struct strbuf commit_name = STRBUF_INIT;
+	struct object_id oid;
+	struct commit *commit;
+	struct pretty_print_context pp = {0};
+	FILE *fp;
+
+	if (!strcmp(state, term_bad))
+		strbuf_addf(&tag, "refs/bisect/%s", state);
+	else if(one_of(state, term_good, "skip", NULL))
+		strbuf_addf(&tag, "refs/bisect/%s-%s", state, rev);
+	else
+		return error(_("Bad bisect_write argument: %s"), state);
+
+	if (get_oid(rev, &oid)) {
+		strbuf_release(&tag);
+		return error(_("couldn't get the oid of the rev '%s'"), rev);
+	}
+
+	if (update_ref(NULL, tag.buf, oid.hash, NULL, 0,
+		       UPDATE_REFS_MSG_ON_ERR)) {
+		strbuf_release(&tag);
+		return -1;
+	}
+
+	fp = fopen(git_path_bisect_log(), "a");
+	if (!fp) {
+		strbuf_release(&tag);
+		return error_errno(_("couldn't open the file '%s'"), git_path_bisect_log());
+	}
+
+	commit = lookup_commit_reference(oid.hash);
+	format_commit_message(commit, "%s", &commit_name, &pp);
+	fprintf(fp, "# %s: [%s] %s\n", state, sha1_to_hex(oid.hash),
+		commit_name.buf);
+
+	if (!nolog)
+		fprintf(fp, "git bisect %s %s\n", state, rev);
+
+	strbuf_release(&commit_name);
+	strbuf_release(&tag);
+	fclose(fp);
+	return 0;
+}
+
 int cmd_bisect__helper(int argc, const char **argv, const char *prefix)
 {
 	enum {
@@ -199,7 +249,8 @@ int cmd_bisect__helper(int argc, const char **argv, const char *prefix)
 		WRITE_TERMS,
 		BISECT_CLEAN_STATE,
 		BISECT_RESET,
-		CHECK_EXPECTED_REVS
+		CHECK_EXPECTED_REVS,
+		BISECT_WRITE
 	} cmdmode = 0;
 	int no_checkout = 0;
 	struct option options[] = {
@@ -213,6 +264,8 @@ int cmd_bisect__helper(int argc, const char **argv, const char *prefix)
 			 N_("reset the bisection state"), BISECT_RESET),
 		OPT_CMDMODE(0, "check-expected-revs", &cmdmode,
 			 N_("check for expected revs"), CHECK_EXPECTED_REVS),
+		OPT_CMDMODE(0, "bisect-write", &cmdmode,
+			 N_("write out the bisection state in BISECT_LOG"), BISECT_WRITE),
 		OPT_BOOL(0, "no-checkout", &no_checkout,
 			 N_("update BISECT_HEAD instead of checking out the current commit")),
 		OPT_END()
@@ -225,6 +278,7 @@ int cmd_bisect__helper(int argc, const char **argv, const char *prefix)
 		usage_with_options(git_bisect_helper_usage, options);
 
 	switch (cmdmode) {
+	int nolog;
 	case NEXT_ALL:
 		return bisect_next_all(prefix, no_checkout);
 	case WRITE_TERMS:
@@ -241,6 +295,11 @@ int cmd_bisect__helper(int argc, const char **argv, const char *prefix)
 		return bisect_reset(argc ? argv[0] : NULL);
 	case CHECK_EXPECTED_REVS:
 		return check_expected_revs(argv, argc);
+	case BISECT_WRITE:
+		if (argc != 4 && argc != 5)
+			die(_("--bisect-write requires either 4 or 5 arguments"));
+		nolog = (argc == 5) && !strcmp(argv[4], "nolog");
+		return bisect_write(argv[0], argv[1], argv[2], argv[3], nolog);
 	default:
 		die("BUG: unknown subcommand '%d'", cmdmode);
 	}
diff --git a/git-bisect.sh b/git-bisect.sh
index 4f6545e..b9896a4 100755
--- a/git-bisect.sh
+++ b/git-bisect.sh
@@ -145,7 +145,7 @@ bisect_start() {
 		0) state=$TERM_BAD ; bad_seen=1 ;;
 		*) state=$TERM_GOOD ;;
 		esac
-		eval="$eval bisect_write '$state' '$rev' 'nolog' &&"
+		eval="$eval git bisect--helper --bisect-write '$state' '$rev' '$TERM_GOOD' '$TERM_BAD' 'nolog' &&"
 	done
 	#
 	# Verify HEAD.
@@ -221,23 +221,6 @@ bisect_start() {
 	trap '-' 0
 }
 
-bisect_write() {
-	state="$1"
-	rev="$2"
-	nolog="$3"
-	case "$state" in
-		"$TERM_BAD")
-			tag="$state" ;;
-		"$TERM_GOOD"|skip)
-			tag="$state"-"$rev" ;;
-		*)
-			die "$(eval_gettext "Bad bisect_write argument: \$state")" ;;
-	esac
-	git update-ref "refs/bisect/$tag" "$rev" || exit
-	echo "# $state: $(git show-branch $rev)" >>"$GIT_DIR/BISECT_LOG"
-	test -n "$nolog" || echo "git bisect $state $rev" >>"$GIT_DIR/BISECT_LOG"
-}
-
 bisect_skip() {
 	all=''
 	for arg in "$@"
@@ -263,7 +246,7 @@ bisect_state() {
 	1,"$TERM_BAD"|1,"$TERM_GOOD"|1,skip)
 		rev=$(git rev-parse --verify $(bisect_head)) ||
 			die "$(gettext "Bad rev input: $(bisect_head)")"
-		bisect_write "$state" "$rev"
+		git bisect--helper --bisect-write "$state" "$rev" "$TERM_GOOD" "$TERM_BAD" || exit
 		git bisect--helper --check-expected-revs "$rev" ;;
 	2,"$TERM_BAD"|*,"$TERM_GOOD"|*,skip)
 		shift
@@ -276,7 +259,7 @@ bisect_state() {
 		done
 		for rev in $hash_list
 		do
-			bisect_write "$state" "$rev"
+			git bisect--helper --bisect-write "$state" "$rev" "$TERM_GOOD" "$TERM_BAD" || exit
 		done
 		git bisect--helper --check-expected-revs $hash_list ;;
 	*,"$TERM_BAD")
@@ -413,7 +396,7 @@ bisect_replay () {
 			cmd="bisect_start $rev"
 			eval "$cmd" ;;
 		"$TERM_GOOD"|"$TERM_BAD"|skip)
-			bisect_write "$command" "$rev" ;;
+			git bisect--helper --bisect-write "$command" "$rev" "$TERM_GOOD" "$TERM_BAD" || exit;;
 		terms)
 			bisect_terms $rev ;;
 		*)
-- 
2.9.0
Previous: Pranit BauvaNext: Eric Sunshine
Message 53 of 75 in “bisect--helper: `bisect_clean_state` shell function in C”
  1. 1/4 bisect--helper: `bisect_clean_state` shell function in CPranit Bauva, Jun 7, 2016
  2. 2/4 t6030: explicitly test for bisection cleanupPranit Bauva, Jun 7, 2016
  3. Eric SunshineJun 7, 2016
  4. Pranit BauvaJun 8, 2016
  5. Eric SunshineJun 8, 2016
  6. Pranit BauvaJun 8, 2016
  7. 3/4 dir: introduce file_size() to check the size of filePranit Bauva, Jun 7, 2016
  8. Eric SunshineJun 8, 2016
  9. Pranit BauvaJun 8, 2016
  10. Eric SunshineJun 8, 2016
  11. Christian CouderJun 8, 2016
  12. Torsten BögershausenJun 8, 2016
  13. Pranit BauvaJun 8, 2016
  14. Torsten BögershausenJun 12, 2016
  15. Pranit BauvaJun 13, 2016
  16. 4/4 bisect--helper: `bisect_reset` shell function in CPranit Bauva, Jun 7, 2016
  17. Eric SunshineJun 8, 2016
  18. Christian CouderJun 8, 2016
  19. Christian CouderJun 8, 2016
  20. Eric SunshineJun 8, 2016
  21. Pranit BauvaJun 8, 2016
  22. Eric SunshineJun 8, 2016
  23. Pranit BauvaJun 8, 2016
  24. Eric SunshineJun 7, 2016
  25. Eric SunshineJun 8, 2016
  26. Pranit BauvaJun 8, 2016
  27. Eric SunshineJun 8, 2016
  28. Pranit BauvaJun 8, 2016
  29. Christian CouderJun 8, 2016
  30. Eric SunshineJun 8, 2016
  31. Pranit BauvaJun 8, 2016
  32. 0/6 convert various shell functions in git-bisect to CPranit Bauva, Jun 15, 2016
  33. 1/6 bisect--helper: `bisect_clean_state` shell function in CPranit Bauva, Jun 15, 2016
  34. Eric SunshineJun 15, 2016
  35. Pranit BauvaJun 15, 2016
  36. Eric SunshineJun 15, 2016
  37. 2/6 t6030: explicitly test for bisection cleanupPranit Bauva, Jun 15, 2016
  38. 3/6 wrapper: move is_empty_file() from builtin/am.cPranit Bauva, Jun 15, 2016
  39. Junio C HamanoJun 15, 2016
  40. Pranit BauvaJun 15, 2016
  41. Eric SunshineJun 15, 2016
  42. Pranit BauvaJun 15, 2016
  43. 5/6 bisect--helper: `is_expected_rev` & `check_expected_revs` shell function in CPranit Bauva, Jun 15, 2016
  44. Eric SunshineJun 15, 2016
  45. Pranit BauvaJun 16, 2016
  46. Eric SunshineJun 16, 2016
  47. Pranit BauvaJun 16, 2016
  48. Christian CouderJun 16, 2016
  49. Pranit BauvaJun 17, 2016
  50. 4/6 bisect--helper: `bisect_reset` shell function in CPranit Bauva, Jun 15, 2016
  51. Eric SunshineJun 15, 2016
  52. Pranit BauvaJun 16, 2016
  53. 6/6 bisect--helper: `bisect_write` shell function in CPranit Bauva, Jun 15, 2016
  54. Eric SunshineJun 16, 2016
  55. Pranit BauvaJun 16, 2016
  56. Christian CouderJun 16, 2016
  57. Pranit BauvaJun 17, 2016
  58. Eric SunshineJun 15, 2016
  59. Pranit BauvaJun 15, 2016
  60. 0/6 convert various shell functions in git-bisect to CPranit Bauva, Jun 26, 2016
  61. 1/6 bisect--helper: `bisect_clean_state` shell function in CPranit Bauva, Jun 26, 2016
  62. 2/6 t6030: explicitly test for bisection cleanupPranit Bauva, Jun 26, 2016
  63. 3/6 wrapper: move is_empty_file() and rename it as is_empty_or_missing_file()Pranit Bauva, Jun 26, 2016
  64. 4/6 bisect--helper: `bisect_reset` shell function in CPranit Bauva, Jun 26, 2016
  65. 5/6 bisect--helper: `is_expected_rev` & `check_expected_revs` shell function in CPranit Bauva, Jun 26, 2016
  66. 6/6 bisect--helper: `bisect_write` shell function in CPranit Bauva, Jun 26, 2016
  67. 0/6 convert various shell functions in git-bisect to CPranit Bauva, Jul 6, 2016
  68. 1/6 bisect--helper: `bisect_clean_state` shell function in CPranit Bauva, Jul 6, 2016
  69. 2/6 t6030: explicitly test for bisection cleanupPranit Bauva, Jul 6, 2016
  70. Junio C HamanoJul 11, 2016
  71. 3/6 wrapper: move is_empty_file() and rename it as is_empty_or_missing_file()Pranit Bauva, Jul 6, 2016
  72. 4/6 bisect--helper: `bisect_reset` shell function in CPranit Bauva, Jul 6, 2016
  73. 5/6 bisect--helper: `is_expected_rev` & `check_expected_revs` shell function in CPranit Bauva, Jul 6, 2016
  74. 6/6 bisect--helper: `bisect_write` shell function in CPranit Bauva, Jul 6, 2016
  75. Junio C HamanoJul 11, 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.