Merge branch 'np/delta'

[git.git] / Documentation / git-pack-objects.txt

diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt
index e3549b50442bea1734812ec40331adb7e3d41ef7..628f296ce1366f728d9a2321bd02e3db492adffb 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.
@@ -144,12 +155,8 @@ base-name::
        generated pack.  If not specified,  pack compression level is
        determined first by pack.compression,  then by core.compression,
        and defaults to -1,  the zlib default,  if neither is set.
-       Data copied from loose objects will be recompressed
-       if core.legacyheaders was true when they were created or if
-       the loose compression level (see core.loosecompression and
-       core.compression) is now a different value than the pack
-       compression level.  Add --no-reuse-object if you want to force
-       a uniform compression level on all data no matter the source.
+       Add \--no-reuse-object if you want to force a uniform compression
+       level on all data no matter the source.
 
 --delta-base-offset::
        A packed archive can express base object of a delta as
@@ -162,6 +169,14 @@ base-name::
        length, this option typically shrinks the resulting
        packfile by 3-5 per-cent.
 
+--threads=<n>::
+       Specifies the number of threads to spawn when searching for best
+       delta matches.  This requires that pack-objects be compiled with
+       pthreads otherwise this option is ignored with a warning.
+       This is meant to reduce packing time on multiprocessor machines.
+       The required amount of memory for the delta search window is
+       however multiplied by the number of threads.
+
 --index-version=<version>[,<offset>]::
        This is intended to be used by the test suite only. It allows
        to force the version for the generated pack index, and to force