Skip to content

Commit c14f372

Browse files
committed
Doc: mention --delta-base-offset is the default for Porcelain commands
The underlying pack-objects plumbing command still needs an explicit option from the command line, but these days Porcelain passes the option, so there is no need for end users to worry about it anymore. Signed-off-by: Junio C Hamano <[email protected]>
1 parent 094574b commit c14f372

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

Documentation/git-pack-objects.txt

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,13 +192,18 @@ self-contained. Use `git index-pack --fix-thin`
192192
--delta-base-offset::
193193
A packed archive can express the base object of a delta as
194194
either a 20-byte object name or as an offset in the
195-
stream, but older versions of git don't understand the
195+
stream, but ancient versions of git don't understand the
196196
latter. By default, 'git pack-objects' only uses the
197197
former format for better compatibility. This option
198198
allows the command to use the latter format for
199199
compactness. Depending on the average delta chain
200200
length, this option typically shrinks the resulting
201201
packfile by 3-5 per-cent.
202+
+
203+
Note: Porcelain commands such as `git gc` (see linkgit:git-gc[1]),
204+
`git repack` (see linkgit:git-repack[1]) pass this option by default
205+
in modern git when they put objects in your repository into pack files.
206+
So does `git bundle` (see linkgit:git-bundle[1]) when it creates a bundle.
202207

203208
--threads=<n>::
204209
Specifies the number of threads to spawn when searching for best

0 commit comments

Comments
 (0)