Merge branch 'maint'

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

diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt
index a1e55054bd544848605eec8bfaa2cc29ac94f3d0..bd3ee456e336add5d880d6a1192646220e7c34d7 100644 (file)
--- a/Documentation/git-pack-objects.txt
+++ b/Documentation/git-pack-objects.txt
@@ -10,7 +10,7 @@ SYNOPSIS
 --------
 [verse]
 'git-pack-objects' [-q] [--no-reuse-delta] [--delta-base-offset] [--non-empty]
 --------
 [verse]
 'git-pack-objects' [-q] [--no-reuse-delta] [--delta-base-offset] [--non-empty]

-       [--local] [--incremental] [--window=N] [--depth=N]
+       [--local] [--incremental] [--window=N] [--depth=N] [--all-progress]

        [--revs [--unpacked | --all]*] [--stdout | base-name] < object-list
 
 
        [--revs [--unpacked | --all]*] [--stdout | base-name] < object-list
 
 


@@ -47,9 +47,8 @@ base-name::
        <base-name> to determine the name of the created file.
        When this option is used, the two files are written in
        <base-name>-<SHA1>.{pack,idx} files.  <SHA1> is a hash
        <base-name> to determine the name of the created file.
        When this option is used, the two files are written in
        <base-name>-<SHA1>.{pack,idx} files.  <SHA1> is a hash

-       of object names (currently in random order so it does
-       not have any useful meaning) to make the resulting
-       filename reasonably unique, and written to the standard
+       of the sorted object names to make the resulting filename
+       based on the pack content, and written to the standard

        output of the command.
 
 --stdout::
        output of the command.
 
 --stdout::


@@ -84,7 +83,7 @@ base-name::
        it too deep affects the performance on the unpacker
        side, because delta data needs to be applied that many
        times to get to the necessary object.
        it too deep affects the performance on the unpacker
        side, because delta data needs to be applied that many
        times to get to the necessary object.

-       The default value for both --window and --depth is 10.
+       The default value for --window is 10 and --depth is 50.

 
 --incremental::
        This flag causes an object already in a pack ignored
 
 --incremental::
        This flag causes an object already in a pack ignored


@@ -100,6 +99,23 @@ base-name::
         Only create a packed archive if it would contain at
         least one object.
 
         Only create a packed archive if it would contain at
         least one object.
 

+--progress::
+       Progress status is reported on the standard error stream
+       by default when it is attached to a terminal, unless -q
+       is specified. This flag forces progress status even if
+       the standard error stream is not directed to a terminal.
+
+--all-progress::
+       When --stdout is specified then progress report is
+       displayed during the object count and deltification phases
+       but inhibited during the write-out phase. The reason is
+       that in some cases the output stream is directly linked
+       to another command which may wish to display progress
+       status of its own as it processes incoming pack data.
+       This flag is like --progress except that it forces progress
+       report for the write-out phase as well even if --stdout is
+       used.
+

 -q::
        This flag makes the command not to report its progress
        on the standard error stream.
 -q::
        This flag makes the command not to report its progress
        on the standard error stream.


@@ -122,6 +138,11 @@ base-name::
        length, this option typically shrinks the resulting
        packfile by 3-5 per-cent.
 
        length, this option typically shrinks the resulting
        packfile by 3-5 per-cent.
 

+--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
+       64-bit index entries on objects located above the given offset.
+

 
 Author
 ------
 
 Author
 ------