maintenance: fix synopsis in documentation
The synopsis for 'git maintenance' did not include the commands other than the 'run' command. Update this to include the others. The 'start' command is the only one of these that parses additional options, and then only the --scheduler option. Also move the 'register' command down after 'stop' and before 'unregister' for a logical grouping of the commands instead of an alphabetical one. The diff makes it look as three other commands are moved up. Signed-off-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Derrick Stolee committed
Mar 15, 2022 at 17:41 UTC
f4976ef739adb951b651d7d400758eddae6b194f
1 file changed
+20
-18
Documentation/git-maintenance.txt
+20
-18
@@ -10,6 +10,8 @@ SYNOPSIS
10
--------
11
[verse]
12
'git maintenance' run [<options>]
13
+'git maintenance' start [--scheduler=<scheduler>]
14
+'git maintenance' (stop|register|unregister)
15
16
17
DESCRIPTION
@@ -29,6 +31,24 @@ Git repository.
31
SUBCOMMANDS
32
-----------
33
34
+run::
35
+ Run one or more maintenance tasks. If one or more `--task` options
36
+ are specified, then those tasks are run in that order. Otherwise,
37
+ the tasks are determined by which `maintenance.<task>.enabled`
38
+ config options are true. By default, only `maintenance.gc.enabled`
39
+ is true.
40
+
41
+start::
42
+ Start running maintenance on the current repository. This performs
43
+ the same config updates as the `register` subcommand, then updates
44
+ the background scheduler to run `git maintenance run --scheduled`
45
+ on an hourly basis.
46
+
47
+stop::
48
+ Halt the background maintenance schedule. The current repository
49
+ is not removed from the list of maintained repositories, in case
50
+ the background maintenance is restarted later.
51
+
52
register::
53
Initialize Git config values so any scheduled maintenance will
54
start running on this repository. This adds the repository to the
@@ -55,24 +75,6 @@ task:
75
setting `maintenance.auto = false` in the current repository. This config
76
setting will remain after a `git maintenance unregister` command.
77
58
-run::
59
- Run one or more maintenance tasks. If one or more `--task` options
60
- are specified, then those tasks are run in that order. Otherwise,
61
- the tasks are determined by which `maintenance.<task>.enabled`
62
- config options are true. By default, only `maintenance.gc.enabled`
63
- is true.
64
-
65
-start::
66
- Start running maintenance on the current repository. This performs
67
- the same config updates as the `register` subcommand, then updates
68
- the background scheduler to run `git maintenance run --scheduled`
69
- on an hourly basis.
70
-
71
-stop::
72
- Halt the background maintenance schedule. The current repository
73
- is not removed from the list of maintained repositories, in case
74
- the background maintenance is restarted later.
75
-
78
unregister::
79
Remove the current repository from background maintenance. This
80
only removes the repository from the configured list. It does not