scalar reconfigure: improve --maintenance docs

index 387527be1e..4bd5b150e8 100644 --- a/Documentation/scalar.adoc +++ b/Documentation/scalar.adoc @@ -14,7 +14,7 @@ scalar list scalar register [--[no-]maintenance] [<enlistment>] scalar unregister [<enlistment>] scalar run ( all | config | commit-graph | fetch | loose-objects | pack-files ) [<enlistment>] -scalar reconfigure [--maintenance=<mode>] [ --all | <enlistment> ] +scalar reconfigure [--maintenance=(enable|disable|keep)] [ --all | <enlistment> ] scalar diagnose [<enlistment>] scalar delete <enlistment> @@ -165,14 +165,13 @@ reconfigure the enlistment. registered with Scalar by the `scalar.repo` config key. Use this option after each upgrade to get the latest features. ---maintenance=<mode>:: +--maintenance=(enable|disable|keep):: By default, Scalar configures the enlistment to use Git's background maintenance feature; this is the same as using the - `--maintenance=enable` value for this option. Use the - `--maintenance=disable` to remove each considered enlistment - from background maintenance. Use `--maitnenance=keep' to leave - the background maintenance configuration untouched for These - repositories. + `enable` value for this option. Use the `disable` value to + remove each considered enlistment from background maintenance. + Use `keep' to leave the background maintenance configuration + untouched for these repositories. Diagnose ~~~~~~~~

index 847d2dd2f5..355baf75e4 100644 --- a/scalar.c +++ b/scalar.c @@ -675,12 +675,12 @@ static int cmd_reconfigure(int argc, const char **argv) OPT_BOOL('a', "all", &all, N_("reconfigure all registered enlistments")), OPT_STRING(0, "maintenance", &maintenance_str, - N_("<mode>"), + N_("(enable|disable|keep)"), N_("signal how to adjust background maintenance")), OPT_END(), }; const char * const usage[] = { - N_("scalar reconfigure [--maintenance=<mode>] [--all | <enlistment>]"), + N_("scalar reconfigure [--maintenance=(enable|disable|keep)] [--all | <enlistment>]"), NULL }; struct string_list scalar_repos = STRING_LIST_INIT_DUP;