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

[PATCH v3 4/9] reset: introduce dry-run mode

From
Patrick Steinhardt <ps@pks.im>
Date
Jun 8, 2026, 10:23 UTC
Message-ID
<20260608-b4-pks-history-drop-v3-4-84ca8e43e937@pks.im>
In-Reply-To
<20260608-b4-pks-history-drop-v3-0-84ca8e43e937@pks.im>

In a subsequent commit we'll add another caller to `reset_head()` that wants to perform a dry-run check of whether it would be possible to update the index and working tree when moving to a new commit. Introduce a new flag that lets the caller perform this operation.

Signed-off-by: Patrick Steinhardt <ps@pks.im>
---
 reset.c | 44 +++++++++++++++++++++++++++++++++-----------
 reset.h |  6 ++++++
 2 files changed, 39 insertions(+), 11 deletions(-)
diff --git a/reset.c b/reset.c
index 228cad5f42..8fb39d4c51 100644
--- a/reset.c
+++ b/reset.c
@@ -92,11 +92,14 @@ int reset_head(struct repository *r, const struct reset_head_opts *opts)
 	unsigned reset_hard = opts->flags & RESET_HEAD_HARD;
 	unsigned refs_only = opts->flags & RESET_HEAD_REFS_ONLY;
 	unsigned update_orig_head = opts->flags & RESET_HEAD_UPDATE_ORIG_HEAD;
+	unsigned dry_run = opts->flags & RESET_HEAD_DRY_RUN;
 	struct object_id *head = NULL, head_oid;
 	struct tree_desc desc[2] = { { NULL }, { NULL } };
 	struct lock_file lock = LOCK_INIT;
 	struct unpack_trees_options unpack_tree_opts = { 0 };
 	struct tree *tree;
+	struct index_state scratch_index = INDEX_STATE_INIT(r);
+	struct index_state *istate;
 	const char *action;
 	int ret = 0, nr = 0;
 
@@ -109,7 +112,7 @@ int reset_head(struct repository *r, const struct reset_head_opts *opts)
 	if (opts->branch_msg && !opts->branch)
 		BUG("branch reflog message given without a branch");
 
