Re: [PATCH] git-pack-objects.txt: fix grammatical errors

[Junio C Hamano <gitster@pobox.com>]

Nicolas Pitre <nico@fluxnic.net> writes:

>> diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt
>> index a51071e..442018b 100644
>> --- a/Documentation/git-pack-objects.txt
>> +++ b/Documentation/git-pack-objects.txt
>> @@ -190,9 +190,9 @@ 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 the base object of a delta as
>> +	either a 20-byte object name or as an offset in the
>> +	stream, but older 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
>
> This is misleading and not even true anymore if not using pack-objects.  
> Most people are using either 'git repack' or even 'git gc', and the 
> default is to use this parameter since commit 22c79eab.

This page is on the pack-objects plumbing, and in that context there is
nothing misleading nor false about it.

We may however want to do something like the attached to help people who
might wonder how to pass this option through the Porcelain they use.  In
the longer term, it probably makes sense to make the option default at a
version bump, perhaps at the 1.8.0 boundary.


 Documentation/git-pack-objects.txt |    7 ++++++-
 1 files changed, 6 insertions(+), 1 deletions(-)

diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt
index a9c373c..96684bc 100644
--- a/Documentation/git-pack-objects.txt
+++ b/Documentation/git-pack-objects.txt
@@ -192,13 +192,18 @@ self-contained. Use `git index-pack --fix-thin`
 --delta-base-offset::
 	A packed archive can express the base object of a delta as
 	either a 20-byte object name or as an offset in the
-	stream, but older versions of git don't understand 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