SYNOPSIS
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 whichmaintenance.<task>.enabled
config options are true. By default, onlymaintenance.gc.enabled
is true.
TASKS
- commit-graph
-
The
commit-graph
job updates thecommit-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 previouscommit-graph-chain
file. They will be deleted by a later run based on the expiration delay. - prefetch
-
The
prefetch
task updates the object directory with the latest objects from all registered remotes. For each remote, agit fetch
command is run. The refmap is custom to avoid updating local or remote branches (those inrefs/heads
orrefs/remotes
). Instead, the remote refs are stored inrefs/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.
- 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 git-gc(1) for more details on garbage collection in Git.
- 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. Thegc
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 theloose-objects
andgc
tasks at the same time. - incremental-repack
-
The
incremental-repack
job repacks the object directory using themulti-pack-index
feature. In order to prevent race conditions with concurrent Git commands, it follows a two-step process. First, it callsgit multi-pack-index expire
to delete pack-files unreferenced by themulti-pack-index
file. Second, it callsgit multi-pack-index repack
to select several small pack-files and repack them into a bigger one, and then update themulti-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 ofgit 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 therepack
subcommand in 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.
OPTIONS
- --auto
-
When combined with the
run
subcommand, run maintenance tasks only if certain thresholds are met. For example, thegc
task runs when the number of loose objects exceeds the number stored in thegc.auto
config setting, or when the number of pack-files exceeds thegc.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. If no
--task=<task>
arguments are specified, then only the tasks withmaintenance.<task>.enabled
configured astrue
are considered. See the TASKS section for the list of accepted<task>
values.
GIT
Part of the git(1) suite