Add documentation for --window-memory, pack.windowMemory

Signed-off-by: Brian Downing <bdowning@lavos.net>
Acked-by: Nicolas Pitre <nico@cam.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 4b67f0adf721d540ddd437254de4aa069f1be0ae..11b332117c7abbdf3c4239843672d394578f8f0a 100644 (file)
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -589,6 +589,12 @@ pack.depth::
        The maximum delta depth used by gitlink:git-pack-objects[1] when no
        maximum depth is given on the command line. Defaults to 50.
 
+pack.windowMemory::
+       The window memory size limit used by gitlink:git-pack-objects[1]
+       when no limit is given on the command line.  The value can be
+       suffixed with "k", "m", or "g".  Defaults to 0, meaning no
+       limit.
+
 pack.compression::
        An integer -1..9, indicating the compression level for objects
        in a pack file. -1 is the zlib default. 0 means no

diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt
index e3549b50442bea1734812ec40331adb7e3d41ef7..6f17cff24ab784ee68767724dff6892b67b3ad53 100644 (file)
--- a/Documentation/git-pack-objects.txt
+++ b/Documentation/git-pack-objects.txt
@@ -85,6 +85,17 @@ base-name::
        times to get to the necessary object.
        The default value for --window is 10 and --depth is 50.
 
+--window-memory=[N]::
+       This option provides an additional limit on top of `--window`;
+       the window size will dynamically scale down so as to not take
+       up more than N bytes in memory.  This is useful in
+       repositories with a mix of large and small objects to not run
+       out of memory with a large window, but still be able to take
+       advantage of the large window for the smaller objects.  The
+       size can be suffixed with "k", "m", or "g".
+       `--window-memory=0` makes memory usage unlimited, which is the
+       default.
+
 --max-pack-size=<n>::
        Maximum size of each output packfile, expressed in MiB.
        If specified,  multiple packfiles may be created.

diff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt
index 28949397ca7434471f1e9c1552ecae1ade9b8313..5283ef84a9f4083b1c79316286c3278679a41699 100644 (file)
--- a/Documentation/git-repack.txt
+++ b/Documentation/git-repack.txt
@@ -68,6 +68,17 @@ OPTIONS
        to be applied that many times to get to the necessary object.
        The default value for --window is 10 and --depth is 50.
 
+--window-memory=[N]::
+       This option provides an additional limit on top of `--window`;
+       the window size will dynamically scale down so as to not take
+       up more than N bytes in memory.  This is useful in
+       repositories with a mix of large and small objects to not run
+       out of memory with a large window, but still be able to take
+       advantage of the large window for the smaller objects.  The
+       size can be suffixed with "k", "m", or "g".
+       `--window-memory=0` makes memory usage unlimited, which is the
+       default.
+
 --max-pack-size=<n>::
        Maximum size of each output packfile, expressed in MiB.
        If specified,  multiple packfiles may be created.