maintenance: create basic maintenance runner
The 'gc' builtin is our current entrypoint for automatically maintaining
a repository. This one tool does many operations, such as repacking the
repository, packing refs, and rewriting the commit-graph file. The name
implies it performs "garbage collection" which means several different
things, and some users may not want to use this operation that rewrites
the entire object database.
Create a new 'maintenance' builtin that will become a more general-
purpose command. To start, it will only support the 'run' subcommand,
but will later expand to add subcommands for scheduling maintenance in
the background.
For now, the 'maintenance' builtin is a thin shim over the 'gc' builtin.
In fact, the only option is the '--auto' toggle, which is handed
directly to the 'gc' builtin. The current change is isolated to this
simple operation to prevent more interesting logic from being lost in
all of the boilerplate of adding a new builtin.
Use existing builtin/gc.c file because we want to share code between the
two builtins. It is possible that we will have 'maintenance' replace the
'gc' builtin entirely at some point, leaving 'git gc' as an alias for
some specific arguments to 'git maintenance run'.
Create a new test_subcommand helper that allows us to test if a certain
subcommand was run. It requires storing the GIT_TRACE2_EVENT logs in a
file. A negation mode is available that will be used in later tests.
Helped-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-09-17 20:11:42 +02:00
|
|
|
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
|
|
|
|
|
-----------
|
|
|
|
|
|
2020-09-11 19:49:17 +02:00
|
|
|
register::
|
|
|
|
|
Initialize Git config values so any scheduled maintenance will
|
|
|
|
|
start running on this repository. This adds the repository to the
|
|
|
|
|
`maintenance.repo` config variable in the current user's global
|
|
|
|
|
config and enables some recommended configuration values for
|
|
|
|
|
`maintenance.<task>.schedule`. The tasks that are enabled are safe
|
|
|
|
|
for running in the background without disrupting foreground
|
|
|
|
|
processes.
|
2020-10-15 19:22:03 +02:00
|
|
|
+
|
|
|
|
|
The `register` subcomand will also set the `maintenance.strategy` config
|
|
|
|
|
value to `incremental`, if this value is not previously set. The
|
|
|
|
|
`incremental` strategy uses the following schedule for each maintenance
|
|
|
|
|
task:
|
|
|
|
|
+
|
|
|
|
|
--
|
|
|
|
|
* `gc`: disabled.
|
|
|
|
|
* `commit-graph`: hourly.
|
|
|
|
|
* `prefetch`: hourly.
|
|
|
|
|
* `loose-objects`: daily.
|
|
|
|
|
* `incremental-repack`: daily.
|
|
|
|
|
--
|
|
|
|
|
+
|
|
|
|
|
`git maintenance register` will also disable foreground maintenance by
|
|
|
|
|
setting `maintenance.auto = false` in the current repository. This config
|
|
|
|
|
setting will remain after a `git maintenance unregister` command.
|
2020-09-11 19:49:17 +02:00
|
|
|
|
maintenance: create basic maintenance runner
The 'gc' builtin is our current entrypoint for automatically maintaining
a repository. This one tool does many operations, such as repacking the
repository, packing refs, and rewriting the commit-graph file. The name
implies it performs "garbage collection" which means several different
things, and some users may not want to use this operation that rewrites
the entire object database.
Create a new 'maintenance' builtin that will become a more general-
purpose command. To start, it will only support the 'run' subcommand,
but will later expand to add subcommands for scheduling maintenance in
the background.
For now, the 'maintenance' builtin is a thin shim over the 'gc' builtin.
In fact, the only option is the '--auto' toggle, which is handed
directly to the 'gc' builtin. The current change is isolated to this
simple operation to prevent more interesting logic from being lost in
all of the boilerplate of adding a new builtin.
Use existing builtin/gc.c file because we want to share code between the
two builtins. It is possible that we will have 'maintenance' replace the
'gc' builtin entirely at some point, leaving 'git gc' as an alias for
some specific arguments to 'git maintenance run'.
Create a new test_subcommand helper that allows us to test if a certain
subcommand was run. It requires storing the GIT_TRACE2_EVENT logs in a
file. A negation mode is available that will be used in later tests.
Helped-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-09-17 20:11:42 +02:00
|
|
|
run::
|
2020-09-17 20:11:49 +02:00
|
|
|
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.
|
maintenance: create basic maintenance runner
The 'gc' builtin is our current entrypoint for automatically maintaining
a repository. This one tool does many operations, such as repacking the
repository, packing refs, and rewriting the commit-graph file. The name
implies it performs "garbage collection" which means several different
things, and some users may not want to use this operation that rewrites
the entire object database.
Create a new 'maintenance' builtin that will become a more general-
purpose command. To start, it will only support the 'run' subcommand,
but will later expand to add subcommands for scheduling maintenance in
the background.
For now, the 'maintenance' builtin is a thin shim over the 'gc' builtin.
In fact, the only option is the '--auto' toggle, which is handed
directly to the 'gc' builtin. The current change is isolated to this
simple operation to prevent more interesting logic from being lost in
all of the boilerplate of adding a new builtin.
Use existing builtin/gc.c file because we want to share code between the
two builtins. It is possible that we will have 'maintenance' replace the
'gc' builtin entirely at some point, leaving 'git gc' as an alias for
some specific arguments to 'git maintenance run'.
Create a new test_subcommand helper that allows us to test if a certain
subcommand was run. It requires storing the GIT_TRACE2_EVENT logs in a
file. A negation mode is available that will be used in later tests.
Helped-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-09-17 20:11:42 +02:00
|
|
|
|
2020-09-11 19:49:18 +02:00
|
|
|
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.
|
|
|
|
|
|
2020-09-11 19:49:17 +02:00
|
|
|
unregister::
|
|
|
|
|
Remove the current repository from background maintenance. This
|
|
|
|
|
only removes the repository from the configured list. It does not
|
|
|
|
|
stop the background maintenance processes from running.
|
|
|
|
|
|
maintenance: create basic maintenance runner
The 'gc' builtin is our current entrypoint for automatically maintaining
a repository. This one tool does many operations, such as repacking the
repository, packing refs, and rewriting the commit-graph file. The name
implies it performs "garbage collection" which means several different
things, and some users may not want to use this operation that rewrites
the entire object database.
Create a new 'maintenance' builtin that will become a more general-
purpose command. To start, it will only support the 'run' subcommand,
but will later expand to add subcommands for scheduling maintenance in
the background.
For now, the 'maintenance' builtin is a thin shim over the 'gc' builtin.
In fact, the only option is the '--auto' toggle, which is handed
directly to the 'gc' builtin. The current change is isolated to this
simple operation to prevent more interesting logic from being lost in
all of the boilerplate of adding a new builtin.
Use existing builtin/gc.c file because we want to share code between the
two builtins. It is possible that we will have 'maintenance' replace the
'gc' builtin entirely at some point, leaving 'git gc' as an alias for
some specific arguments to 'git maintenance run'.
Create a new test_subcommand helper that allows us to test if a certain
subcommand was run. It requires storing the GIT_TRACE2_EVENT logs in a
file. A negation mode is available that will be used in later tests.
Helped-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-09-17 20:11:42 +02:00
|
|
|
TASKS
|
|
|
|
|
-----
|
|
|
|
|
|
2020-09-17 20:11:46 +02:00
|
|
|
commit-graph::
|
|
|
|
|
The `commit-graph` job updates the `commit-graph` files incrementally,
|
|
|
|
|
then verifies that the written data is correct. 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.
|
|
|
|
|
|
maintenance: add prefetch task
When working with very large repositories, an incremental 'git fetch'
command can download a large amount of data. If there are many other
users pushing to a common repo, then this data can rival the initial
pack-file size of a 'git clone' of a medium-size repo.
Users may want to keep the data on their local repos as close as
possible to the data on the remote repos by fetching periodically in
the background. This can break up a large daily fetch into several
smaller hourly fetches.
The task is called "prefetch" because it is work done in advance
of a foreground fetch to make that 'git fetch' command much faster.
However, if we simply ran 'git fetch <remote>' in the background,
then the user running a foreground 'git fetch <remote>' would lose
some important feedback when a new branch appears or an existing
branch updates. This is especially true if a remote branch is
force-updated and this isn't noticed by the user because it occurred
in the background. Further, the functionality of 'git push
--force-with-lease' becomes suspect.
When running 'git fetch <remote> <options>' in the background, use
the following options for careful updating:
1. --no-tags prevents getting a new tag when a user wants to see
the new tags appear in their foreground fetches.
2. --refmap= removes the configured refspec which usually updates
refs/remotes/<remote>/* with the refs advertised by the remote.
While this looks confusing, this was documented and tested by
b40a50264ac (fetch: document and test --refmap="", 2020-01-21),
including this sentence in the documentation:
Providing an empty `<refspec>` to the `--refmap` option
causes Git to ignore the configured refspecs and rely
entirely on the refspecs supplied as command-line arguments.
3. By adding a new refspec "+refs/heads/*:refs/prefetch/<remote>/*"
we can ensure that we actually load the new values somewhere in
our refspace while not updating refs/heads or refs/remotes. By
storing these refs here, the commit-graph job will update the
commit-graph with the commits from these hidden refs.
4. --prune will delete the refs/prefetch/<remote> refs that no
longer appear on the remote.
5. --no-write-fetch-head prevents updating FETCH_HEAD.
We've been using this step as a critical background job in Scalar
[1] (and VFS for Git). This solved a pain point that was showing up
in user reports: fetching was a pain! Users do not like waiting to
download the data that was created while they were away from their
machines. After implementing background fetch, the foreground fetch
commands sped up significantly because they mostly just update refs
and download a small amount of new data. The effect is especially
dramatic when paried with --no-show-forced-udpates (through
fetch.showForcedUpdates=false).
[1] https://github.com/microsoft/scalar/blob/master/Scalar.Common/Maintenance/FetchStep.cs
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-09-25 14:33:31 +02:00
|
|
|
prefetch::
|
|
|
|
|
The `prefetch` task updates the object directory with the latest
|
|
|
|
|
objects from all registered remotes. For each remote, a `git fetch`
|
|
|
|
|
command is run. The refmap is custom to avoid updating local or remote
|
|
|
|
|
branches (those in `refs/heads` or `refs/remotes`). Instead, the
|
|
|
|
|
remote refs are stored in `refs/prefetch/<remote>/`. Also, tags are
|
|
|
|
|
not updated.
|
|
|
|
|
+
|
|
|
|
|
This is done to avoid disrupting the remote-tracking branches. The end users
|
|
|
|
|
expect these refs to stay unmoved unless they initiate a fetch. With prefetch
|
|
|
|
|
task, however, the objects necessary to complete a later real fetch would
|
|
|
|
|
already be obtained, so the real fetch would go faster. In the ideal case,
|
|
|
|
|
it will just become an update to bunch of remote-tracking branches without
|
|
|
|
|
any object transfer.
|
|
|
|
|
|
maintenance: create basic maintenance runner
The 'gc' builtin is our current entrypoint for automatically maintaining
a repository. This one tool does many operations, such as repacking the
repository, packing refs, and rewriting the commit-graph file. The name
implies it performs "garbage collection" which means several different
things, and some users may not want to use this operation that rewrites
the entire object database.
Create a new 'maintenance' builtin that will become a more general-
purpose command. To start, it will only support the 'run' subcommand,
but will later expand to add subcommands for scheduling maintenance in
the background.
For now, the 'maintenance' builtin is a thin shim over the 'gc' builtin.
In fact, the only option is the '--auto' toggle, which is handed
directly to the 'gc' builtin. The current change is isolated to this
simple operation to prevent more interesting logic from being lost in
all of the boilerplate of adding a new builtin.
Use existing builtin/gc.c file because we want to share code between the
two builtins. It is possible that we will have 'maintenance' replace the
'gc' builtin entirely at some point, leaving 'git gc' as an alias for
some specific arguments to 'git maintenance run'.
Create a new test_subcommand helper that allows us to test if a certain
subcommand was run. It requires storing the GIT_TRACE2_EVENT logs in a
file. A negation mode is available that will be used in later tests.
Helped-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-09-17 20:11:42 +02:00
|
|
|
gc::
|
|
|
|
|
Clean up unnecessary files and optimize the local repository. "GC"
|
|
|
|
|
stands for "garbage collection," but this task performs many
|
|
|
|
|
smaller tasks. This task can be 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. See
|
|
|
|
|
linkgit:git-gc[1] for more details on garbage collection in Git.
|
|
|
|
|
|
2020-09-25 14:33:32 +02:00
|
|
|
loose-objects::
|
|
|
|
|
The `loose-objects` job cleans up loose objects and places them into
|
|
|
|
|
pack-files. In order to prevent race conditions with concurrent Git
|
|
|
|
|
commands, it follows a two-step process. First, it deletes any loose
|
|
|
|
|
objects that already exist in a pack-file; concurrent Git processes
|
|
|
|
|
will examine the pack-file for the object data instead of the loose
|
|
|
|
|
object. Second, it creates a new pack-file (starting with "loose-")
|
|
|
|
|
containing a batch of loose objects. The batch size is limited to 50
|
|
|
|
|
thousand objects to prevent the job from taking too long on a
|
|
|
|
|
repository with many loose objects. The `gc` task writes unreachable
|
|
|
|
|
objects as loose objects to be cleaned up by a later step only if
|
|
|
|
|
they are not re-added to a pack-file; for this reason it is not
|
|
|
|
|
advisable to enable both the `loose-objects` and `gc` tasks at the
|
|
|
|
|
same time.
|
|
|
|
|
|
maintenance: add incremental-repack task
The previous change cleaned up loose objects using the
'loose-objects' that can be run safely in the background. Add a
similar job that performs similar cleanups for pack-files.
One issue with running 'git repack' is that it is designed to
repack all pack-files into a single pack-file. While this is the
most space-efficient way to store object data, it is not time or
memory efficient. This becomes extremely important if the repo is
so large that a user struggles to store two copies of the pack on
their disk.
Instead, perform an "incremental" repack by collecting a few small
pack-files into a new pack-file. The multi-pack-index facilitates
this process ever since 'git multi-pack-index expire' was added in
19575c7 (multi-pack-index: implement 'expire' subcommand,
2019-06-10) and 'git multi-pack-index repack' was added in ce1e4a1
(midx: implement midx_repack(), 2019-06-10).
The 'incremental-repack' task runs the following steps:
1. 'git multi-pack-index write' creates a multi-pack-index file if
one did not exist, and otherwise will update the multi-pack-index
with any new pack-files that appeared since the last write. This
is particularly relevant with the background fetch job.
When the multi-pack-index sees two copies of the same object, it
stores the offset data into the newer pack-file. This means that
some old pack-files could become "unreferenced" which I will use
to mean "a pack-file that is in the pack-file list of the
multi-pack-index but none of the objects in the multi-pack-index
reference a location inside that pack-file."
2. 'git multi-pack-index expire' deletes any unreferenced pack-files
and updaes the multi-pack-index to drop those pack-files from the
list. This is safe to do as concurrent Git processes will see the
multi-pack-index and not open those packs when looking for object
contents. (Similar to the 'loose-objects' job, there are some Git
commands that open pack-files regardless of the multi-pack-index,
but they are rarely used. Further, a user that self-selects to
use background operations would likely refrain from using those
commands.)
3. 'git multi-pack-index repack --bacth-size=<size>' collects a set
of pack-files that are listed in the multi-pack-index and creates
a new pack-file containing the objects whose offsets are listed
by the multi-pack-index to be in those objects. The set of pack-
files is selected greedily by sorting the pack-files by modified
time and adding a pack-file to the set if its "expected size" is
smaller than the batch size until the total expected size of the
selected pack-files is at least the batch size. The "expected
size" is calculated by taking the size of the pack-file divided
by the number of objects in the pack-file and multiplied by the
number of objects from the multi-pack-index with offset in that
pack-file. The expected size approximates how much data from that
pack-file will contribute to the resulting pack-file size. The
intention is that the resulting pack-file will be close in size
to the provided batch size.
The next run of the incremental-repack task will delete these
repacked pack-files during the 'expire' step.
In this version, the batch size is set to "0" which ignores the
size restrictions when selecting the pack-files. It instead
selects all pack-files and repacks all packed objects into a
single pack-file. This will be updated in the next change, but
it requires doing some calculations that are better isolated to
a separate change.
These steps are based on a similar background maintenance step in
Scalar (and VFS for Git) [1]. This was incredibly effective for
users of the Windows OS repository. After using the same VFS for Git
repository for over a year, some users had _thousands_ of pack-files
that combined to up to 250 GB of data. We noticed a few users were
running into the open file descriptor limits (due in part to a bug
in the multi-pack-index fixed by af96fe3 (midx: add packs to
packed_git linked list, 2019-04-29).
These pack-files were mostly small since they contained the commits
and trees that were pushed to the origin in a given hour. The GVFS
protocol includes a "prefetch" step that asks for pre-computed pack-
files containing commits and trees by timestamp. These pack-files
were grouped into "daily" pack-files once a day for up to 30 days.
If a user did not request prefetch packs for over 30 days, then they
would get the entire history of commits and trees in a new, large
pack-file. This led to a large number of pack-files that had poor
delta compression.
By running this pack-file maintenance step once per day, these repos
with thousands of packs spanning 200+ GB dropped to dozens of pack-
files spanning 30-50 GB. This was done all without removing objects
from the system and using a constant batch size of two gigabytes.
Once the work was done to reduce the pack-files to small sizes, the
batch size of two gigabytes means that not every run triggers a
repack operation, so the following run will not expire a pack-file.
This has kept these repos in a "clean" state.
[1] https://github.com/microsoft/scalar/blob/master/Scalar.Common/Maintenance/PackfileMaintenanceStep.cs
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-09-25 14:33:36 +02:00
|
|
|
incremental-repack::
|
|
|
|
|
The `incremental-repack` job repacks the object directory
|
|
|
|
|
using the `multi-pack-index` feature. In order to prevent race
|
|
|
|
|
conditions with concurrent Git commands, it follows a two-step
|
|
|
|
|
process. First, it calls `git multi-pack-index expire` to delete
|
|
|
|
|
pack-files unreferenced by the `multi-pack-index` file. Second, it
|
|
|
|
|
calls `git multi-pack-index repack` to select several small
|
|
|
|
|
pack-files and repack them into a bigger one, and then update the
|
|
|
|
|
`multi-pack-index` entries that refer to the small pack-files to
|
|
|
|
|
refer to the new pack-file. This prepares those small pack-files
|
|
|
|
|
for deletion upon the next run of `git multi-pack-index expire`.
|
|
|
|
|
The selection of the small pack-files is such that the expected
|
|
|
|
|
size of the big pack-file is at least the batch size; see the
|
|
|
|
|
`--batch-size` option for the `repack` subcommand in
|
|
|
|
|
linkgit:git-multi-pack-index[1]. The default batch-size is zero,
|
|
|
|
|
which is a special case that attempts to repack all pack-files
|
|
|
|
|
into a single pack-file.
|
|
|
|
|
|
maintenance: create basic maintenance runner
The 'gc' builtin is our current entrypoint for automatically maintaining
a repository. This one tool does many operations, such as repacking the
repository, packing refs, and rewriting the commit-graph file. The name
implies it performs "garbage collection" which means several different
things, and some users may not want to use this operation that rewrites
the entire object database.
Create a new 'maintenance' builtin that will become a more general-
purpose command. To start, it will only support the 'run' subcommand,
but will later expand to add subcommands for scheduling maintenance in
the background.
For now, the 'maintenance' builtin is a thin shim over the 'gc' builtin.
In fact, the only option is the '--auto' toggle, which is handed
directly to the 'gc' builtin. The current change is isolated to this
simple operation to prevent more interesting logic from being lost in
all of the boilerplate of adding a new builtin.
Use existing builtin/gc.c file because we want to share code between the
two builtins. It is possible that we will have 'maintenance' replace the
'gc' builtin entirely at some point, leaving 'git gc' as an alias for
some specific arguments to 'git maintenance run'.
Create a new test_subcommand helper that allows us to test if a certain
subcommand was run. It requires storing the GIT_TRACE2_EVENT logs in a
file. A negation mode is available that will be used in later tests.
Helped-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-09-17 20:11:42 +02:00
|
|
|
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
|
2020-09-11 19:49:15 +02:00
|
|
|
exceeds the `gc.autoPackLimit` config setting. Not compatible with
|
|
|
|
|
the `--schedule` option.
|
|
|
|
|
|
|
|
|
|
--schedule::
|
|
|
|
|
When combined with the `run` subcommand, run maintenance tasks
|
|
|
|
|
only if certain time conditions are met, as specified by the
|
|
|
|
|
`maintenance.<task>.schedule` config value for each `<task>`.
|
|
|
|
|
This config value specifies a number of seconds since the last
|
|
|
|
|
time that task ran, according to the `maintenance.<task>.lastRun`
|
|
|
|
|
config value. The tasks that are tested are those provided by
|
|
|
|
|
the `--task=<task>` option(s) or those with
|
|
|
|
|
`maintenance.<task>.enabled` set to true.
|
maintenance: create basic maintenance runner
The 'gc' builtin is our current entrypoint for automatically maintaining
a repository. This one tool does many operations, such as repacking the
repository, packing refs, and rewriting the commit-graph file. The name
implies it performs "garbage collection" which means several different
things, and some users may not want to use this operation that rewrites
the entire object database.
Create a new 'maintenance' builtin that will become a more general-
purpose command. To start, it will only support the 'run' subcommand,
but will later expand to add subcommands for scheduling maintenance in
the background.
For now, the 'maintenance' builtin is a thin shim over the 'gc' builtin.
In fact, the only option is the '--auto' toggle, which is handed
directly to the 'gc' builtin. The current change is isolated to this
simple operation to prevent more interesting logic from being lost in
all of the boilerplate of adding a new builtin.
Use existing builtin/gc.c file because we want to share code between the
two builtins. It is possible that we will have 'maintenance' replace the
'gc' builtin entirely at some point, leaving 'git gc' as an alias for
some specific arguments to 'git maintenance run'.
Create a new test_subcommand helper that allows us to test if a certain
subcommand was run. It requires storing the GIT_TRACE2_EVENT logs in a
file. A negation mode is available that will be used in later tests.
Helped-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-09-17 20:11:42 +02:00
|
|
|
|
2020-09-17 20:11:43 +02:00
|
|
|
--quiet::
|
|
|
|
|
Do not report progress or other information over `stderr`.
|
|
|
|
|
|
2020-09-17 20:11:47 +02:00
|
|
|
--task=<task>::
|
|
|
|
|
If this option is specified one or more times, then only run the
|
2020-09-17 20:11:49 +02:00
|
|
|
specified tasks in the specified order. If no `--task=<task>`
|
|
|
|
|
arguments are specified, then only the tasks with
|
|
|
|
|
`maintenance.<task>.enabled` configured as `true` are considered.
|
|
|
|
|
See the 'TASKS' section for the list of accepted `<task>` values.
|
2020-09-17 20:11:47 +02:00
|
|
|
|
2020-10-15 19:22:04 +02:00
|
|
|
|
|
|
|
|
TROUBLESHOOTING
|
|
|
|
|
---------------
|
|
|
|
|
The `git maintenance` command is designed to simplify the repository
|
|
|
|
|
maintenance patterns while minimizing user wait time during Git commands.
|
|
|
|
|
A variety of configuration options are available to allow customizing this
|
|
|
|
|
process. The default maintenance options focus on operations that complete
|
|
|
|
|
quickly, even on large repositories.
|
|
|
|
|
|
|
|
|
|
Users may find some cases where scheduled maintenance tasks do not run as
|
|
|
|
|
frequently as intended. Each `git maintenance run` command takes a lock on
|
|
|
|
|
the repository's object database, and this prevents other concurrent
|
|
|
|
|
`git maintenance run` commands from running on the same repository. Without
|
|
|
|
|
this safeguard, competing processes could leave the repository in an
|
|
|
|
|
unpredictable state.
|
|
|
|
|
|
|
|
|
|
The background maintenance schedule runs `git maintenance run` processes
|
|
|
|
|
on an hourly basis. Each run executes the "hourly" tasks. At midnight,
|
|
|
|
|
that process also executes the "daily" tasks. At midnight on the first day
|
|
|
|
|
of the week, that process also executes the "weekly" tasks. A single
|
|
|
|
|
process iterates over each registered repository, performing the scheduled
|
|
|
|
|
tasks for that frequency. Depending on the number of registered
|
|
|
|
|
repositories and their sizes, this process may take longer than an hour.
|
|
|
|
|
In this case, multiple `git maintenance run` commands may run on the same
|
|
|
|
|
repository at the same time, colliding on the object database lock. This
|
|
|
|
|
results in one of the two tasks not running.
|
|
|
|
|
|
|
|
|
|
If you find that some maintenance windows are taking longer than one hour
|
|
|
|
|
to complete, then consider reducing the complexity of your maintenance
|
|
|
|
|
tasks. For example, the `gc` task is much slower than the
|
|
|
|
|
`incremental-repack` task. However, this comes at a cost of a slightly
|
|
|
|
|
larger object database. Consider moving more expensive tasks to be run
|
|
|
|
|
less frequently.
|
|
|
|
|
|
|
|
|
|
Expert users may consider scheduling their own maintenance tasks using a
|
|
|
|
|
different schedule than is available through `git maintenance start` and
|
|
|
|
|
Git configuration options. These users should be aware of the object
|
|
|
|
|
database lock and how concurrent `git maintenance run` commands behave.
|
|
|
|
|
Further, the `git gc` command should not be combined with
|
|
|
|
|
`git maintenance run` commands. `git gc` modifies the object database
|
|
|
|
|
but does not take the lock in the same way as `git maintenance run`. If
|
|
|
|
|
possible, use `git maintenance run --task=gc` instead of `git gc`.
|
|
|
|
|
|
|
|
|
|
|
maintenance: create basic maintenance runner
The 'gc' builtin is our current entrypoint for automatically maintaining
a repository. This one tool does many operations, such as repacking the
repository, packing refs, and rewriting the commit-graph file. The name
implies it performs "garbage collection" which means several different
things, and some users may not want to use this operation that rewrites
the entire object database.
Create a new 'maintenance' builtin that will become a more general-
purpose command. To start, it will only support the 'run' subcommand,
but will later expand to add subcommands for scheduling maintenance in
the background.
For now, the 'maintenance' builtin is a thin shim over the 'gc' builtin.
In fact, the only option is the '--auto' toggle, which is handed
directly to the 'gc' builtin. The current change is isolated to this
simple operation to prevent more interesting logic from being lost in
all of the boilerplate of adding a new builtin.
Use existing builtin/gc.c file because we want to share code between the
two builtins. It is possible that we will have 'maintenance' replace the
'gc' builtin entirely at some point, leaving 'git gc' as an alias for
some specific arguments to 'git maintenance run'.
Create a new test_subcommand helper that allows us to test if a certain
subcommand was run. It requires storing the GIT_TRACE2_EVENT logs in a
file. A negation mode is available that will be used in later tests.
Helped-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-09-17 20:11:42 +02:00
|
|
|
GIT
|
|
|
|
|
---
|
|
|
|
|
Part of the linkgit:git[1] suite
|