[v3,05/11] unpack-trees: make dir an internal-only struct

Commit Message

Elijah Newren Sept. 27, 2021, 4:33 p.m. UTC

From: Elijah Newren <[e-mail]>

Avoid accidental misuse or confusion over ownership by clearly making
unpack_trees_options.dir an internal-only variable.

Signed-off-by: Elijah Newren <[e-mail]>
---
 unpack-trees.c | 7 +++++--
 unpack-trees.h | 2 +-
 2 files changed, 6 insertions(+), 3 deletions(-)

Patch

diff --git a/unpack-trees.c b/unpack-trees.c
index 1e4eae1dc7d..e067cce0fcd 100644
--- a/unpack-trees.c
+++ b/unpack-trees.c
@@ -1694,9 +1694,12 @@  int unpack_trees(unsigned len, struct tree_desc *t, struct unpack_trees_options
 	static struct cache_entry *dfc;
 	struct pattern_list pl;
 	int free_pattern_list = 0;
+	struct dir_struct dir = DIR_INIT;
 
 	if (len > MAX_UNPACK_TREES)
 		die("unpack_trees takes at most %d trees", MAX_UNPACK_TREES);
+	if (o->dir)
+		BUG("o->dir is for internal use only");
 
 	trace_performance_enter();
 	trace2_region_enter("unpack_trees", "unpack_trees", the_repository);
@@ -1708,7 +1711,7 @@  int unpack_trees(unsigned len, struct tree_desc *t, struct unpack_trees_options
 	}
 
 	if (!o->preserve_ignored) {
-		CALLOC_ARRAY(o->dir, 1);
+		o->dir = &dir;
 		o->dir->flags |= DIR_SHOW_IGNORED;
 		setup_standard_excludes(o->dir);
 	}
@@ -1876,7 +1879,7 @@  done:
 		clear_pattern_list(&pl);
 	if (o->dir) {
 		dir_clear(o->dir);
-		FREE_AND_NULL(o->dir);
+		o->dir = NULL;
 	}
 	trace2_region_leave("unpack_trees", "unpack_trees", the_repository);
 	trace_performance_leave("unpack_trees");
diff --git a/unpack-trees.h b/unpack-trees.h
index f98cfd49d7b..61da25dafee 100644
--- a/unpack-trees.h
+++ b/unpack-trees.h
@@ -67,7 +67,6 @@  struct unpack_trees_options {
 		     dry_run;
 	const char *prefix;
 	int cache_bottom;
-	struct dir_struct *dir;
 	struct pathspec *pathspec;
 	merge_fn_t fn;
 	const char *msgs[NB_UNPACK_TREES_WARNING_TYPES];
@@ -89,6 +88,7 @@  struct unpack_trees_options {
 	struct index_state result;
 
 	struct pattern_list *pl; /* for internal use */
+	struct dir_struct *dir; /* for internal use only */
 	struct checkout_metadata meta;
 };