Skip to content

Commit e918917

Browse files
derrickstoleegitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent a34fef8 commit e918917

File tree

2 files changed

+8
-9
lines changed

2 files changed

+8
-9
lines changed

Documentation/scalar.adoc

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ scalar list
1414
scalar register [--[no-]maintenance] [<enlistment>]
1515
scalar unregister [<enlistment>]
1616
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> ]
1818
scalar diagnose [<enlistment>]
1919
scalar delete <enlistment>
2020

@@ -165,14 +165,13 @@ reconfigure the enlistment.
165165
registered with Scalar by the `scalar.repo` config key. Use this
166166
option after each upgrade to get the latest features.
167167

168-
--maintenance=<mode>::
168+
--maintenance=(enable|disable|keep)::
169169
By default, Scalar configures the enlistment to use Git's
170170
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.
176175

177176
Diagnose
178177
~~~~~~~~

scalar.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -675,12 +675,12 @@ static int cmd_reconfigure(int argc, const char **argv)
675675
OPT_BOOL('a', "all", &all,
676676
N_("reconfigure all registered enlistments")),
677677
OPT_STRING(0, "maintenance", &maintenance_str,
678-
N_("<mode>"),
678+
N_("(enable|disable|keep)"),
679679
N_("signal how to adjust background maintenance")),
680680
OPT_END(),
681681
};
682682
const char * const usage[] = {
683-
N_("scalar reconfigure [--maintenance=<mode>] [--all | <enlistment>]"),
683+
N_("scalar reconfigure [--maintenance=(enable|disable|keep)] [--all | <enlistment>]"),
684684
NULL
685685
};
686686
struct string_list scalar_repos = STRING_LIST_INIT_DUP;

0 commit comments

Comments
 (0)