t1092: document bad sparse-checkout behavior
commite5ca291076a8a936283bb2c57433c4393d3f80c2
authorDerrick Stolee <dstolee@microsoft.com>
Wed, 14 Jul 2021 13:12:40 +0000 (14 13:12 +0000)
committerJunio C Hamano <gitster@pobox.com>
Wed, 14 Jul 2021 20:42:49 +0000 (14 13:42 -0700)
treee0e4b682ea3edd496dd42501e0656dff54bb93af
parentf8fe49e53958f19b0e62e9549a80fcaa56d2f3cf
t1092: document bad sparse-checkout behavior

There are several situations where a repository with sparse-checkout
enabled will act differently than a normal repository, and in ways that
are not intentional. The test t1092-sparse-checkout-compatibility.sh
documents some of these deviations, but a casual reader might think
these are intentional behavior changes.

Add comments on these tests that make it clear that these behaviors
should be updated. Using 'NEEDSWORK' helps contributors find that these
are potential areas for improvement.

Helped-by: Elijah Newren <newren@gmail.com>
Reviewed-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
t/t1092-sparse-checkout-compatibility.sh