]> git.ipfire.org Git - thirdparty/git.git/commitdiff
scalar reconfigure: improve --maintenance docs
authorDerrick Stolee <stolee@gmail.com>
Wed, 14 May 2025 13:52:44 +0000 (09:52 -0400)
committerJunio C Hamano <gitster@pobox.com>
Wed, 14 May 2025 19:18:12 +0000 (12:18 -0700)
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>
Documentation/scalar.adoc
scalar.c

index 387527be1ea5bc0d9e4f17309d9c84f5592524c6..4bd5b150e8e1d4561ff48fb000748caeb00f27a8 100644 (file)
@@ -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 847d2dd2f58a1b334bd2d9f2331cdf3e8b856ed8..355baf75e499cb32ae22569378dcd0ad081c9a14 100644 (file)
--- 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;