Merge branch 'jk/reduce-gc-aggressive-depth'
[gitweb.git] / t / perf / README
index b2dbad4d502a0d88269885eb56780deb3079b42c..49ea4349bedfc53b5b565cf1102c74ccb93ab653 100644 (file)
@@ -56,7 +56,7 @@ You can set the following variables (also in your config.mak):
 
     GIT_PERF_REPEAT_COUNT
        Number of times a test should be repeated for best-of-N
-       measurements.  Defaults to 5.
+       measurements.  Defaults to 3.
 
     GIT_PERF_MAKE_OPTS
        Options to use when automatically building a git tree for
@@ -66,7 +66,7 @@ You can set the following variables (also in your config.mak):
     GIT_PERF_LARGE_REPO
        Repositories to copy for the performance tests.  The normal
        repo should be at least git.git size.  The large repo should
-       probably be about linux-2.6.git size for optimal results.
+       probably be about linux.git size for optimal results.
        Both default to the git.git you are running from.
 
 You can also pass the options taken by ordinary git tests; the most
@@ -115,8 +115,16 @@ After that you will want to use some of the following:
 
 At least one of the first two is required!
 
-You can use test_expect_success as usual.  For actual performance
-tests, use
+You can use test_expect_success as usual. In both test_expect_success
+and in test_perf, running "git" points to the version that is being
+perf-tested. The $MODERN_GIT variable points to the git wrapper for the
+currently checked-out version (i.e., the one that matches the t/perf
+scripts you are running).  This is useful if your setup uses commands
+that only work with newer versions of git than what you might want to
+test (but obviously your new commands must still create a state that can
+be used by the older version of git you are testing).
+
+For actual performance tests, use
 
        test_perf 'descriptive string' '
                command1 &&