setup: unify setup of shallow file

It is possible to configure an arbitrary "shallow" file via two
mechanisms, and the respective logic to handle these is split across two
locations:

  - Via the "GIT_SHALLOW_FILE" environment variable, which is handled in
    `setup_git_env_internal()`.

  - Via the global "--shallow-file=" command line option, which is
    handled in `handle_options()`.

We can rather easily unify this logic by not configuring the shallow
file in `handle_options()`, but instead overwriting the environment
variable. The environment variable itself is then handled inside of
`apply_repository_format()`, which is responsible for configuring a
discovered Git directory.

This new logic is similar in nature to how we handle the other global
options already, all of which end up setting an environment variable.
So for one this gives us more consistency. But more importantly, this
change means that `the_repository` will not contain any relevant state
anymore before we hit `apply_repository_format()` once we're at the end
of this patch series. Consequently, it will become possible for us to
completely discard `the_repository` and populate it anew.

Note that on first sight, this change looks like it might change the
precedence order. Before this change, we used to configure the shallow
file in the arguments handler first, and then it looks like we override
it via the environment variable. What's important to note though is the
last parameter to `set_alternate_shallow_file()`, which tells us whether
we want to overwrite a preexisting value, and when applying the value
from the environment we tell it not to overwrite preexisting values. So
in effect, the command line has precedence over the environment. After
this change, we now overwrite preexisting environment variables when we
see the argument, and consequently we keep the precedence order in tact.

With this change though we don't need the final parameter anymore that
tells `set_alternate_shallow_file()` whether or not to overwrite. We
only have a single callsite for this function now, and that function is
itself only ever called exactly once. Remove that parameter.

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

diff --git a/git.c b/git.c
index 387eabe38c19516fc1a94bc3b92cb26661c5e02c..e5f1811b6bb7622e0ca9fc2445f9d44caa9c84cf 100644 (file)
--- a/git.c
+++ b/git.c
@@ -306,7 +306,7 @@ static int handle_options(const char ***argv, int *argc, int *envchanged)
                } else if (!strcmp(cmd, "--shallow-file")) {
                        (*argv)++;
                        (*argc)--;
-                       set_alternate_shallow_file(the_repository, (*argv)[0], 1);
+                       setenv(GIT_SHALLOW_FILE_ENVIRONMENT, (*argv)[0], 1);
                        if (envchanged)
                                *envchanged = 1;
                } else if (!strcmp(cmd, "-C")) {

diff --git a/setup.c b/setup.c
index 1d8c193375c4d8caf266a01515256a68bc0773c1..85fad0d77d10b1ce2fd08d475cfae29d081225ee 100644 (file)
--- a/setup.c
+++ b/setup.c
@@ -1046,7 +1046,6 @@ static void setup_git_env_internal(struct repository *repo,
                                   const char *git_dir)
 {
        char *git_replace_ref_base;
-       const char *shallow_file;
        const char *replace_ref_base;
        struct set_gitdir_args args = { NULL };
        struct strvec to_free = STRVEC_INIT;
@@ -1067,10 +1066,6 @@ static void setup_git_env_internal(struct repository *repo,
                                                          : "refs/replace/");
        update_ref_namespace(NAMESPACE_REPLACE, git_replace_ref_base);
 
-       shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
-       if (shallow_file)
-               set_alternate_shallow_file(repo, shallow_file, 0);
-
        if (git_env_bool(NO_LAZY_FETCH_ENVIRONMENT, 0))
                fetch_if_missing = 0;
 }
@@ -1774,8 +1769,13 @@ int apply_repository_format(struct repository *repo,
        }
 
        if (flags & APPLY_REPOSITORY_FORMAT_HONOR_ENV) {
+               const char *shallow_file;
+
                object_directory = xstrdup_or_null(getenv(DB_ENVIRONMENT));
                alternate_object_directories = xstrdup_or_null(getenv(ALTERNATE_DB_ENVIRONMENT));
+               shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
+               if (shallow_file)
+                       set_alternate_shallow_file(repo, shallow_file);
        }
 
        repo->bare_cfg = format->is_bare;

diff --git a/shallow.c b/shallow.c
index 07cae44ae52a042ce17c87e82e8a2f80e387e94d..c063b3deaf67a558f551aad166668a6a00ac1bef 100644 (file)
--- a/shallow.c
+++ b/shallow.c
@@ -21,12 +21,10 @@
 #include "statinfo.h"
 #include "trace.h"
 
-void set_alternate_shallow_file(struct repository *r, const char *path, int override)
+void set_alternate_shallow_file(struct repository *r, const char *path)
 {
        if (r->parsed_objects->is_shallow != -1)
                BUG("is_repository_shallow must not be called before set_alternate_shallow_file");
-       if (r->parsed_objects->alternate_shallow_file && !override)
-               return;
        free(r->parsed_objects->alternate_shallow_file);
        r->parsed_objects->alternate_shallow_file = xstrdup_or_null(path);
 }

diff --git a/shallow.h b/shallow.h
index e20ca4c21ba6d7834d3bb395b91c7f49241221af..6a64db42c93341cfd2b1e73e81b730d882b3e70d 100644 (file)
--- a/shallow.h
+++ b/shallow.h
@@ -10,7 +10,7 @@
 struct oid_array;
 struct strvec;
 
-void set_alternate_shallow_file(struct repository *r, const char *path, int override);
+void set_alternate_shallow_file(struct repository *r, const char *path);
 int register_shallow(struct repository *r, const struct object_id *oid);
 int unregister_shallow(const struct object_id *oid);
 int is_repository_shallow(struct repository *r);