undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'ds/doc-maintenance-synopsis-fix'

Browse Source 
Doc update.

* ds/doc-maintenance-synopsis-fix:
  maintenance: fix synopsis in documentation
This commit is contained in:
Junio C Hamano 2022-03-23 14:09:30 -07:00
commit ecb939a9ce
1 changed files with 20 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
Documentation/git-maintenance.txt
View File

@ -10,6 +10,8 @@ SYNOPSIS
-------- --------
[verse] [verse]
'git maintenance' run [<options>] 'git maintenance' run [<options>]
'git maintenance' start [--scheduler=<scheduler>]
'git maintenance' (stop|register|unregister)
DESCRIPTION DESCRIPTION
@ -29,6 +31,24 @@ Git repository.
SUBCOMMANDS SUBCOMMANDS
----------- -----------
run::
Run one or more maintenance tasks. If one or more `--task` options
are specified, then those tasks are run in that order. Otherwise,
the tasks are determined by which `maintenance.<task>.enabled`
config options are true. By default, only `maintenance.gc.enabled`
is true.
start::
Start running maintenance on the current repository. This performs
the same config updates as the `register` subcommand, then updates
the background scheduler to run `git maintenance run --scheduled`
on an hourly basis.
stop::
Halt the background maintenance schedule. The current repository
is not removed from the list of maintained repositories, in case
the background maintenance is restarted later.
register:: register::
Initialize Git config values so any scheduled maintenance will Initialize Git config values so any scheduled maintenance will
start running on this repository. This adds the repository to the start running on this repository. This adds the repository to the
@ -55,24 +75,6 @@ task:
setting `maintenance.auto = false` in the current repository. This config setting `maintenance.auto = false` in the current repository. This config
setting will remain after a `git maintenance unregister` command. setting will remain after a `git maintenance unregister` command.
run::
Run one or more maintenance tasks. If one or more `--task` options
are specified, then those tasks are run in that order. Otherwise,
the tasks are determined by which `maintenance.<task>.enabled`
config options are true. By default, only `maintenance.gc.enabled`
is true.
start::
Start running maintenance on the current repository. This performs
the same config updates as the `register` subcommand, then updates
the background scheduler to run `git maintenance run --scheduled`
on an hourly basis.
stop::
Halt the background maintenance schedule. The current repository
is not removed from the list of maintained repositories, in case
the background maintenance is restarted later.
unregister:: unregister::
Remove the current repository from background maintenance. This Remove the current repository from background maintenance. This
only removes the repository from the configured list. It does not only removes the repository from the configured list. It does not