Skip to content

Commit ecb939a

Browse files
committed
Merge branch 'ds/doc-maintenance-synopsis-fix'
Doc update. * ds/doc-maintenance-synopsis-fix: maintenance: fix synopsis in documentation
2 parents 7f7d1ad + f4976ef commit ecb939a

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

Documentation/git-maintenance.txt

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ SYNOPSIS
1010
--------
1111
[verse]
1212
'git maintenance' run [<options>]
13+
'git maintenance' start [--scheduler=<scheduler>]
14+
'git maintenance' (stop|register|unregister)
1315

1416

1517
DESCRIPTION
@@ -29,6 +31,24 @@ Git repository.
2931
SUBCOMMANDS
3032
-----------
3133

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+
3252
register::
3353
Initialize Git config values so any scheduled maintenance will
3454
start running on this repository. This adds the repository to the
@@ -55,24 +75,6 @@ task:
5575
setting `maintenance.auto = false` in the current repository. This config
5676
setting will remain after a `git maintenance unregister` command.
5777

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-
7678
unregister::
7779
Remove the current repository from background maintenance. This
7880
only removes the repository from the configured list. It does not

0 commit comments

Comments
 (0)