perf-test: rename current tests as "time tests"

[notmuch] / performance-test / README

diff --git a/performance-test/README b/performance-test/README
index d36612d7b5fcf2cd60fb8789758481d020d497c2..d1fb6de4cfa742942998045b5b0da7a8c5a70b20 100644 (file)
--- a/performance-test/README
+++ b/performance-test/README
@@ -36,8 +36,8 @@ for a list of mirrors.
 Running tests
 -------------
 
-The easiest way to run performance tests is to say "make perf-test", (or
-simply run the notmuch-perf-test script). Either command will run all
+The easiest way to run performance tests is to say "make time-test", (or
+simply run the notmuch-time-test script). Either command will run all
 available performance tests.
 
 Alternately, you can run a specific subset of tests by simply invoking
@@ -51,8 +51,8 @@ Each test script supports the following arguments
 Writing tests
 -------------
 
-Have a look at "basic" for an example. Sourcing "perf-test-lib.sh" is
-mandatory.  Utility functions include
+Have a look at "T01-dump-restore" for an example. Sourcing
+"perf-test-lib.sh" is mandatory.  Utility functions include
 
 - 'add_email_corpus' unpacks a set of messages and adds them to the database.
 - 'cache_database': makes a snapshot of the current database
@@ -62,3 +62,8 @@ mandatory.  Utility functions include
    cannot find a cache of the appropriate corpus.
 - 'time_done' does the cleanup; comment it out or pass --debug to the
   script to leave the temporary files around.
+
+Scripts are run in the order specified in notmuch-perf-test. In the
+future this order might be chosen automatically so please follow the
+convention of starting the name with 'T' followed by two digits to
+specify the order.