-	if (!refs_only && repo_hold_locked_index(r, &lock, LOCK_REPORT_ON_ERROR) < 0) {
+	if (!refs_only && !dry_run && repo_hold_locked_index(r, &lock, LOCK_REPORT_ON_ERROR) < 0) {
 		ret = -1;
 		goto leave_reset_head;
 	}
@@ -124,16 +127,36 @@ int reset_head(struct repository *r, const struct reset_head_opts *opts)
 	if (!oid)
 		oid = &head_oid;
 
-	if (refs_only)
-		return update_refs(r, opts, oid, head);
+	if (refs_only) {
+		if (!dry_run)
+			return update_refs(r, opts, oid, head);
+		return 0;
+	}
+
+	if (dry_run) {
+		if (read_index_from(&scratch_index, r->index_file, r->gitdir) < 0 ||
+		    index_state_unmerged_to_stage0(&scratch_index) < 0) {
+			ret = error(_("could not read index"));
+			goto leave_reset_head;
+		}
+
+		istate = &scratch_index;
+	} else {
+		if (repo_read_index_unmerged(r) < 0) {
+			ret = error(_("could not read index"));
+			goto leave_reset_head;
+		}
+		istate = r->index;
+	}
 
 	action = reset_hard ? "reset" : "checkout";
 	setup_unpack_trees_porcelain(&unpack_tree_opts, action);
 	unpack_tree_opts.head_idx = 1;
-	unpack_tree_opts.src_index = r->index;
-	unpack_tree_opts.dst_index = r->index;
+	unpack_tree_opts.src_index = istate;
+	unpack_tree_opts.dst_index = istate;
 	unpack_tree_opts.fn = reset_hard ? oneway_merge : twoway_merge;
-	unpack_tree_opts.update = 1;
+	unpack_tree_opts.update = !dry_run;
+	unpack_tree_opts.dry_run = dry_run;
 	unpack_tree_opts.merge = 1;
 	unpack_tree_opts.preserve_ignored = 0; /* FIXME: !overwrite_ignore */
 	unpack_tree_opts.skip_cache_tree_update = 1;
@@ -141,11 +164,6 @@ int reset_head(struct repository *r, const struct reset_head_opts *opts)
 	if (reset_hard)
 		unpack_tree_opts.reset = UNPACK_RESET_PROTECT_UNTRACKED;
 
-	if (repo_read_index_unmerged(r) < 0) {
-		ret = error(_("could not read index"));
-		goto leave_reset_head;
-	}
-
 	if (!reset_hard && !fill_tree_descriptor(r, &desc[nr++], &head_oid)) {
 		ret = error(_("failed to find tree of %s"),
 			    oid_to_hex(&head_oid));
@@ -162,6 +180,9 @@ int reset_head(struct repository *r, const struct reset_head_opts *opts)
 		goto leave_reset_head;
 	}
 
+	if (dry_run)
+		goto leave_reset_head;
+
 	tree = repo_parse_tree_indirect(r, oid);
 	if (!tree) {
 		ret = error(_("unable to read tree (%s)"), oid_to_hex(oid));
@@ -181,6 +202,7 @@ int reset_head(struct repository *r, const struct reset_head_opts *opts)
 leave_reset_head:
 	rollback_lock_file(&lock);
 	clear_unpack_trees_porcelain(&unpack_tree_opts);
+	release_index(&scratch_index);
 	while (nr)
 		free((void *)desc[--nr].buffer);
 	return ret;
diff --git a/reset.h b/reset.h
index 0bf25c51de..cc9fd4378a 100644
--- a/reset.h
+++ b/reset.h
@@ -21,6 +21,12 @@ enum reset_head_flags {
 
 	/* Update ORIG_HEAD as well as HEAD */
 	RESET_HEAD_UPDATE_ORIG_HEAD = (1 << 4),
+
+	/*
+	 * Perform a dry-run by performing the operation without updating
+	 * any user-visible state.
+	 */
+	RESET_HEAD_DRY_RUN = (1 << 5),
 };
 
 struct reset_head_opts {
-- 
2.54.0.1136.gdb2ca164c4.dirty
Previous: Patrick SteinhardtNext: Patrick Steinhardt
Message 38 of 101 in “builtin/history: introduce "drop" subcommand”
  1. 0/2 builtin/history: introduce "drop" subcommandPatrick Steinhardt, Jun 1, 2026
  2. 1/2 builtin/history: split handling of ref updates into two phasesPatrick Steinhardt, Jun 1, 2026
  3. 2/2 builtin/history: implement "drop" subcommandPatrick Steinhardt, Jun 1, 2026
  4. Junio C HamanoJun 1, 2026
  5. Patrick SteinhardtJun 3, 2026
  6. Pablo SabaterJun 2, 2026
  7. Patrick SteinhardtJun 3, 2026
  8. 0/9 builtin/history: introduce "drop" subcommandPatrick Steinhardt, Jun 3, 2026
  9. 1/9 read-cache: split out function to drop unmerged entries to stage 0Patrick Steinhardt, Jun 3, 2026
  10. 2/9 reset: drop `USE_THE_REPOSITORY_VARIABLE`Patrick Steinhardt, Jun 3, 2026
  11. 3/9 reset: modernize flags passed to `reset_head()`Patrick Steinhardt, Jun 3, 2026
  12. Kristoffer HaugsbakkJun 3, 2026
  13. Phillip WoodJun 5, 2026
  14. Patrick SteinhardtJun 8, 2026
  15. 4/9 reset: introduce dry-run modePatrick Steinhardt, Jun 3, 2026
  16. Kristoffer HaugsbakkJun 3, 2026
  17. Junio C HamanoJun 3, 2026
  18. 5/9 reset: introduce ability to skip reference updatesPatrick Steinhardt, Jun 3, 2026
  19. Junio C HamanoJun 3, 2026
  20. Patrick SteinhardtJun 4, 2026
  21. Phillip WoodJun 5, 2026
  22. Patrick SteinhardtJun 8, 2026
  23. Patrick SteinhardtJun 8, 2026
  24. Phillip WoodJun 9, 2026
  25. Patrick SteinhardtJun 10, 2026
  26. 6/9 reset: allow the caller to specify the current HEAD objectPatrick Steinhardt, Jun 3, 2026
  27. 7/9 reset: stop assuming that the caller passes in a clean indexPatrick Steinhardt, Jun 3, 2026
  28. 8/9 builtin/history: split handling of ref updates into two phasesPatrick Steinhardt, Jun 3, 2026
  29. 9/9 builtin/history: implement "drop" subcommandPatrick Steinhardt, Jun 3, 2026
  30. Kristoffer HaugsbakkJun 3, 2026
  31. Patrick SteinhardtJun 4, 2026
  32. Junio C HamanoJun 3, 2026
  33. Patrick SteinhardtJun 4, 2026
  34. 0/9 builtin/history: introduce "drop" subcommandPatrick Steinhardt, Jun 8, 2026
  35. 1/9 read-cache: split out function to drop unmerged entries to stage 0Patrick Steinhardt, Jun 8, 2026
  36. 2/9 reset: drop `USE_THE_REPOSITORY_VARIABLE`Patrick Steinhardt, Jun 8, 2026
  37. 3/9 reset: modernize flags passed to `reset_head()`Patrick Steinhardt, Jun 8, 2026
  38. 4/9 reset: introduce dry-run modePatrick Steinhardt, Jun 8, 2026
  39. 5/9 reset: introduce ability to skip reference updatesPatrick Steinhardt, Jun 8, 2026
  40. 6/9 reset: allow the caller to specify the current HEAD objectPatrick Steinhardt, Jun 8, 2026
  41. 7/9 reset: stop assuming that the caller passes in a clean indexPatrick Steinhardt, Jun 8, 2026
  42. 8/9 builtin/history: split handling of ref updates into two phasesPatrick Steinhardt, Jun 8, 2026
  43. 9/9 builtin/history: implement "drop" subcommandPatrick Steinhardt, Jun 8, 2026
  44. 00/10 builtin/history: introduce "drop" subcommandPatrick Steinhardt, Jun 10, 2026
  45. 01/10 read-cache: split out function to drop unmerged entries to stage 0Patrick Steinhardt, Jun 10, 2026
  46. 02/10 reset: drop `USE_THE_REPOSITORY_VARIABLE`Patrick Steinhardt, Jun 10, 2026
  47. 03/10 reset: rename `reset_head()`Patrick Steinhardt, Jun 10, 2026
  48. Phillip WoodJun 10, 2026
  49. 04/10 reset: modernize flags passed to `reset_working_tree()`Patrick Steinhardt, Jun 10, 2026
  50. Phillip WoodJun 10, 2026
  51. 05/10 reset: introduce dry-run modePatrick Steinhardt, Jun 10, 2026
  52. 06/10 reset: introduce ability to skip updating HEADPatrick Steinhardt, Jun 10, 2026
  53. Phillip WoodJun 10, 2026
  54. Patrick SteinhardtJun 11, 2026
  55. 07/10 reset: allow the caller to specify the current HEAD objectPatrick Steinhardt, Jun 10, 2026
  56. 08/10 reset: stop assuming that the caller passes in a clean indexPatrick Steinhardt, Jun 10, 2026
  57. 09/10 builtin/history: split handling of ref updates into two phasesPatrick Steinhardt, Jun 10, 2026
  58. Junio C HamanoJun 10, 2026
  59. 10/10 builtin/history: implement "drop" subcommandPatrick Steinhardt, Jun 10, 2026
  60. 00/10 builtin/history: introduce "drop" subcommandPatrick Steinhardt, Jun 11, 2026
  61. 01/10 read-cache: split out function to drop unmerged entries to stage 0Patrick Steinhardt, Jun 11, 2026
  62. 02/10 reset: drop `USE_THE_REPOSITORY_VARIABLE`Patrick Steinhardt, Jun 11, 2026
  63. 03/10 reset: rename `reset_head()`Patrick Steinhardt, Jun 11, 2026
  64. 04/10 reset: modernize flags passed to `reset_working_tree()`Patrick Steinhardt, Jun 11, 2026
  65. 05/10 reset: introduce dry-run modePatrick Steinhardt, Jun 11, 2026
  66. 06/10 reset: introduce ability to skip updating HEADPatrick Steinhardt, Jun 11, 2026
  67. Junio C HamanoJun 11, 2026
  68. Patrick SteinhardtJun 15, 2026
  69. 07/10 reset: allow the caller to specify the current HEAD objectPatrick Steinhardt, Jun 11, 2026
  70. 08/10 reset: stop assuming that the caller passes in a clean indexPatrick Steinhardt, Jun 11, 2026
  71. 09/10 builtin/history: split handling of ref updates into two phasesPatrick Steinhardt, Jun 11, 2026
  72. 10/10 builtin/history: implement "drop" subcommandPatrick Steinhardt, Jun 11, 2026
  73. 00/10 builtin/history: introduce "drop" subcommandPatrick Steinhardt, Jun 15, 2026
  74. 01/10 read-cache: split out function to drop unmerged entries to stage 0Patrick Steinhardt, Jun 15, 2026
  75. 02/10 reset: drop `USE_THE_REPOSITORY_VARIABLE`Patrick Steinhardt, Jun 15, 2026
  76. 03/10 reset: rename `reset_head()`Patrick Steinhardt, Jun 15, 2026
  77. 04/10 reset: modernize flags passed to `reset_working_tree()`Patrick Steinhardt, Jun 15, 2026
  78. 05/10 reset: introduce dry-run modePatrick Steinhardt, Jun 15, 2026
  79. 06/10 reset: introduce ability to skip updating HEADPatrick Steinhardt, Jun 15, 2026
  80. 07/10 reset: allow the caller to specify the current HEAD objectPatrick Steinhardt, Jun 15, 2026
  81. 08/10 reset: stop assuming that the caller passes in a clean indexPatrick Steinhardt, Jun 15, 2026
  82. 09/10 builtin/history: split handling of ref updates into two phasesPatrick Steinhardt, Jun 15, 2026
  83. Christian CouderJun 25, 2026
  84. Patrick SteinhardtJun 29, 2026
  85. 10/10 builtin/history: implement "drop" subcommandPatrick Steinhardt, Jun 15, 2026
  86. Christian CouderJun 25, 2026
  87. Junio C HamanoJun 25, 2026
  88. 00/11 builtin/history: introduce "drop" subcommandPatrick Steinhardt, Jun 29, 2026
  89. 01/11 read-cache: split out function to drop unmerged entries to stage 0Patrick Steinhardt, Jun 29, 2026
  90. 02/11 reset: drop `USE_THE_REPOSITORY_VARIABLE`Patrick Steinhardt, Jun 29, 2026
  91. 03/11 reset: rename `reset_head()`Patrick Steinhardt, Jun 29, 2026
  92. 04/11 reset: modernize flags passed to `reset_working_tree()`Patrick Steinhardt, Jun 29, 2026
  93. 05/11 reset: introduce dry-run modePatrick Steinhardt, Jun 29, 2026
  94. 06/11 reset: introduce ability to skip updating HEADPatrick Steinhardt, Jun 29, 2026
  95. 07/11 reset: allow the caller to specify the current HEAD objectPatrick Steinhardt, Jun 29, 2026
  96. 08/11 reset: stop assuming that the caller passes in a clean indexPatrick Steinhardt, Jun 29, 2026
  97. 09/11 replay: expose `replay_result_queue_update()`Patrick Steinhardt, Jun 29, 2026
  98. 10/11 builtin/history: split handling of ref updates into two phasesPatrick Steinhardt, Jun 29, 2026
  99. 11/11 builtin/history: implement "drop" subcommandPatrick Steinhardt, Jun 29, 2026
  100. Junio C HamanoJun 29, 2026
  101. Patrick SteinhardtJul 1, 2026

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.