scalar: add --no-tags option to 'scalar clone'

Some large repositories use tags to track a huge list of release
versions. While this is choice is costly on the ref advertisement, it is
further wasteful for clients who do not need those tags. Allow clients
to optionally skip the tag advertisement.

This behavior is similar to that of 'git clone --no-tags' implemented in
0dab246 (clone: add a --no-tags option to clone without tags,
2017-04-26), including the modification of the remote.origin.tagOpt
config value to include "--no-tags".

One thing that is opposite of the 'git clone' implementation is that
this allows '--tags' as an assumed option, which can be naturally negated
with '--no-tags'. The clone command does not accept '--tags' but allows
"--no-no-tags" as the negation of its '--no-tags' option.

While testing this option, combine the test with the previously untested
'--no-src' option introduced in 4527db8 (scalar: add --[no-]src
option, 2023-08-28).

Signed-off-by: Derrick Stolee <stolee@gmail.com>

Documentation/scalar.txt

@@ -86,6 +86,12 @@ cloning. If the HEAD at the remote did not point at any branch when
  `<entlistment>/src` directory. Use `--no-src` to place the cloned
  repository directly in the `<enlistment>` directory.
 
+--[no-]tags::
+ By default, `scalar clone` will fetch the tag objects advertised by
+ the remote and future `git fetch` commands will do the same. Use
+ `--no-tags` to avoid fetching tags in `scalar clone` and to configure
+ the repository to avoid fetching tags in the future.
+
 --[no-]full-clone::
  A sparse-checkout is initialized by default. This behavior can be
  turned off via `--full-clone`.

scalar.c

@@ -410,7 +410,7 @@ static int cmd_clone(int argc, const char **argv)
 {
  const char *branch = NULL;
  int full_clone = 0, single_branch = 0, show_progress = isatty(2);
- int src = 1;
+ int src = 1, tags = 1;
  struct option clone_options[] = {
  OPT_STRING('b', "branch", &branch, N_("<branch>"),
  N_("branch to checkout after clone")),
@@ -421,11 +421,13 @@ static int cmd_clone(int argc, const char **argv)
  "be checked out")),
  OPT_BOOL(0, "src", &src,
  N_("create repository within 'src' directory")),
+ OPT_BOOL(0, "tags", &tags,
+ N_("specify if tags should be fetched during clone")),
  OPT_END(),
  };
  const char * const clone_usage[] = {
  N_("scalar clone [--single-branch] [--branch <main-branch>] [--full-clone]\n"
- "\t[--[no-]src] <url> [<enlistment>]"),
+ "\t[--[no-]src] [--[no-]tags] <url> [<enlistment>]"),
  NULL
  };
  const char *url;
@@ -504,6 +506,11 @@ static int cmd_clone(int argc, const char **argv)
  goto cleanup;
  }
 
+ if (!tags && set_config("remote.origin.tagOpt=--no-tags")) {
+ res = error(_("could not disable tags in '%s'"), dir);
+ goto cleanup;
+ }
+
  if (!full_clone &&
  (res = run_git("sparse-checkout", "init", "--cone", NULL)))
  goto cleanup;
@@ -513,7 +520,9 @@ static int cmd_clone(int argc, const char **argv)
 
  if ((res = run_git("fetch", "--quiet",
  show_progress ? "--progress" : "--no-progress",
- "origin", NULL))) {
+ "origin",
+ (!tags ? "--no-tags" : NULL),
+ NULL))) {
  warning(_("partial clone failed; attempting full clone"));
 
  if (set_config("remote.origin.promisor") ||

t/t9210-scalar.sh

@@ -169,6 +169,24 @@ test_expect_success 'scalar clone' '
  )
 '
 
+test_expect_success 'scalar clone --no-... opts' '
+ # Note: redirect stderr always to avoid having a verbose test
+ # run result in a difference in the --[no-]progress option.
+ GIT_TRACE2_EVENT="$(pwd)/no-opt-trace" scalar clone \
+ --no-tags --no-src \
+ "file://$(pwd)" no-opts --single-branch 2>/dev/null &&
+
+ test_subcommand git fetch --quiet --no-progress \
+ origin --no-tags <no-opt-trace &&
+ (
+ cd no-opts &&
+
+ test_cmp_config --no-tags remote.origin.tagopt &&
+ git for-each-ref --format="%(refname)" refs/tags/ >tags &&
+ test_line_count = 0 tags
+ )
+'
+
 test_expect_success 'scalar reconfigure' '
  git init one/src &&
  scalar register one &&