[PATCH 5/8] git-gc --auto: add documentation.
From: Junio C Hamano <hidden>
Date: 2016-06-15 22:43:35
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
This documents the auto-packing of loose objects performed by git-gc --auto. Signed-off-by: Junio C Hamano <redacted> --- Documentation/config.txt | 7 +++++++ Documentation/git-gc.txt | 11 ++++++++++- 2 files changed, 17 insertions(+), 1 deletions(-)
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 866e053..3643c0b 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt@@ -439,6 +439,13 @@ gc.aggressiveWindow:: algorithm used by 'git gc --aggressive'. This defaults to 10. +gc.auto:: + When there are approximately more than this many loose + objects in the repository, `git gc --auto` that is + invoked by some Porcelain commands will create a new + pack and prune them. Setting this to 0 disables the + auto garbage collection. + gc.packrefs:: `git gc` does not run `git pack-refs` in a bare repository by default so that older dumb-transport clients can still fetch
diff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt
index c7742ca..40c1ce4 100644
--- a/Documentation/git-gc.txt
+++ b/Documentation/git-gc.txt@@ -8,7 +8,7 @@ git-gc - Cleanup unnecessary files and optimize the local repository SYNOPSIS -------- -'git-gc' [--prune] [--aggressive] +'git-gc' [--prune] [--aggressive] [--auto] DESCRIPTION -----------
@@ -43,6 +43,15 @@ OPTIONS persistent, so this option only needs to be used occasionally; every few hundred changesets or so. +--auto:: + With this option, `git gc` checks if there are too many + loose objects in the repository and runs + gitlink:git-repack[1] with `-d -l` option to pack them. + The threshold is set with `gc.auto` configuration + variable, and can be disabled by setting it to 0. Some + Porcelain commands use this after they perform operation + that could create many loose objects automatically. + Configuration -------------
--
1.5.3.1.967.g6bb01