Doc: explain submodule.alternateErrorStrategy
authorJonathan Tan <jonathantanmy@google.com>
Mon, 2 Dec 2019 19:57:51 +0000 (11:57 -0800)
committerJunio C Hamano <gitster@pobox.com>
Tue, 3 Dec 2019 16:49:41 +0000 (08:49 -0800)
commit10c64a0b3c15391180c31d1217ba01d687558757
treecec60ba88603777298a6cb766ad5723b8803dc54
parentd9f6f3b6195a0ca35642561e530798ad1469bd41
Doc: explain submodule.alternateErrorStrategy

Commit 31224cbdc7 ("clone: recursive and reference option triggers
submodule alternates", 2016-08-17) taught Git to support the
configuration options "submodule.alternateLocation" and
"submodule.alternateErrorStrategy" on a superproject.

If "submodule.alternateLocation" is configured to "superproject" on a
superproject, whenever a submodule of that superproject is cloned, it
instead computes the analogous alternate path for that submodule from
$GIT_DIR/objects/info/alternates of the superproject, and references it.

The "submodule.alternateErrorStrategy" option determines what happens
if that alternate cannot be referenced. However, it is not clear that
the clone proceeds as if no alternate was specified when that option is
not set to "die" (as can be seen in the tests in 31224cbdc7). Therefore,
document it accordingly.

Signed-off-by: Jonathan Tan <jonathantanmy@google.com>
Acked-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/config/submodule.txt