fsmonitor: update GIT_TEST_FSMONITOR support
PATCH 1/1 fsmonitor: update GIT_TEST_FSMONITOR support
Rename GIT_FSMONITOR_TEST to GIT_TEST_FSMONITOR for consistency with the other GIT_TEST_ special setups and properly document its use.
---
Notes:
Base Ref: v2.19.0
Web-Diff: https://github.com/benpeart/git/commit/311484a684
Checkout: git fetch https://github.com/benpeart/git git-test-fsmonitor-v1 && git checkout 311484a684config.c | 2 +- t/README | 4 ++++ t/t1700-split-index.sh | 2 +- t/t7519-status-fsmonitor.sh | 2 +- 4 files changed, 7 insertions(+), 3 deletions(-)
config.c +1 -1
@@ -2278,7 +2278,7 @@ int git_config_get_max_percent_split_change(void)int git_config_get_fsmonitor (void ) {if (git_config_get_pathname ("core.fsmonitor" , &core_fsmonitor)) - core_fsmonitor =getenv ("GIT_FSMONITOR_TEST" ); + core_fsmonitor =getenv ("GIT_TEST_FSMONITOR" );if (core_fsmonitor && !*core_fsmonitor) core_fsmonitor =NULL ;
t/README +4 -0
@@ -319,6 +319,10 @@ GIT_TEST_OE_DELTA_SIZE=<n> exercises the uncomon pack-objects code path where deltas larger than this limit require extra memory allocation for bookkeeping. +GIT_TEST_FSMONITOR=$PWD/t7519/fsmonitor-all exercises the fsmonitor +code path for utilizing a file system monitor to speed up detecting +new or changed files. + Naming Tests ------------
t/t1700-split-index.sh +1 -1
@@ -6,7 +6,7 @@ test_description='split index mode tests' # We need total control of index splitting here sane_unset GIT_TEST_SPLIT_INDEX -sane_unset GIT_FSMONITOR_TEST +sane_unset GIT_TEST_FSMONITOR test_expect_success 'enable split index' ' git config splitIndex.maxPercentChange 100 &&
t/t7519-status-fsmonitor.sh +1 -1
@@ -8,7 +8,7 @@ test_description='git status with file system watcher' # To run the entire git test suite using fsmonitor: # # copy t/t7519/fsmonitor-all to a location in your path and then set -# GIT_FSMONITOR_TEST=fsmonitor-all and run your tests. +# GIT_TEST_FSMONITOR=fsmonitor-all and run your tests. # # Note, after "git reset --hard HEAD" no extensions exist other than 'TREE'
base-commit: 1d4361b0f344188ab5eec6dcea01f61a3a3a1670
Signature · 1 line
2.18.0.windows.1
Quoted 2 lines · Ben Peart
Rename
GIT_FSMONITOR_TESTtoGIT_TEST_FSMONITORfor consistency with the otherGIT_TEST_special setups and properly document its use.
Makes sense.
Thanks for such an attention to detail.
Quoted 71 lines
Signed-off-by Ben Peart <[email protected]>---
Notes:
Base Ref: v2.19.0 Web-Diff: https://github.com/benpeart/git/commit/311484a684 Checkout: git fetch https://github.com/benpeart/git git-test-fsmonitor-v1 && git checkout 311484a684config.c | 2 +- t/README | 4 ++++ t/t1700-split-index.sh | 2 +- t/t7519-status-fsmonitor.sh | 2 +- 4 files changed, 7 insertions(+), 3 deletions(-)config.c +1
-1@@ -2278,7 +2278,7 @@ int git_config_get_max_percent_split_change(void)int git_config_get_fsmonitor (void ) {if (git_config_get_pathname ("core.fsmonitor" , &core_fsmonitor)) - core_fsmonitor =getenv ("GIT_FSMONITOR_TEST" ); + core_fsmonitor =getenv ("GIT_TEST_FSMONITOR" );if (core_fsmonitor && !*core_fsmonitor) core_fsmonitor =NULL ;t/README +4
-0@@ -319,6 +319,10 @@ GIT_TEST_OE_DELTA_SIZE=<n> exercises the uncomon pack-objects code path where deltas larger than this limit require extra memory allocation for bookkeeping. +GIT_TEST_FSMONITOR=$PWD/t7519/fsmonitor-all exercises the fsmonitor +code path for utilizing a file system monitor to speed up detecting +new or changed files. + Naming Tests ------------t/t1700-split-index.sh +1
-1@@ -6,7 +6,7 @@ test_description='split index mode tests' # We need total control of index splitting here sane_unset GIT_TEST_SPLIT_INDEX -sane_unset GIT_FSMONITOR_TEST +sane_unset GIT_TEST_FSMONITOR test_expect_success 'enable split index' ' git config splitIndex.maxPercentChange 100 &&t/t7519-status-fsmonitor.sh +1
-1@@ -8,7 +8,7 @@ test_description='git status with file system watcher' # To run the entire git test suite using fsmonitor: # # copy t/t7519/fsmonitor-all to a location in your path and then set -# GIT_FSMONITOR_TEST=fsmonitor-all and run your tests. +# GIT_TEST_FSMONITOR=fsmonitor-all and run your tests. # # Note, after "git reset --hard HEAD" no extensions exist other than 'TREE'base-commit:
1d4361b0f344188ab5eec6dcea01f61a3a3a1670
Quoted 18 lines · Ben Peart
config.c +1
-1@@ -2278,7 +2278,7 @@ int git_config_get_max_percent_split_change(void)int git_config_get_fsmonitor (void ) {if (git_config_get_pathname ("core.fsmonitor" , &core_fsmonitor)) - core_fsmonitor =getenv ("GIT_FSMONITOR_TEST" ); + core_fsmonitor =getenv ("GIT_TEST_FSMONITOR" );if (core_fsmonitor && !*core_fsmonitor) core_fsmonitor =NULL ;t/README +0
-0
t/README GIT_TEST_OE_DELTA_SIZE=<n> exercises the uncomon pack-objects code · line 327
Quoted 9 lines
t/README +4
-0@@ -319,6 +319,10 @@ GIT_TEST_OE_DELTA_SIZE=<n> exercises the uncomon pack-objects code path where deltas larger than this limit require extra memory allocation for bookkeeping. +GIT_TEST_FSMONITOR=$PWD/t7519/fsmonitor-all exercises the fsmonitor +code path for utilizing a file system monitor to speed up detecting +new or changed files. + Naming Tests ------------
I've seen this & will watch out for it, but still, when I'm updating to "next" in a couple of months I may not be tracking the exact state of the integration of this patch, and then running with GIT_FSMONITOR_TEST=... will suddenly be a noop.
So maybe something like this to test-lib.sh as well (or directly in config.c):
if test -n "$GIT_FSMONITOR_TEST"
then
echo "The GIT_FSMONITOR_TEST variable has been renamed to GIT_TEST_FSMONITOR" exit 1
fi
Maybe I'm being too nitpicky and there's only two of us who run the test with this anyway, and we can deal with it.
It just rubs me the wrong way that we have a test mode that silently stops being picked up because a command-line option or env variable got renamed, especially since we've had it for 4 stable releases, especially since it's so easy for us to avoid that confusion (just die), v.s. potential time wasted downstream (wondering why fsmonitor stuff broke on $SOME_OS even though we're testing for it during package build...).
Quoted 39 lines · Ævar Arnfjörð Bjarmason
Quoted 18 lines · Ben Peart
config.c +1
-1@@ -2278,7 +2278,7 @@ int git_config_get_max_percent_split_change(void)int git_config_get_fsmonitor (void ) {if (git_config_get_pathname ("core.fsmonitor" , &core_fsmonitor)) - core_fsmonitor =getenv ("GIT_FSMONITOR_TEST" ); + core_fsmonitor =getenv ("GIT_TEST_FSMONITOR" );if (core_fsmonitor && !*core_fsmonitor) core_fsmonitor =NULL ;t/README +0
-0t/README GIT_TEST_OE_DELTA_SIZE=<n> exercises the uncomon pack-objects code · line 327
Quoted 9 lines
t/README +4
-0@@ -319,6 +319,10 @@ GIT_TEST_OE_DELTA_SIZE=<n> exercises the uncomon pack-objects code path where deltas larger than this limit require extra memory allocation for bookkeeping. +GIT_TEST_FSMONITOR=$PWD/t7519/fsmonitor-all exercises the fsmonitor +code path for utilizing a file system monitor to speed up detecting +new or changed files. + Naming Tests ------------I've seen this & will watch out for it, but still, when I'm updating to "next" in a couple of months I may not be tracking the exact state of the integration of this patch, and then running with GIT_FSMONITOR_TEST=... will suddenly be a noop.
So maybe something like this to
test-lib.shas well (or directly inconfig.c):
Quoted 9 lines
if test -n "$GIT_FSMONITOR_TEST"
then
echo "TheGIT_FSMONITOR_TESTvariable has been renamed toGIT_TEST_FSMONITOR" exit 1
fiMaybe I'm being too nitpicky and there's only two of us who run the test with this anyway, and we can deal with it.
I agree that there are probably only 2 people in the world who ever used this but I'm happy to add the additional test to make it obvious it has been renamed.
Quoted 8 lines
It just rubs me the wrong way that we have a test mode that silently stops being picked up because a command-line option or env variable got renamed, especially since we've had it for 4 stable releases, especially since it's so easy for us to avoid that confusion (just die), v.s. potential time wasted downstream (wondering why fsmonitor stuff broke on $SOME_OS even though we're testing for it during package build...).