]> git.ipfire.org Git - thirdparty/git.git/commitdiff
scalar: 'register' sets recommended config and starts maintenance
authorDerrick Stolee <dstolee@microsoft.com>
Fri, 3 Dec 2021 13:34:19 +0000 (13:34 +0000)
committerJunio C Hamano <gitster@pobox.com>
Sun, 5 Dec 2021 05:52:23 +0000 (21:52 -0800)
Let's start implementing the `register` command. With this commit,
recommended settings are configured upon `scalar register`, and Git's
background maintenance is started.

The recommended config settings may very well change in the future. For
example, once the built-in FSMonitor is available, we will want to
enable it upon `scalar register`. For that reason, we explicitly support
running `scalar register` in an already-registered enlistment.

Co-authored-by: Victoria Dye <vdye@github.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
contrib/scalar/scalar.c
contrib/scalar/scalar.txt

index 7cff29e0fcd2380192dace238d26c87f99fff4f0..55a304442d48066b41333051c912c5e812a9c085 100644 (file)
 #include "cache.h"
 #include "gettext.h"
 #include "parse-options.h"
+#include "config.h"
+#include "run-command.h"
+
+/*
+ * Remove the deepest subdirectory in the provided path string. Path must not
+ * include a trailing path separator. Returns 1 if parent directory found,
+ * otherwise 0.
+ */
+static int strbuf_parent_directory(struct strbuf *buf)
+{
+       size_t len = buf->len;
+       size_t offset = offset_1st_component(buf->buf);
+       char *path_sep = find_last_dir_sep(buf->buf + offset);
+       strbuf_setlen(buf, path_sep ? path_sep - buf->buf : offset);
+
+       return buf->len < len;
+}
+
+static void setup_enlistment_directory(int argc, const char **argv,
+                                      const char * const *usagestr,
+                                      const struct option *options,
+                                      struct strbuf *enlistment_root)
+{
+       struct strbuf path = STRBUF_INIT;
+       char *root;
+       int enlistment_found = 0;
+
+       if (startup_info->have_repository)
+               BUG("gitdir already set up?!?");
+
+       if (argc > 1)
+               usage_with_options(usagestr, options);
+
+       /* find the worktree, determine its corresponding root */
+       if (argc == 1)
+               strbuf_add_absolute_path(&path, argv[0]);
+       else if (strbuf_getcwd(&path) < 0)
+               die(_("need a working directory"));
+
+       strbuf_trim_trailing_dir_sep(&path);
+       do {
+               const size_t len = path.len;
+
+               /* check if currently in enlistment root with src/ workdir */
+               strbuf_addstr(&path, "/src");
+               if (is_nonbare_repository_dir(&path)) {
+                       if (enlistment_root)
+                               strbuf_add(enlistment_root, path.buf, len);
+
+                       enlistment_found = 1;
+                       break;
+               }
+
+               /* reset to original path */
+               strbuf_setlen(&path, len);
+
+               /* check if currently in workdir */
+               if (is_nonbare_repository_dir(&path)) {
+                       if (enlistment_root) {
+                               /*
+                                * If the worktree's directory's name is `src`, the enlistment is the
+                                * parent directory, otherwise it is identical to the worktree.
+                                */
+                               root = strip_path_suffix(path.buf, "src");
+                               strbuf_addstr(enlistment_root, root ? root : path.buf);
+                               free(root);
+                       }
+
+                       enlistment_found = 1;
+                       break;
+               }
+       } while (strbuf_parent_directory(&path));
+
+       if (!enlistment_found)
+               die(_("could not find enlistment root"));
+
+       if (chdir(path.buf) < 0)
+               die_errno(_("could not switch to '%s'"), path.buf);
+
+       strbuf_release(&path);
+       setup_git_directory();
+}
+
+static int run_git(const char *arg, ...)
+{
+       struct strvec argv = STRVEC_INIT;
+       va_list args;
+       const char *p;
+       int res;
+
+       va_start(args, arg);
+       strvec_push(&argv, arg);
+       while ((p = va_arg(args, const char *)))
+               strvec_push(&argv, p);
+       va_end(args);
+
+       res = run_command_v_opt(argv.v, RUN_GIT_CMD);
+
+       strvec_clear(&argv);
+       return res;
+}
+
+static int set_recommended_config(void)
+{
+       struct {
+               const char *key;
+               const char *value;
+       } config[] = {
+               { "am.keepCR", "true" },
+               { "core.FSCache", "true" },
+               { "core.multiPackIndex", "true" },
+               { "core.preloadIndex", "true" },
+#ifndef WIN32
+               { "core.untrackedCache", "true" },
+#else
+               /*
+                * Unfortunately, Scalar's Functional Tests demonstrated
+                * that the untracked cache feature is unreliable on Windows
+                * (which is a bummer because that platform would benefit the
+                * most from it). For some reason, freshly created files seem
+                * not to update the directory's `lastModified` time
+                * immediately, but the untracked cache would need to rely on
+                * that.
+                *
+                * Therefore, with a sad heart, we disable this very useful
+                * feature on Windows.
+                */
+               { "core.untrackedCache", "false" },
+#endif
+               { "core.logAllRefUpdates", "true" },
+               { "credential.https://dev.azure.com.useHttpPath", "true" },
+               { "credential.validate", "false" }, /* GCM4W-only */
+               { "gc.auto", "0" },
+               { "gui.GCWarning", "false" },
+               { "index.threads", "true" },
+               { "index.version", "4" },
+               { "merge.stat", "false" },
+               { "merge.renames", "true" },
+               { "pack.useBitmaps", "false" },
+               { "pack.useSparse", "true" },
+               { "receive.autoGC", "false" },
+               { "reset.quiet", "true" },
+               { "feature.manyFiles", "false" },
+               { "feature.experimental", "false" },
+               { "fetch.unpackLimit", "1" },
+               { "fetch.writeCommitGraph", "false" },
+#ifdef WIN32
+               { "http.sslBackend", "schannel" },
+#endif
+               { "status.aheadBehind", "false" },
+               { "commitGraph.generationVersion", "1" },
+               { "core.autoCRLF", "false" },
+               { "core.safeCRLF", "false" },
+               { "fetch.showForcedUpdates", "false" },
+               { NULL, NULL },
+       };
+       int i;
+       char *value;
+
+       for (i = 0; config[i].key; i++) {
+               if (git_config_get_string(config[i].key, &value)) {
+                       trace2_data_string("scalar", the_repository, config[i].key, "created");
+                       if (git_config_set_gently(config[i].key,
+                                                 config[i].value) < 0)
+                               return error(_("could not configure %s=%s"),
+                                            config[i].key, config[i].value);
+               } else {
+                       trace2_data_string("scalar", the_repository, config[i].key, "exists");
+                       free(value);
+               }
+       }
+
+       /*
+        * The `log.excludeDecoration` setting is special because it allows
+        * for multiple values.
+        */
+       if (git_config_get_string("log.excludeDecoration", &value)) {
+               trace2_data_string("scalar", the_repository,
+                                  "log.excludeDecoration", "created");
+               if (git_config_set_multivar_gently("log.excludeDecoration",
+                                                  "refs/prefetch/*",
+                                                  CONFIG_REGEX_NONE, 0))
+                       return error(_("could not configure "
+                                      "log.excludeDecoration"));
+       } else {
+               trace2_data_string("scalar", the_repository,
+                                  "log.excludeDecoration", "exists");
+               free(value);
+       }
+
+       return 0;
+}
+
+static int start_maintenance(void)
+{
+       return run_git("maintenance", "start", NULL);
+}
+
+static int add_enlistment(void)
+{
+       int res;
+
+       if (!the_repository->worktree)
+               die(_("Scalar enlistments require a worktree"));
+
+       res = run_git("config", "--global", "--get", "--fixed-value",
+                     "scalar.repo", the_repository->worktree, NULL);
+
+       /*
+        * If the setting is already there, then do nothing.
+        */
+       if (!res)
+               return 0;
+
+       return run_git("config", "--global", "--add",
+                      "scalar.repo", the_repository->worktree, NULL);
+}
+
+static int register_dir(void)
+{
+       int res = add_enlistment();
+
+       if (!res)
+               res = set_recommended_config();
+
+       if (!res)
+               res = start_maintenance();
+
+       return res;
+}
+
+static int cmd_register(int argc, const char **argv)
+{
+       struct option options[] = {
+               OPT_END(),
+       };
+       const char * const usage[] = {
+               N_("scalar register [<enlistment>]"),
+               NULL
+       };
+
+       argc = parse_options(argc, argv, NULL, options,
+                            usage, 0);
+
+       setup_enlistment_directory(argc, argv, usage, options, NULL);
+
+       return register_dir();
+}
 
 static struct {
        const char *name;
        int (*fn)(int, const char **);
 } builtins[] = {
+       { "register", cmd_register },
        { NULL, NULL},
 };
 
index 5f7131861a59b645619925ee21dae7dbddeee3ef..568987064b228644ce146bb1b9ec1261f04009f7 100644 (file)
@@ -8,7 +8,7 @@ scalar - an opinionated repository management tool
 SYNOPSIS
 --------
 [verse]
-scalar <command> [<options>]
+scalar register [<enlistment>]
 
 DESCRIPTION
 -----------
@@ -29,6 +29,22 @@ will be identical to the worktree.
 The `scalar` command implements various subcommands, and different options
 depending on the subcommand.
 
+COMMANDS
+--------
+
+Register
+~~~~~~~~
+
+register [<enlistment>]::
+       Adds the enlistment's repository to the list of registered repositories
+       and starts background maintenance. If `<enlistment>` is not provided,
+       then the enlistment associated with the current working directory is
+       registered.
++
+Note: when this subcommand is called in a worktree that is called `src/`, its
+parent directory is considered to be the Scalar enlistment. If the worktree is
+_not_ called `src/`, it itself will be considered to be the Scalar enlistment.
+
 SEE ALSO
 --------
 linkgit:git-maintenance[1].