@matheusbsbs / matheus-bagliano / commits / 3df196716e
Fork 0

Add default values for --window and --depth to the docs

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>

Dennis Stosberg committed Oct 6, 2006 at 11:15 UTC 3df196716eb89e752c96cf252d5c712387a7c112
2 files changed +6 -4
Documentation/git-pack-objects.txt
+4 -3
@@ -71,11 +71,11 @@ base-name::
71 --all::
72 This implies `--revs`. In addition to the list of
73 revision arguments read from the standard input, pretend
74 - as if all refs under `$GIT_DIR/refs` are specifed to be
74 + as if all refs under `$GIT_DIR/refs` are specified to be
75 included.
76
77 ---window and --depth::
78 - These two options affects how the objects contained in
77 +--window=[N], --depth=[N]::
78 + These two options affect how the objects contained in
79 the pack are stored using delta compression. The
80 objects are first internally sorted by type, size and
81 optionally names and compared against the other objects
@@ -84,6 +84,7 @@ base-name::
84 it too deep affects the performance on the unpacker
85 side, because delta data needs to be applied that many
86 times to get to the necessary object.
87 + The default value for both --window and --depth is 10.
88
89 --incremental::
90 This flag causes an object already in a pack ignored
Documentation/git-repack.txt
+2 -1
@@ -57,13 +57,14 @@ OPTIONS
57 `git update-server-info`.
58
59 --window=[N], --depth=[N]::
60 - These two options affects how the objects contained in the pack are
60 + These two options affect how the objects contained in the pack are
61 stored using delta compression. The objects are first internally
62 sorted by type, size and optionally names and compared against the
63 other objects within `--window` to see if using delta compression saves
64 space. `--depth` limits the maximum delta depth; making it too deep
65 affects the performance on the unpacker side, because delta data needs
66 to be applied that many times to get to the necessary object.
67 + The default value for both --window and --depth is 10.
68
69
70 Author