From 8f199099fee2463abd4847d9565f3f1eae437356 Mon Sep 17 00:00:00 2001
From: "Kyle J. McKay" <mackyle@gmail.com>
Date: Tue, 15 Jun 2021 06:56:31 -0700
Subject: [PATCH] Girocco/Config.pm: add jgit_compatible_bitmaps note

Since the JGit v3.5.0 release in late 2014, JGit can deal with
Git's bitmap hash cache.  In fact, since Git v2.22.0 (released
2019-06-07), Git enables the hash cache by default since that's
approximately 5 years since JGit learned to deal with it.

Mention this information in the comments for the obscure
$Girocco::Config::jgit_compatible_bitmaps setting to provide more
guidance about when it may actually need to be activated.

Signed-off-by: Kyle J. McKay <mackyle@gmail.com>
---
 Girocco/Config.pm | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/Girocco/Config.pm b/Girocco/Config.pm
index 1441bb9..5ee3e52 100644
--- a/Girocco/Config.pm
+++ b/Girocco/Config.pm
@@ -1174,15 +1174,18 @@ our $ctags_owning_group = undef;
 
 # When using pack bitmaps and computing data to send to clients over a fetch,
 # having pack.writeBitmapHashCache set to true produces better deltas (thereby
-# potentially reducing the amount of data that needs to be sent).  However,
+# potentially reducing the amount of data that needs to be sent).  However, old
 # JGit does not understand this extra data, so if JGit needs to use the bitmaps
 # generated when Girocco runs Git, this setting needs to be set to a true value
 # so that the hash cache is excluded when Git generates the bitmaps thereby
-# making them compatible with JGit.
+# making them compatible with JGit prior to JGit v3.5.0 released in late 2014.
 # Note that changes to this setting will not take effect until the next time
 # gc is scheduled to run on a project and then only if gc actually takes place.
 # Use the $basedir/toolbox/make-all-gc-eligible.sh script to force all projects
 # to actually do a gc the next time they are scheduled for one.
+# (Note that Git version 2.22.0, released 2019-06-07, enabled the HashCache by
+# default since it post dates the JGit v3.5.0 release by approximately 5 years
+# [that corresponds to a setting of undef or 0 here].)
 # RECOMMENDED VALUE: undef or 0
 our $jgit_compatible_bitmaps = 0;
 
-- 
2.11.4.GIT