git add <pathspec>... defaults to "-A"
[gitweb.git] / Documentation / git-pack-objects.txt
index 65eff66afe5990efc4af4f141809f355b7111bd3..d94edcd4b4fdd8bd57150bd0ad8f870a45e0249c 100644 (file)
@@ -35,7 +35,7 @@ A pack index file (.idx) is generated for fast, random access to the
 objects in the pack. Placing both the index file (.idx) and the packed
 archive (.pack) in the pack/ subdirectory of $GIT_OBJECT_DIRECTORY (or
 any of the directories on $GIT_ALTERNATE_OBJECT_DIRECTORIES)
-enables git to read from the pack archive.
+enables Git to read from the pack archive.
 
 The 'git unpack-objects' command can read the packed archive and
 expand the objects contained in the pack into "one-file
@@ -50,7 +50,7 @@ base-name::
        Write into a pair of files (.pack and .idx), using
        <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>-<SHA-1>.{pack,idx} files.  <SHA-1> is a hash
        of the sorted object names to make the resulting filename
        based on the pack content, and written to the standard
        output of the command.
@@ -80,7 +80,7 @@ base-name::
 --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.
+       can be useful to send new tags to native Git clients.
 
 --window=<n>::
 --depth=<n>::
@@ -115,7 +115,7 @@ base-name::
 
 --honor-pack-keep::
        This flag causes an object already in a local pack that
-       has a .keep file to be ignored, even if it it would have
+       has a .keep file to be ignored, even if it would have
        otherwise been packed.
 
 --incremental::
@@ -185,20 +185,25 @@ base-name::
        option only makes sense in conjunction with --stdout.
 +
 Note: A thin pack violates the packed archive format by omitting
-required objects and is thus unusable by git without making it
+required objects and is thus unusable by Git without making it
 self-contained. Use `git index-pack --fix-thin`
 (see linkgit:git-index-pack[1]) to restore the self-contained property.
 
 --delta-base-offset::
-       A packed archive can express base object of a delta as
-       either 20-byte object name or as an offset in the
-       stream, but older version of git does not understand the
+       A packed archive can express the base object of a delta as
+       either 20-byte object name or as an offset in the
+       stream, but ancient versions of Git don't understand the
        latter.  By default, 'git pack-objects' only uses the
        former format for better compatibility.  This option
        allows the command to use the latter format for
        compactness.  Depending on the average delta chain
        length, this option typically shrinks the resulting
        packfile by 3-5 per-cent.
++
+Note: Porcelain commands such as `git gc` (see linkgit:git-gc[1]),
+`git repack` (see linkgit:git-repack[1]) pass this option by default
+in modern Git when they put objects in your repository into pack files.
+So does `git bundle` (see linkgit:git-bundle[1]) when it creates a bundle.
 
 --threads=<n>::
        Specifies the number of threads to spawn when searching for best
@@ -207,7 +212,7 @@ self-contained. Use `git index-pack --fix-thin`
        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.
-       Specifying 0 will cause git to auto-detect the number of CPU's
+       Specifying 0 will cause Git to auto-detect the number of CPU's
        and set the number of threads accordingly.
 
 --index-version=<version>[,<offset>]::
@@ -219,15 +224,6 @@ self-contained. Use `git index-pack --fix-thin`
        With this option, parents that are hidden by grafts are packed
        nevertheless.
 
-
-Author
-------
-Written by Linus Torvalds <torvalds@osdl.org>
-
-Documentation
--------------
-Documentation by Junio C Hamano
-
 SEE ALSO
 --------
 linkgit:git-rev-list[1]