sparse-checkout: document interactions with submodules
commit4fd683b6a35eabd23dd5183da7f654a1e1f00325
authorDerrick Stolee <dstolee@microsoft.com>
Mon, 30 Dec 2019 15:33:13 +0000 (30 15:33 +0000)
committerJunio C Hamano <gitster@pobox.com>
Mon, 30 Dec 2019 17:07:20 +0000 (30 09:07 -0800)
tree9f3b2ed3cd4924dfb114944516616fb44f458d39
parentde11951b0393500cbf20d3e2bcd2e605d757ea8f
sparse-checkout: document interactions with submodules

Using 'git submodule (init|deinit)' a user can select a subset of
submodules to populate. This behaves very similar to the sparse-checkout
feature, but those directories contain their own .git directory
including an object database and ref space. To have the sparse-checkout
file also determine if those files should exist would easily cause
problems. Therefore, keeping these features independent in this way
is the best way forward.

Also create a test that demonstrates this behavior to make sure
it doesn't change as the sparse-checkout feature evolves.

Reported-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-sparse-checkout.txt
t/t1091-sparse-checkout-builtin.sh