X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=performance-test%2FREADME;h=14816602125ebb16aef829335b56a935601fba66;hp=d36612d7b5fcf2cd60fb8789758481d020d497c2;hb=1e12b91b3cf823d21f7edf8c0f1c687df56fec14;hpb=d7ba84dfad83c5a6d588221a31f067fea484dc07 diff --git a/performance-test/README b/performance-test/README index d36612d7..14816602 100644 --- a/performance-test/README +++ b/performance-test/README @@ -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 "01-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,7 @@ 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 two digits to specify the order.