scalar reconfigure: improve --maintenance docs
The --maintenance option for 'scalar reconfigure' has three possible values. Improve the documentation by specifying the option in the -h help menu and usage information. Signed-off-by: Derrick Stolee <stolee@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Derrick Stolee committed
May 14, 2025 at 09:52 UTC
e918917360817e7bb58baae2bc166998ffdc8726
2 files changed
+8
-9
Documentation/scalar.adoc
+6
-7
@@ -14,7 +14,7 @@ scalar list
14
scalar register [--[no-]maintenance] [<enlistment>]
15
scalar unregister [<enlistment>]
16
scalar run ( all | config | commit-graph | fetch | loose-objects | pack-files ) [<enlistment>]
17
-scalar reconfigure [--maintenance=<mode>] [ --all | <enlistment> ]
17
+scalar reconfigure [--maintenance=(enable|disable|keep)] [ --all | <enlistment> ]
18
scalar diagnose [<enlistment>]
19
scalar delete <enlistment>
20
@@ -165,14 +165,13 @@ reconfigure the enlistment.
165
registered with Scalar by the `scalar.repo` config key. Use this
166
option after each upgrade to get the latest features.
167
168
---maintenance=<mode>::
168
+--maintenance=(enable|disable|keep)::
169
By default, Scalar configures the enlistment to use Git's
170
background maintenance feature; this is the same as using the
171
- `--maintenance=enable` value for this option. Use the
172
- `--maintenance=disable` to remove each considered enlistment
173
- from background maintenance. Use `--maitnenance=keep' to leave
174
- the background maintenance configuration untouched for These
175
- repositories.
171
+ `enable` value for this option. Use the `disable` value to
172
+ remove each considered enlistment from background maintenance.
173
+ Use `keep' to leave the background maintenance configuration
174
+ untouched for these repositories.
175
176
Diagnose
177
~~~~~~~~
scalar.c
+2
-2
@@ -675,12 +675,12 @@ static int cmd_reconfigure(int argc, const char **argv)
675
OPT_BOOL('a', "all", &all,
676
N_("reconfigure all registered enlistments")),
677
OPT_STRING(0, "maintenance", &maintenance_str,
678
- N_("<mode>"),
678
+ N_("(enable|disable|keep)"),
679
N_("signal how to adjust background maintenance")),
680
OPT_END(),
681
};
682
const char * const usage[] = {
683
- N_("scalar reconfigure [--maintenance=<mode>] [--all | <enlistment>]"),
683
+ N_("scalar reconfigure [--maintenance=(enable|disable|keep)] [--all | <enlistment>]"),
684
NULL
685
};
686
struct string_list scalar_repos = STRING_LIST_INIT_DUP;