unpack-trees: introduce preserve_ignored to unpack_trees_options

Currently, every caller of unpack_trees() that wants to ensure ignored
files are overwritten by default needs to:
   * allocate unpack_trees_options.dir
   * flip the DIR_SHOW_IGNORED flag in unpack_trees_options.dir->flags
   * call setup_standard_excludes
AND then after the call to unpack_trees() needs to
   * call dir_clear()
   * deallocate unpack_trees_options.dir
That's a fair amount of boilerplate, and every caller uses identical
code.  Make this easier by instead introducing a new boolean value where
the default value (0) does what we want so that new callers of
unpack_trees() automatically get the appropriate behavior.  And move all
the handling of unpack_trees_options.dir into unpack_trees() itself.

While preserve_ignored = 0 is the behavior we feel is the appropriate
default, we defer fixing commands to use the appropriate default until a
later commit.  So, this commit introduces several locations where we
manually set preserve_ignored=1.  This makes it clear where code paths
were previously preserving ignored files when they should not have been;
a future commit will flip these to instead use a value of 0 to get the
behavior we want.

Signed-off-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Elijah Newren 2021-09-27 16:33:41 +00:00 committed by Junio C Hamano
parent 491a7575f1
commit 04988c8d18
14 changed files with 35 additions and 40 deletions

View File

@ -1919,6 +1919,9 @@ static int fast_forward_to(struct tree *head, struct tree *remote, int reset)
opts.update = 1;
opts.merge = 1;
opts.reset = reset;
if (!reset)
/* FIXME: Default should be to remove ignored files */
opts.preserve_ignored = 1;
opts.fn = twoway_merge;
init_tree_desc(&t[0], head->buffer, head->size);
init_tree_desc(&t[1], remote->buffer, remote->size);

View File

