Add default values for --window and --depth to the docs
authorDennis Stosberg <dennis@stosberg.net>
Fri, 6 Oct 2006 09:15:03 +0000 (11:15 +0200)
committerJunio C Hamano <junkio@cox.net>
Fri, 6 Oct 2006 09:53:39 +0000 (02:53 -0700)
Currently, you actually have to read the source to find out the
default values. While at it, fix two typos and suggest that these
options actually take a parameter in git-pack-objects.txt.

Signed-off-by: Dennis Stosberg <dennis@stosberg.net>
Signed-off-by: Junio C Hamano <junkio@cox.net>
Documentation/git-pack-objects.txt
Documentation/git-repack.txt

index d4661ddc2f84c1392b32ad3fdf5f4ebe5b465e00..f52e8fa8bfb6cd1b121eab7e8594368f5b1c6513 100644 (file)
@@ -71,11 +71,11 @@ base-name::
 --all::
        This implies `--revs`.  In addition to the list of
        revision arguments read from the standard input, pretend
-       as if all refs under `$GIT_DIR/refs` are specifed to be
+       as if all refs under `$GIT_DIR/refs` are specified to be
        included.
 
---window and --depth::
-       These two options affects how the objects contained in
+--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
        optionally names and compared against the other objects
@@ -84,6 +84,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.
+       The default value for both --window and --depth is 10.
 
 --incremental::
        This flag causes an object already in a pack ignored
index 49f7e0a4a446b8e393b76f39136f28c74c085dff..d2eaa0995ded915f89d436e4501c5ae667822642 100644 (file)
@@ -57,13 +57,14 @@ OPTIONS
         `git update-server-info`.
 
 --window=[N], --depth=[N]::
-       These two options affects how the objects contained in the pack are
+       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 optionally names and compared against the
        other objects within `--window` to see if using delta compression saves
        space. `--depth` limits the maximum delta depth; making 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.
 
 
 Author