development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-08-26 19:19:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

subtree: t7900: comment subtree_test_create_repo

Browse source 
It's unclear what the purpose of t7900-subtree.sh's
`subtree_test_create_repo` helper function is.  It wraps test-lib.sh's,
`test_create_repo` but follows that up by setting log.date=relative.  Why
does it set log.date=relative?

My first guess was that at one point the tests required that, but no
longer do, and that the function is now vestigial.  I even wrote a patch
to get rid of it and was moments away from `git send-email`ing it.

However, by chance when looking for something else in the history, I
discovered the true reason, from e7aac44ed2 (contrib/subtree: ignore
log.date configuration, 2015-07-21).  It's testing that setting
log.date=relative doesn't break `git subtree`, as at one point in the past
that did break `git subtree`.

So, add a comment about this, to avoid future such confusion.

And while at it, go ahead and (1) touch up the function to avoid a
pointless subshell and (2) update the one test that didn't use it.

Signed-off-by: Luke Shumaker <lukeshu@datawire.io>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Luke Shumaker 2021-04-27 15:17:23 -06:00 committed by Junio C Hamano
parent f700406957
commit 40b1e1ec58
1 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
contrib/subtree/t/t7900-subtree.sh
View file

@ -13,12 +13,14 @@ TEST_DIRECTORY=$(pwd)/../../../t
export TEST_DIRECTORY
. "$TEST_DIRECTORY"/test-lib.sh
# Use our own wrapper around test-lib.sh's test_create_repo, in order
# to set log.date=relative. `git subtree` parses the output of `git
# log`, and so it must be careful to not be affected by settings that
# change the `git log` output. We test this by setting
# log.date=relative for every repo in the tests.
subtree_test_create_repo () {
test_create_repo "$1" &&
(
cd "$1" &&
git config log.date relative
)
git -C "$1" config log.date relative
}
create () {
@ -242,8 +244,8 @@ test_expect_success 'merge the added subproj again, should do nothing' '
'
test_expect_success 'merge new subproj history into subdir/ with a slash appended to the argument of --prefix' '
test_create_repo "$test_count" &&
test_create_repo "$test_count/subproj" &&
subtree_test_create_repo "$test_count" &&
subtree_test_create_repo "$test_count/subproj" &&
test_create_commit "$test_count" main1 &&
test_create_commit "$test_count/subproj" sub1 &&
(