Merge branch 'sp/maint-plug-traverse-commit-list-leak' into maint

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

diff --git a/Documentation/git-index-pack.txt b/Documentation/git-index-pack.txt
index 1235416e09d405b3bec118f6abe8e65e551fb696..a8a7f6f04bf5b95a5b325dc2df0adf9d94532bc5 100644 (file)
--- a/Documentation/git-index-pack.txt
+++ b/Documentation/git-index-pack.txt
@@ -8,8 +8,10 @@ git-index-pack - Build pack index file for an existing packed archive
 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------

+[verse]

 'git-index-pack' [-v] [-o <index-file>] <pack-file>
 'git-index-pack' [-v] [-o <index-file>] <pack-file>

-'git-index-pack' --stdin [--fix-thin] [--keep] [-v] [-o <index-file>] [<pack-file>]
+'git-index-pack' --stdin [--fix-thin] [--keep] [-v] [-o <index-file>]
+                 [<pack-file>]

 
 
 DESCRIPTION
 
 
 DESCRIPTION


@@ -68,6 +70,22 @@ OPTIONS
        message can later be searched for within all .keep files to
        locate any which have outlived their usefulness.
 
        message can later be searched for within all .keep files to
        locate any which have outlived their usefulness.
 

+--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.
+
+
+Note
+----
+
+Once the index has been created, the list of object names is sorted
+and the SHA1 hash of that list is printed to stdout. If --stdin was
+also used then this is prefixed by either "pack\t", or "keep\t" if a
+new .keep file was successfully created. This is useful to remove a
+.keep file used as a lock to prevent the race with gitlink:git-repack[1]
+mentioned above.
+

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


@@ -80,4 +98,3 @@ Documentation by Sergey Vlasov
 GIT
 ---
 Part of the gitlink:git[7] suite
 GIT
 ---
 Part of the gitlink:git[7] suite

-