tree 9f3b2ed3cd4924dfb114944516616fb44f458d39
parent de11951b0393500cbf20d3e2bcd2e605d757ea8f
author Derrick Stolee <dstolee@microsoft.com> 1577719993 +0000
committer Junio C Hamano <gitster@pobox.com> 1577725640 -0800

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>