diff mbox series

repack: document there is no need to avoid delta-base-offset

Message ID xmqqbktk93kl.fsf_-_@gitster.g (mailing list archive)
State New, archived
Headers show
Series repack: document there is no need to avoid delta-base-offset | expand

Commit Message

Junio C Hamano July 19, 2022, 9:48 p.m. UTC
As continued use of 1.4.4 by people stopped being an issue long time
ago, we can safely remove the warning about interoperability that we
added in 1.6.0 when the use of delta-base-offset has become default.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
---

 * Instead of outright removing, it probably is a good idea to hint
   the reason why the now seemingly useless configuration variable
   is there, perhaps.

 Documentation/git-repack.txt | 14 +++++---------
 1 file changed, 5 insertions(+), 9 deletions(-)

Comments

Ævar Arnfjörð Bjarmason July 19, 2022, 9:54 p.m. UTC | #1
On Tue, Jul 19 2022, Junio C Hamano wrote:

> As continued use of 1.4.4 by people stopped being an issue long time
> ago, we can safely remove the warning about interoperability that we
> added in 1.6.0 when the use of delta-base-offset has become default.
>
> Signed-off-by: Junio C Hamano <gitster@pobox.com>
> ---
>
>  * Instead of outright removing, it probably is a good idea to hint
>    the reason why the now seemingly useless configuration variable
>    is there, perhaps.

We cover that in git-config(1), I don't see a reason to continue
dicsussing it in git-repack(1) as well. Just above the paragraph you're
modifying we link to it.

The patch you've got here also replaces a specific reason (pre-1.4.4)
with a vague reference to "hardly any reason", leaving the reader
wondering what that reason is...
Junio C Hamano July 19, 2022, 10:20 p.m. UTC | #2
Ævar Arnfjörð Bjarmason <avarab@gmail.com> writes:

> On Tue, Jul 19 2022, Junio C Hamano wrote:
>
>> As continued use of 1.4.4 by people stopped being an issue long time
>> ago, we can safely remove the warning about interoperability that we
>> added in 1.6.0 when the use of delta-base-offset has become default.
>>
>> Signed-off-by: Junio C Hamano <gitster@pobox.com>
>> ---
>>
>>  * Instead of outright removing, it probably is a good idea to hint
>>    the reason why the now seemingly useless configuration variable
>>    is there, perhaps.
>
> We cover that in git-config(1), I don't see a reason to continue
> dicsussing it in git-repack(1) as well. Just above the paragraph you're
> modifying we link to it.
>
> The patch you've got here also replaces a specific reason (pre-1.4.4)
> with a vague reference to "hardly any reason", leaving the reader
> wondering what that reason is...

Yup, that is the effect I exactly wanted to have, with the "hint".
If you are curious, you'd dig.  If not, you can just trust the
documentation and not worry about it ;-)
diff mbox series

Patch

diff --git c/Documentation/git-repack.txt w/Documentation/git-repack.txt
index 0bf13893d8..882904fc7b 100644
--- c/Documentation/git-repack.txt
+++ w/Documentation/git-repack.txt
@@ -218,15 +218,11 @@  CONFIGURATION
 Various configuration variables affect packing, see
 linkgit:git-config[1] (search for "pack" and "delta").
 
-By default, the command passes `--delta-base-offset` option to
-'git pack-objects'; this typically results in slightly smaller packs,
-but the generated packs are incompatible with versions of Git older than
-version 1.4.4. If you need to share your repository with such ancient Git
-versions, either directly or via the dumb http protocol, then you
-need to set the configuration variable `repack.UseDeltaBaseOffset` to
-"false" and repack. Access from old Git versions over the native protocol
-is unaffected by this option as the conversion is performed on the fly
-as needed in that case.
+By default, the command passes `--delta-base-offset` option to 'git
+pack-objects', which results in packs smaller by a few per-cent.
+The configuration variable `repack.UseDeltaBaseOffset` can be set to
+`false` to disable it, but these days there hardly is any reason to
+do so.
 
 Delta compression is not used on objects larger than the
 `core.bigFileThreshold` configuration variable and on files with the