Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'ds/maintenance' into seen
A "git gc"'s big brother has been introduced to take care of more repository maintenance tasks, not limited to the object database cleaning. * ds/maintenance: maintenance: add trace2 regions for task execution maintenance: add auto condition for commit-graph task maintenance: use pointers to check --auto maintenance: create maintenance.<task>.enabled config maintenance: take a lock on the objects directory maintenance: add --task option maintenance: add commit-graph task maintenance: initialize task array maintenance: replace run_auto_gc() maintenance: add --quiet option maintenance: create basic maintenance runner
- Loading branch information
Showing
23 changed files
with
584 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
maintenance.<task>.enabled:: | ||
This boolean config option controls whether the maintenance task | ||
with name `<task>` is run when no `--task` option is specified. | ||
By default, only `maintenance.gc.enabled` is true. | ||
|
||
maintenance.commit-graph.auto:: | ||
This integer config option controls how often the `commit-graph` task | ||
should be run as part of `git maintenance run --auto`. If zero, then | ||
the `commit-graph` task will not run with the `--auto` option. A | ||
negative value will force the task to run every time. Otherwise, a | ||
positive value implies the command should run when the number of | ||
reachable commits that are not in the commit-graph file is at least | ||
the value of `maintenance.commit-graph.auto`. The default value is | ||
100. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
git-maintenance(1) | ||
================== | ||
|
||
NAME | ||
---- | ||
git-maintenance - Run tasks to optimize Git repository data | ||
|
||
|
||
SYNOPSIS | ||
-------- | ||
[verse] | ||
'git maintenance' run [<options>] | ||
|
||
|
||
DESCRIPTION | ||
----------- | ||
Run tasks to optimize Git repository data, speeding up other Git commands | ||
and reducing storage requirements for the repository. | ||
+ | ||
Git commands that add repository data, such as `git add` or `git fetch`, | ||
are optimized for a responsive user experience. These commands do not take | ||
time to optimize the Git data, since such optimizations scale with the full | ||
size of the repository while these user commands each perform a relatively | ||
small action. | ||
+ | ||
The `git maintenance` command provides flexibility for how to optimize the | ||
Git repository. | ||
|
||
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. | ||
|
||
TASKS | ||
----- | ||
|
||
commit-graph:: | ||
The `commit-graph` job updates the `commit-graph` files incrementally, | ||
then verifies that the written data is correct. If the new layer has an | ||
issue, then the chain file is removed and the `commit-graph` is | ||
rewritten from scratch. | ||
+ | ||
The verification only checks the top layer of the `commit-graph` chain. | ||
If the incremental write merged the new commits with at least one | ||
existing layer, then there is potential for on-disk corruption being | ||
carried forward into the new file. This will be noticed and the new | ||
commit-graph file will be clean as Git reparses the commit data from | ||
the object database. | ||
+ | ||
The incremental write is safe to run alongside concurrent Git processes | ||
since it will not expire `.graph` files that were in the previous | ||
`commit-graph-chain` file. They will be deleted by a later run based on | ||
the expiration delay. | ||
|
||
gc:: | ||
Cleanup unnecessary files and optimize the local repository. "GC" | ||
stands for "garbage collection," but this task performs many | ||
smaller tasks. This task can be rather expensive for large | ||
repositories, as it repacks all Git objects into a single pack-file. | ||
It can also be disruptive in some situations, as it deletes stale | ||
data. | ||
|
||
OPTIONS | ||
------- | ||
--auto:: | ||
When combined with the `run` subcommand, run maintenance tasks | ||
only if certain thresholds are met. For example, the `gc` task | ||
runs when the number of loose objects exceeds the number stored | ||
in the `gc.auto` config setting, or when the number of pack-files | ||
exceeds the `gc.autoPackLimit` config setting. | ||
|
||
--quiet:: | ||
Do not report progress or other information over `stderr`. | ||
|
||
--task=<task>:: | ||
If this option is specified one or more times, then only run the | ||
specified tasks in the specified order. | ||
|
||
GIT | ||
--- | ||
Part of the linkgit:git[1] suite |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.