Re: [PATCH 2/3] sha1dc: use sha1collisiondetection as a submodule

From: Junio C Hamano <gitster@pobox.com>
Date: May 20, 2017, 11:13 UTC
Message-ID: <xmqqpof3srw4.fsf@gitster.mtv.corp.google.com>
In-Reply-To: <20170518212858.3649-3-avarab@gmail.com>

Ævar Arnfjörð Bjarmason  <avarab@gmail.com> writes:

Show 22 quoted lines

> Replace the forked sha1dc directory with a copy of the upstream code
> imported as a submodule. This is the exact same code as now exists in
> the sha1dc/ directory.
>
> The initial reason for copy/pasting the code into sha1dc and locally
> modifying it was that it needed to be altered to work with the git
> project.
>
> The upstream project has accepted my code changes to allow us to use
> their code as-is, see the preceding commit for details. So import the
> code as a submodule instead, this will make it easier to keep
> up-to-date with any upstream fixes or improvements.
>
> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
> ---
>  .gitmodules            | 4 ++++
>  Makefile               | 4 ++--
>  hash.h                 | 2 +-
>  sha1collisiondetection | 1 +
>  4 files changed, 8 insertions(+), 3 deletions(-)
>  create mode 100644 .gitmodules
>  create mode 160000 sha1collisiondetection

I am not sure how prepared our .travis.yml is to deal with a submodule, I'd prefer to have this step broken down to two step process.

That is, [PATCH 2.1/3] first adds an otherwise unused submodule, so that people can optionally do "git submodule init && git submodule update" so that they can compare the contents of sha1dc/ that has been updated by [PATCH 1/3] with the up-to-date upstream. Then [PATCH 2.2/3] would update the Makefile and hash.h to use the code in the submodule.

I actually would want to see us proceed even more cautiously---if the latter-half, i.e. [PATCH 2.2/3], is arranged so that it uses the new sha1collisiondetection/ only when the submodule is initialized and populated, and otherwise it uses sha1dc/ as before, I would feel a lot safer. I wouldn't be this paranoid if this "let's start using submodule ourselves" were done to some optional corner (like compat/ or contrib/ somewhere), but this is the default hash function. I do want to have something like this to force us (and submodule folks) to get any kinks out, but I do not want to see many people not even be able to build while this new arrangement is eased in. Once people are comfortable with the new arrangement to use code from submodule, we can then take [PATCH 3/3] to remove the old sha1dc/ directory and the migration will be complete.

I also am not very happy with .gitmodules pointing at a single point of failure. It would be nice if you can arrange a couple of mirrors and have a comment in .gitmodules file to tell folks that they can use these alternates by insteadOf or some other mechanism.

Thanks.