diff options
author | Matthias Sohn <matthias.sohn@sap.com> | 2020-09-08 01:42:03 +0200 |
---|---|---|
committer | Marco Miller <marco.mmiller@gmail.com> | 2020-11-04 13:38:57 +0000 |
commit | 85c187970304767ae64b4f46d90e98110960a954 (patch) | |
tree | dc68e69fa574e2d82abd30b228baac148ceb4ce8 | |
parent | 512d36325f85c687e98dbe03f423a620a46212bd (diff) |
Document jgit options respected by gerrit gc
Change-Id: I097dd88d906008d7af1ee9483f6b8ec96380ff72
-rw-r--r-- | Documentation/config-gerrit.txt | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/Documentation/config-gerrit.txt b/Documentation/config-gerrit.txt index eb751ac919..f35dfc7284 100644 --- a/Documentation/config-gerrit.txt +++ b/Documentation/config-gerrit.txt @@ -5245,6 +5245,49 @@ Sample `etc/jgit.config` file: trustFolderStat = false ---- +[[jgit-gc]] +=== Section gc + +Options in section gc are used when command link:cmd-gc.html[gerrit gc] is used +or scheduled via options link:cmd-gc.html#gc.startTime[gc.startTime] and +link:cmd-gc.html#gc.interval[gc.interval]. + +[[gc.auto]]gc.auto:: ++ +When there are approximately more than this many loose objects in the repository, +auto gc will pack them. Some commands use this command to perform a light-weight +garbage collection from time to time. The default value is 6700. ++ +Setting this to 0 disables not only automatic packing based on the number of +loose objects, but any other heuristic auto gc will otherwise use to determine +if there’s work to do, such as link:#gc.autoPackLimit[gc.autoPackLimit]. + +[[gc.autodetach]]gc.autodetach:: ++ +Makes auto gc run in a background thread. Default is `true`. + +[[gc.autopacklimit]]gc.autopacklimit:: ++ +When there are more than this many packs that are not marked with `*.keep` file +in the repository, auto gc consolidates them into one larger pack. The +default value is 50. Setting this to 0 disables it. Setting `gc.auto` to 0 will +also disable this. + +[[gc.packRefs]]gc.packRefs:: ++ +This variable determines whether gc runs git pack-refs. The default is `true`. + +[[gc.reflogExpire]]gc.reflogExpire:: ++ +Removes reflog entries older than this time; defaults to 90 days. The value "now" +expires all entries immediately, and "never" suppresses expiration altogether. + +[[gc.reflogExpireUnreachable]]gc.reflogExpireUnreachable:: ++ +Removes reflog entries older than this time and not reachable from the +current tip; defaults to 30 days. The value "now" expires all entries immediately, +and "never" suppresses expiration altogether. + [[jgit-protocol]] === Section protocol @@ -5262,6 +5305,16 @@ Supported versions: 2:: wire protocol version 2. Speeds up fetches from repositories with many refs by allowing the client to specify which refs to list before the server lists them. +[[jgit-receive]] +=== Section receive + +[[receive.autogc]]receive.autogc:: ++ +By default, `git-receive-pack` will run auto gc after receiving data from git-push and updating refs. +You can stop it by setting this variable to `false`. This is recommended in gerrit to avoid the +additional load this creates. Instead schedule gc using link:cmd-gc.html#gc.startTime[gc.startTime] +and link:cmd-gc.html#gc.interval[gc.interval] or e.g. in a cron job that runs gc in a separate process. + GERRIT ------ Part of link:index.html[Gerrit Code Review] |