setup: stop using `the_repository` in `setup_work_tree()`

Stop using `the_repository` in `setup_work_tree()` and instead accept
the repository as a parameter. The injection of `the_repository` is thus
bumped one level higher, where callers now pass it in explicitly.

Note that the function tracks two bits of information via global
variables. This of course doesn't make much sense anymore now that we
can set up worktrees for arbitrary repositories:

  - We track whether the worktree has already been initialized and, if
    so, we skip the call to `chdir_notify()` and setenv(3p). It does not
    make much sense to store this info in the repository, as we _would_
    want to update the environment when switching between worktrees back
    and forth.

    So instead of storing this info in the repository, we drop this
    state entirely and live with the fact that we may execute the logic
    twice. It should ultimately be idempotent though and thus not be
    much of a problem.

  - We track whether the worktree configuration is bogus. If so, and if
    later on some caller tries to setup the worktree, then we'll die
    instead. This is indeed information that we can move into the
    repository itself.

Signed-off-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/blame.c b/blame.c
index a3c49d1..977cbb7 100644 (file)
--- a/blame.c
+++ b/blame.c
@@ -2813,7 +2813,7 @@ void setup_scoreboard(struct blame_scoreboard *sb,
                }
 
                if (!sb->contents_from)
-                       setup_work_tree();
+                       setup_work_tree(the_repository);
 
                sb->final = fake_working_tree_commit(sb->repo,
                                                     &sb->revs->diffopt,

diff --git a/builtin/check-attr.c b/builtin/check-attr.c
index 04b86e4..98f64d5 100644 (file)
--- a/builtin/check-attr.c
+++ b/builtin/check-attr.c
@@ -117,7 +117,7 @@ int cmd_check_attr(int argc,
        int cnt, i, doubledash, filei;
 
        if (!is_bare_repository())
-               setup_work_tree();
+               setup_work_tree(the_repository);
 
        repo_config(the_repository, git_default_config, NULL);
 

diff --git a/builtin/clone.c b/builtin/clone.c
index d23b0ca..09f6d97 100644 (file)
--- a/builtin/clone.c
+++ b/builtin/clone.c
@@ -669,7 +669,7 @@ static int checkout(int submodule_progress,
        }
 
        /* We need to be in the new work tree for the checkout */
-       setup_work_tree();
+       setup_work_tree(the_repository);
 
        repo_hold_locked_index(the_repository, &lock_file, LOCK_DIE_ON_ERROR);
 

diff --git a/builtin/describe.c b/builtin/describe.c
index bffeed1..1c47d7c 100644 (file)
--- a/builtin/describe.c
+++ b/builtin/describe.c
@@ -781,7 +781,7 @@ int cmd_describe(int argc,
                        struct rev_info revs;
                        int fd;
 
-                       setup_work_tree();
+                       setup_work_tree(the_repository);
                        prepare_repo_settings(the_repository);
                        the_repository->settings.command_requires_full_index = 0;
                        repo_read_index(the_repository);

diff --git a/builtin/diff-index.c b/builtin/diff-index.c
index 522dacf..3db7cff 100644 (file)
--- a/builtin/diff-index.c
+++ b/builtin/diff-index.c
@@ -69,7 +69,7 @@ int cmd_diff_index(int argc,
            rev.max_count != -1 || rev.min_age != -1 || rev.max_age != -1)
                usage(diff_cache_usage);
        if (!(option & DIFF_INDEX_CACHED)) {
-               setup_work_tree();
+               setup_work_tree(the_repository);
                if (repo_read_index_preload(the_repository, &rev.diffopt.pathspec, 0) < 0) {
                        perror("repo_read_index_preload");
                        return -1;

diff --git a/builtin/diff.c b/builtin/diff.c
index 7ddebce..1ede873 100644 (file)
--- a/builtin/diff.c
+++ b/builtin/diff.c
@@ -159,7 +159,7 @@ static void builtin_diff_index(struct rev_info *revs,
            revs->max_age != -1)
                usage(builtin_diff_usage);
        if (!(option & DIFF_INDEX_CACHED)) {
-               setup_work_tree();
+               setup_work_tree(the_repository);
                if (repo_read_index_preload(the_repository,
                                            &revs->diffopt.pathspec, 0) < 0) {
                        die_errno("repo_read_index_preload");
@@ -281,7 +281,7 @@ static void builtin_diff_files(struct rev_info *revs, int argc, const char **arg
            (revs->diffopt.output_format & DIFF_FORMAT_PATCH))
                diff_merges_set_dense_combined_if_unset(revs);
 
-       setup_work_tree();
+       setup_work_tree(the_repository);
        if (repo_read_index_preload(the_repository, &revs->diffopt.pathspec,
                                    0) < 0) {
                die_errno("repo_read_index_preload");

diff --git a/builtin/difftool.c b/builtin/difftool.c
index e4bc1f8..2a21005 100644 (file)
--- a/builtin/difftool.c
+++ b/builtin/difftool.c
@@ -767,7 +767,7 @@ int cmd_difftool(int argc,
                die(_("difftool requires worktree or --no-index"));
 
        if (!no_index){
-               setup_work_tree();
+               setup_work_tree(repo);
                setenv(GIT_DIR_ENVIRONMENT, absolute_path(repo_get_git_dir(repo)), 1);
                setenv(GIT_WORK_TREE_ENVIRONMENT, absolute_path(repo_get_work_tree(repo)), 1);
        } else if (dir_diff)

diff --git a/builtin/grep.c b/builtin/grep.c
index 4ec0c01..679f8b5 100644 (file)
--- a/builtin/grep.c
+++ b/builtin/grep.c
@@ -1272,7 +1272,7 @@ int cmd_grep(int argc,
                die(_("--[no-]exclude-standard cannot be used for tracked contents"));
        } else if (!list.nr) {
                if (!cached)
-                       setup_work_tree();
+                       setup_work_tree(the_repository);
 
                hit = grep_cache(&opt, &pathspec, cached);
        } else {

diff --git a/builtin/ls-files.c b/builtin/ls-files.c
index 09d9511..e1a22b4 100644 (file)
--- a/builtin/ls-files.c
+++ b/builtin/ls-files.c
@@ -704,7 +704,7 @@ int cmd_ls_files(int argc,
                exc_given = 1;
 
        if (require_work_tree && !is_inside_work_tree(repo))
-               setup_work_tree();
+               setup_work_tree(repo);
 
        if (recurse_submodules &&
            (show_deleted || show_others || show_unmerged ||

diff --git a/builtin/read-tree.c b/builtin/read-tree.c
index 460b21e..999a82e 100644 (file)
--- a/builtin/read-tree.c
+++ b/builtin/read-tree.c
@@ -229,7 +229,7 @@ int cmd_read_tree(int argc,
                opts.preserve_ignored = 0;
        /* otherwise, opts.preserve_ignored is irrelevant */
        if (opts.merge && !opts.index_only)
-               setup_work_tree();
+               setup_work_tree(the_repository);
 
        if (opts.skip_sparse_checkout)
                ensure_full_index(the_repository->index);

diff --git a/builtin/reset.c b/builtin/reset.c
index 11f5760..3be6bd0 100644 (file)
--- a/builtin/reset.c
+++ b/builtin/reset.c
@@ -468,7 +468,7 @@ int cmd_reset(int argc,
                trace2_cmd_mode(reset_type_names[reset_type]);
 
        if (reset_type != SOFT && (reset_type != MIXED || repo_get_work_tree(the_repository)))
-               setup_work_tree();
+               setup_work_tree(the_repository);
 
        if (reset_type == MIXED && is_bare_repository())
                die(_("%s reset is not allowed in a bare repository"),

diff --git a/builtin/rm.c b/builtin/rm.c
index 05d89e9..081d0bc 100644 (file)
--- a/builtin/rm.c
+++ b/builtin/rm.c
@@ -296,7 +296,7 @@ int cmd_rm(int argc,
                die(_("No pathspec was given. Which files should I remove?"));
 
        if (!index_only)
-               setup_work_tree();
+               setup_work_tree(the_repository);
 
        prepare_repo_settings(the_repository);
        the_repository->settings.command_requires_full_index = 0;

diff --git a/builtin/sparse-checkout.c b/builtin/sparse-checkout.c
index 2af50fb..d89acbe 100644 (file)
--- a/builtin/sparse-checkout.c
+++ b/builtin/sparse-checkout.c
@@ -63,7 +63,7 @@ static int sparse_checkout_list(int argc, const char **argv, const char *prefix,
        int res;
        struct repo_config_values *cfg = repo_config_values(the_repository);
 
-       setup_work_tree();
+       setup_work_tree(the_repository);
        if (!cfg->apply_sparse_checkout)
                die(_("this worktree is not sparse"));
 
@@ -229,7 +229,7 @@ static int update_working_directory(struct repository *r,
        o.dst_index = r->index;
        o.skip_sparse_checkout = 0;
 
-       setup_work_tree();
+       setup_work_tree(the_repository);
 
        repo_hold_locked_index(r, &lock_file, LOCK_DIE_ON_ERROR);
 
@@ -468,7 +468,7 @@ static int sparse_checkout_init(int argc, const char **argv, const char *prefix,
                OPT_END(),
        };
 
-       setup_work_tree();
+       setup_work_tree(the_repository);
        repo_read_index(repo);
 
        init_opts.cone_mode = -1;
@@ -802,7 +802,7 @@ static int sparse_checkout_add(int argc, const char **argv, const char *prefix,
        int ret;
        struct repo_config_values *cfg = repo_config_values(the_repository);
 
-       setup_work_tree();
+       setup_work_tree(the_repository);
        if (!cfg->apply_sparse_checkout)
                die(_("no sparse-checkout to add to"));
 
@@ -856,7 +856,7 @@ static int sparse_checkout_set(int argc, const char **argv, const char *prefix,
        struct strvec patterns = STRVEC_INIT;
        int ret;
 
-       setup_work_tree();
+       setup_work_tree(the_repository);
        repo_read_index(repo);
 
        set_opts.cone_mode = -1;
@@ -912,7 +912,7 @@ static int sparse_checkout_reapply(int argc, const char **argv,
        };
        struct repo_config_values *cfg = repo_config_values(the_repository);
 
-       setup_work_tree();
+       setup_work_tree(the_repository);
        if (!cfg->apply_sparse_checkout)
                die(_("must be in a sparse-checkout to reapply sparsity patterns"));
 
@@ -975,7 +975,7 @@ static int sparse_checkout_clean(int argc, const char **argv,
                OPT_END(),
        };
 
-       setup_work_tree();
+       setup_work_tree(the_repository);
        if (!cfg->apply_sparse_checkout)
                die(_("must be in a sparse-checkout to clean directories"));
        if (!core_sparse_checkout_cone)
@@ -1053,7 +1053,7 @@ static int sparse_checkout_disable(int argc, const char **argv,
         * forcibly return to a dense checkout regardless of initial state.
         */
 
-       setup_work_tree();
+       setup_work_tree(the_repository);
        argc = parse_options(argc, argv, prefix,
                             builtin_sparse_checkout_disable_options,
                             builtin_sparse_checkout_disable_usage, 0);

diff --git a/builtin/submodule--helper.c b/builtin/submodule--helper.c
index 2f589e3..1cc82a1 100644 (file)
--- a/builtin/submodule--helper.c
+++ b/builtin/submodule--helper.c
@@ -1250,7 +1250,7 @@ static int compute_summary_module_list(struct object_id *head_oid,
 
        if (!info->cached) {
                if (diff_cmd == DIFF_INDEX)
-                       setup_work_tree();
+                       setup_work_tree(the_repository);
                if (repo_read_index_preload(the_repository, &rev.diffopt.pathspec, 0) < 0) {
                        perror("repo_read_index_preload");
                        ret = -1;

diff --git a/builtin/update-index.c b/builtin/update-index.c
index 7434112..d6dabac 100644 (file)
--- a/builtin/update-index.c
+++ b/builtin/update-index.c
@@ -732,7 +732,7 @@ struct refresh_params {
 
 static int refresh(struct refresh_params *o, unsigned int flag)
 {
-       setup_work_tree();
+       setup_work_tree(the_repository);
        repo_read_index(the_repository);
        *o->has_errors |= refresh_index(the_repository->index, o->flags | flag, NULL,
                                        NULL, NULL);
@@ -901,7 +901,7 @@ static enum parse_opt_result reupdate_callback(
        BUG_ON_OPT_ARG(arg);
 
        /* consume remaining arguments. */
-       setup_work_tree();
+       setup_work_tree(the_repository);
        *has_errors = do_reupdate(ctx->argv + 1, prefix);
        if (*has_errors)
                the_repository->index->cache_changed = 0;
@@ -1157,7 +1157,7 @@ int cmd_update_index(int argc,
                                transaction = NULL;
                        }
 
-                       setup_work_tree();
+                       setup_work_tree(the_repository);
                        p = prefix_path(the_repository, prefix, prefix_length, path);
                        update_one(p);
                        if (set_executable_bit)
@@ -1199,7 +1199,7 @@ int cmd_update_index(int argc,
                struct strbuf buf = STRBUF_INIT;
                struct strbuf unquoted = STRBUF_INIT;
 
-               setup_work_tree();
+               setup_work_tree(the_repository);
                while (getline_fn(&buf, stdin) != EOF) {
                        char *p;
                        if (!nul_term_line && buf.buf[0] == '"') {
@@ -1253,7 +1253,7 @@ int cmd_update_index(int argc,
                report(_("Untracked cache disabled"));
                break;
        case UC_TEST:
-               setup_work_tree();
+               setup_work_tree(the_repository);
                return !test_if_untracked_cache_is_supported();
        case UC_ENABLE:
        case UC_FORCE:

diff --git a/git.c b/git.c
index 5a40eab..eaede42 100644 (file)
--- a/git.c
+++ b/git.c
@@ -497,7 +497,7 @@ static int run_builtin(struct cmd_struct *p, int argc, const char **argv, struct
        commit_pager_choice();
 
        if (!help && p->option & NEED_WORK_TREE)
-               setup_work_tree();
+               setup_work_tree(the_repository);
 
        trace_argv_printf(argv, "trace: built-in: git");
        trace2_cmd_name(p->cmd);

diff --git a/repository.h b/repository.h
index 4969d8b..832451f 100644 (file)
--- a/repository.h
+++ b/repository.h
@@ -114,6 +114,7 @@ struct repository {
         * A NULL value indicates that there is no working directory.
         */
        char *worktree;
+       bool worktree_config_is_bogus;
 
        /*
         * Path from the root of the top-level superproject down to this

diff --git a/setup.c b/setup.c
index cb479cd..50324f8 100644 (file)
--- a/setup.c
+++ b/setup.c
@@ -26,7 +26,6 @@
 #include "trace2.h"
 #include "worktree.h"
 
-static int work_tree_config_is_bogus;
 enum allowed_bare_repo {
        ALLOWED_BARE_REPO_EXPLICIT = 0,
        ALLOWED_BARE_REPO_ALL,
@@ -494,18 +493,14 @@ int is_inside_work_tree(struct repository *repo)
        return ret;
 }
 
-void setup_work_tree(void)
+void setup_work_tree(struct repository *repo)
 {
        const char *work_tree;
-       static int initialized = 0;
 
-       if (initialized)
-               return;
-
-       if (work_tree_config_is_bogus)
+       if (repo->worktree_config_is_bogus)
                die(_("unable to set up work tree using invalid config"));
 
-       work_tree = repo_get_work_tree(the_repository);
+       work_tree = repo_get_work_tree(repo);
        if (!work_tree || chdir_notify(work_tree))
                die(_("this operation must be run in a work tree"));
 
@@ -515,8 +510,6 @@ void setup_work_tree(void)
         */
        if (getenv(GIT_WORK_TREE_ENVIRONMENT))
                setenv(GIT_WORK_TREE_ENVIRONMENT, ".", 1);
-
-       initialized = 1;
 }
 
 static void setup_original_cwd(struct repository *repo)
@@ -1164,7 +1157,7 @@ static const char *setup_explicit_git_dir(struct repository *repo,
                if (git_work_tree_cfg) {
                        /* #22.2, #30 */
                        warning("core.bare and core.worktree do not make sense");
-                       work_tree_config_is_bogus = 1;
+                       repo->worktree_config_is_bogus = true;
                }
 
                /* #18, #26 */

diff --git a/setup.h b/setup.h
index d0cfdfd..8fed365 100644 (file)
--- a/setup.h
+++ b/setup.h
@@ -56,7 +56,7 @@ const char *resolve_gitdir_gently(const char *suspect, int *return_error_code);
 void die_upon_dubious_ownership(const char *gitfile, const char *worktree,
                                const char *gitdir);
 
-void setup_work_tree(void);
+void setup_work_tree(struct repository *repo);
 
 /*
  * discover_git_directory_reason() is similar to discover_git_directory(),

diff --git a/t/helper/test-subprocess.c b/t/helper/test-subprocess.c
index c344f16..8a070e4 100644 (file)
--- a/t/helper/test-subprocess.c
+++ b/t/helper/test-subprocess.c
@@ -1,3 +1,5 @@
+#define USE_THE_REPOSITORY_VARIABLE
+
 #include "test-tool.h"
 #include "run-command.h"
 #include "setup.h"
@@ -11,7 +13,7 @@ int cmd__subprocess(int argc, const char **argv)
        if (nogit)
                die("No git repo found");
        if (argc > 1 && !strcmp(argv[1], "--setup-work-tree")) {
-               setup_work_tree();
+               setup_work_tree(the_repository);
                argv++;
        }
        cp.git_cmd = 1;

diff --git a/wt-status.c b/wt-status.c
index c12fca7..b173723 100644 (file)
--- a/wt-status.c
+++ b/wt-status.c
@@ -1206,7 +1206,7 @@ static void wt_longstatus_print_verbose(struct wt_status *s)
                status_printf_ln(s, c,
                        "--------------------------------------------------");
                status_printf_ln(s, c, _("Changes not staged for commit:"));
-               setup_work_tree();
+               setup_work_tree(the_repository);
                rev.diffopt.a_prefix = "i/";
                rev.diffopt.b_prefix = "w/";
                run_diff_files(&rev, 0);