@ -648,6 +648,7 @@ static int reset_tree(struct tree *tree, const struct checkout_opts *o,
opts.skip_unmerged = !worktree;
opts.reset = 1;
opts.merge = 1;
opts.preserve_ignored = 0;
opts.fn = oneway_merge;
opts.verbose_update = o->show_progress;
opts.src_index = &the_index;
@ -746,11 +747,7 @@ static int merge_working_tree(const struct checkout_opts *opts,
new_branch_info->commit ?
&new_branch_info->commit->object.oid :
&new_branch_info->oid, NULL);
if (opts->overwrite_ignore) {
topts.dir = xcalloc(1, sizeof(*topts.dir));
topts.dir->flags |= DIR_SHOW_IGNORED;
setup_standard_excludes(topts.dir);
}
topts.preserve_ignored = !opts->overwrite_ignore;
tree = parse_tree_indirect(old_branch_info->commit ?
&old_branch_info->commit->object.oid :
the_hash_algo->empty_tree);
@ -760,10 +757,6 @@ static int merge_working_tree(const struct checkout_opts *opts,
init_tree_desc(&trees[1], tree->buffer, tree->size);
ret = unpack_trees(2, trees, &topts);
if (topts.dir) {
dir_clear(topts.dir);
FREE_AND_NULL(topts.dir);
}
clear_unpack_trees_porcelain(&topts);
if (ret == -1) {
/*

View File

@ -803,6 +803,8 @@ static int checkout(int submodule_progress)
opts.update = 1;
opts.merge = 1;
opts.clone = 1;
/* FIXME: Default should be to remove ignored files */
opts.preserve_ignored = 1;
opts.fn = oneway_merge;
opts.verbose_update = (option_verbosity >= 0);
opts.src_index = &the_index;

View File

@ -681,6 +681,8 @@ static int read_tree_trivial(struct object_id *common, struct object_id *head,
opts.verbose_update = 1;
opts.trivial_merges_only = 1;
opts.merge = 1;
/* FIXME: Default should be to remove ignored files */
opts.preserve_ignored = 1;
trees[nr_trees] = parse_tree_indirect(common);
if (!trees[nr_trees++])
return -1;

View File

@ -201,11 +201,9 @@ int cmd_read_tree(int argc, const char **argv, const char *cmd_prefix)
if ((opts.update || opts.index_only) && !opts.merge)
die("%s is meaningless without -m, --reset, or --prefix",
opts.update ? "-u" : "-i");
if (opts.update && !opts.reset) {
CALLOC_ARRAY(opts.dir, 1);
opts.dir->flags |= DIR_SHOW_IGNORED;
setup_standard_excludes(opts.dir);
}
if (opts.update && !opts.reset)
opts.preserve_ignored = 0;
/* otherwise, opts.preserve_ignored is irrelevant */
if (opts.merge && !opts.index_only)
setup_work_tree();
@ -245,11 +243,6 @@ int cmd_read_tree(int argc, const char **argv, const char *cmd_prefix)
if (unpack_trees(nr_trees, t, &opts))
return 128;
if (opts.dir) {
dir_clear(opts.dir);
FREE_AND_NULL(opts.dir);
}
if (opts.debug_unpack || opts.dry_run)
return 0; /* do not write the index out */

View File

@ -67,6 +67,8 @@ static int reset_index(const char *ref, const struct object_id *oid, int reset_t
case KEEP:
case MERGE:
opts.update = 1;
/* FIXME: Default should be to remove ignored files */
opts.preserve_ignored = 1;
break;
case HARD:
opts.update = 1;

View File

@ -258,6 +258,9 @@ static int reset_tree(struct object_id *i_tree, int update, int reset)
opts.merge = 1;
opts.reset = reset;
opts.update = update;
if (update && !reset)
/* FIXME: Default should be to remove ignored files */
opts.preserve_ignored = 1;
opts.fn = oneway_merge;
if (unpack_trees(nr_trees, t, &opts))

View File

@ -4045,11 +4045,7 @@ static int checkout(struct merge_options *opt,
unpack_opts.quiet = 0; /* FIXME: sequencer might want quiet? */
unpack_opts.verbose_update = (opt->verbosity > 2);
unpack_opts.fn = twoway_merge;
if (1/* FIXME: opts->overwrite_ignore*/) {
CALLOC_ARRAY(unpack_opts.dir, 1);
unpack_opts.dir->flags |= DIR_SHOW_IGNORED;
setup_standard_excludes(unpack_opts.dir);
}
unpack_opts.preserve_ignored = 0; /* FIXME: !opts->overwrite_ignore*/
parse_tree(prev);
init_tree_desc(&trees[0], prev->buffer, prev->size);
parse_tree(next);
@ -4057,8 +4053,6 @@ static int checkout(struct merge_options *opt,
ret = unpack_trees(2, trees, &unpack_opts);
clear_unpack_trees_porcelain(&unpack_opts);
dir_clear(unpack_opts.dir);
FREE_AND_NULL(unpack_opts.dir);
return ret;
}

View File

@ -411,9 +411,7 @@ static int unpack_trees_start(struct merge_options *opt,
else {
opt->priv->unpack_opts.update = 1;
/* FIXME: should only do this if !overwrite_ignore */
CALLOC_ARRAY(opt->priv->unpack_opts.dir, 1);
opt->priv->unpack_opts.dir->flags |= DIR_SHOW_IGNORED;
setup_standard_excludes(opt->priv->unpack_opts.dir);
opt->priv->unpack_opts.preserve_ignored = 0;
}
opt->priv->unpack_opts.merge = 1;
opt->priv->unpack_opts.head_idx = 2;
@ -428,10 +426,6 @@ static int unpack_trees_start(struct merge_options *opt,
init_tree_desc_from_tree(t+2, merge);
rc = unpack_trees(3, t, &opt->priv->unpack_opts);
if (opt->priv->unpack_opts.dir) {
dir_clear(opt->priv->unpack_opts.dir);
FREE_AND_NULL(opt->priv->unpack_opts.dir);
}
cache_tree_free(&opt->repo->index->cache_tree);
/*

View File

@ -53,7 +53,6 @@ int checkout_fast_forward(struct repository *r,
struct unpack_trees_options opts;
struct tree_desc t[MAX_UNPACK_TREES];
int i, nr_trees = 0;
struct dir_struct dir = DIR_INIT;
struct lock_file lock_file = LOCK_INIT;
refresh_index(r->index, REFRESH_QUIET, NULL, NULL, NULL);
@ -80,11 +79,7 @@ int checkout_fast_forward(struct repository *r,
}
memset(&opts, 0, sizeof(opts));
if (overwrite_ignore) {
dir.flags |= DIR_SHOW_IGNORED;
setup_standard_excludes(&dir);
opts.dir = &dir;
}
opts.preserve_ignored = !overwrite_ignore;
opts.head_idx = 1;
opts.src_index = r->index;
@ -101,7 +96,6 @@ int checkout_fast_forward(struct repository *r,
clear_unpack_trees_porcelain(&opts);
return -1;
}
dir_clear(&dir);
clear_unpack_trees_porcelain(&opts);
if (write_locked_index(r->index, &lock_file, COMMIT_LOCK))

View File

@ -56,6 +56,8 @@ int reset_head(struct repository *r, struct object_id *oid, const char *action,
unpack_tree_opts.fn = reset_hard ? oneway_merge : twoway_merge;
unpack_tree_opts.update = 1;
unpack_tree_opts.merge = 1;
/* FIXME: Default should be to remove ignored files */
unpack_tree_opts.preserve_ignored = 1;
init_checkout_metadata(&unpack_tree_opts.meta, switch_to_branch, oid, NULL);
if (!detach_head)
unpack_tree_opts.reset = 1;

View File

@ -3690,6 +3690,8 @@ static int do_reset(struct repository *r,
unpack_tree_opts.fn = oneway_merge;
unpack_tree_opts.merge = 1;
unpack_tree_opts.update = 1;
/* FIXME: Default should be to remove ignored files */
unpack_tree_opts.preserve_ignored = 1;
init_checkout_metadata(&unpack_tree_opts.meta, name, &oid, NULL);
if (repo_read_index_unmerged(r)) {

View File

@ -1705,6 +1705,12 @@ int unpack_trees(unsigned len, struct tree_desc *t, struct unpack_trees_options
ensure_full_index(o->dst_index);
}
if (!o->preserve_ignored) {
CALLOC_ARRAY(o->dir, 1);
o->dir->flags |= DIR_SHOW_IGNORED;
setup_standard_excludes(o->dir);
}
if (!core_apply_sparse_checkout || !o->update)
o->skip_sparse_checkout = 1;
if (!o->skip_sparse_checkout && !o->pl) {
@ -1866,6 +1872,10 @@ int unpack_trees(unsigned len, struct tree_desc *t, struct unpack_trees_options
done:
if (free_pattern_list)
clear_pattern_list(&pl);
if (o->dir) {
dir_clear(o->dir);
FREE_AND_NULL(o->dir);
}
trace2_region_leave("unpack_trees", "unpack_trees", the_repository);
trace_performance_leave("unpack_trees");
return ret;

View File

@ -49,6 +49,7 @@ struct unpack_trees_options {
unsigned int reset,
merge,
update,
preserve_ignored,
clone,
index_only,
nontrivial_merge,