verify-pack: test for detection of index v2 object CRC mismatch
[gitweb.git] / Documentation / git-pack-objects.txt
index 5c1bd3b0813a95ee0c1831a2e10f5512a9330793..f4d8d68e34b223f6ed06bceca706f9b91232c15f 100644 (file)
@@ -22,8 +22,9 @@ archive with specified base-name, or to the standard output.
 A packed archive is an efficient way to transfer set of objects
 between two repositories, and also is an archival format which
 is efficient to access.  The packed archive format (.pack) is
-designed to be unpackable without having anything else, but for
-random access, accompanied with the pack index file (.idx).
+designed to be self contained so that it can be unpacked without
+any further information, but for fast, random access to the objects
+in the pack, a pack index file (.idx) will be generated.
 
 Placing both in the pack/ subdirectory of $GIT_OBJECT_DIRECTORY (or
 any of the directories on $GIT_ALTERNATE_OBJECT_DIRECTORIES)
@@ -73,7 +74,13 @@ base-name::
        as if all refs under `$GIT_DIR/refs` are specified to be
        included.
 
---window=[N], --depth=[N]::
+--include-tag::
+       Include unasked-for annotated tags if the object they
+       reference was included in the resulting packfile.  This
+       can be useful to send new tags to native git clients.
+
+--window=[N]::
+--depth=[N]::
        These two options affect how the objects contained in
        the pack are stored using delta compression.  The
        objects are first internally sorted by type, size and
@@ -194,7 +201,7 @@ Documentation
 -------------
 Documentation by Junio C Hamano
 
-See Also
+SEE ALSO
 --------
 linkgit:git-rev-list[1]
 linkgit:git-repack[1]
@@ -202,4 +209,4 @@ linkgit:git-prune-packed[1]
 
 GIT
 ---
-Part of the linkgit:git[7] suite
+Part of the linkgit:git[1] suite