scalar: customize register_dir()'s behavior

In advance of adding a --[no-]maintenance option to several 'scalar'
subcommands, extend the register_dir() method to include an option for
how it should handle background maintenance.

It's important that we understand the context of toggle_maintenance()
that will enable _or disable_ maintenance depending on its input value.
Add a doc comment with this information.

Similarly, update register_dir() to either enable maintenance or leave
it alone.

Signed-off-by: Derrick Stolee <stolee@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Derrick Stolee
2025-05-07 01:50:34 +00:00
committed by Junio C Hamano
parent 6c0bd1fc70
commit c428216d4d

View File

@@ -209,6 +209,12 @@ static int set_recommended_config(int reconfigure)
return 0; return 0;
} }
/**
* Enable or disable the maintenance mode for the current repository:
*
* * If 'enable' is nonzero, run 'git maintenance start'.
* * If 'enable' is zero, run 'git maintenance unregister --force'.
*/
static int toggle_maintenance(int enable) static int toggle_maintenance(int enable)
{ {
return run_git("maintenance", return run_git("maintenance",
@@ -259,7 +265,15 @@ static int stop_fsmonitor_daemon(void)
return 0; return 0;
} }
static int register_dir(void) /**
* Register the current directory as a Scalar enlistment, and set the
* recommended configuration.
*
* * If 'maintenance' is non-zero, then enable background maintenance.
* * If 'maintenance' is zero, then leave background maintenance as it is
* currently configured.
*/
static int register_dir(int maintenance)
{ {
if (add_or_remove_enlistment(1)) if (add_or_remove_enlistment(1))
return error(_("could not add enlistment")); return error(_("could not add enlistment"));
@@ -267,8 +281,9 @@ static int register_dir(void)
if (set_recommended_config(0)) if (set_recommended_config(0))
return error(_("could not set recommended config")); return error(_("could not set recommended config"));
if (toggle_maintenance(1)) if (maintenance &&
warning(_("could not turn on maintenance")); toggle_maintenance(maintenance))
warning(_("could not toggle maintenance"));
if (have_fsmonitor_support() && start_fsmonitor_daemon()) { if (have_fsmonitor_support() && start_fsmonitor_daemon()) {
return error(_("could not start the FSMonitor daemon")); return error(_("could not start the FSMonitor daemon"));
@@ -550,7 +565,7 @@ static int cmd_clone(int argc, const char **argv)
if (res) if (res)
goto cleanup; goto cleanup;
res = register_dir(); res = register_dir(1);
cleanup: cleanup:
free(branch_to_free); free(branch_to_free);
@@ -610,7 +625,7 @@ static int cmd_register(int argc, const char **argv)
setup_enlistment_directory(argc, argv, usage, options, NULL); setup_enlistment_directory(argc, argv, usage, options, NULL);
return register_dir(); return register_dir(1);
} }
static int get_scalar_repos(const char *key, const char *value, static int get_scalar_repos(const char *key, const char *value,
@@ -803,13 +818,13 @@ static int cmd_run(int argc, const char **argv)
strbuf_release(&buf); strbuf_release(&buf);
if (i == 0) if (i == 0)
return register_dir(); return register_dir(1);
if (i > 0) if (i > 0)
return run_git("maintenance", "run", return run_git("maintenance", "run",
"--task", tasks[i].task, NULL); "--task", tasks[i].task, NULL);
if (register_dir()) if (register_dir(1))
return -1; return -1;
for (i = 1; tasks[i].arg; i++) for (i = 1; tasks[i].arg; i++)
if (run_git("maintenance", "run", if (run_git("maintenance", "run",