debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-12-22 09:24:54 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

perf-test: update README

Browse source 
Describe new argument parsing and mention cache handling routines.
This commit is contained in:
David Bremner 2012-12-05 08:48:50 -04:00
parent ceaf5ca6c0
commit d7ba84dfad
1 changed files with 15 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
performance-test/README
View file

@ -42,17 +42,23 @@ available performance tests.
Alternately, you can run a specific subset of tests by simply invoking Alternately, you can run a specific subset of tests by simply invoking
one of the executable scripts in this directory, (such as ./basic). one of the executable scripts in this directory, (such as ./basic).
Each test script supports the following arguments
--small / --medium / --large Choose corpus size.
--debug Enable debugging. In particular don't delete
temporary directories.
Writing tests Writing tests
------------- -------------
Have a look at "basic" for an example. Have a look at "basic" for an example. Sourcing "perf-test-lib.sh" is
mandatory. Utility functions include
add_email_corpus takes arguments "--small" and "--medium" for when you - 'add_email_corpus' unpacks a set of messages and adds them to the database.
want smaller subsets of the corpus to check. - 'cache_database': makes a snapshot of the current database
- 'uncache_database': forces the next 'add_email_corpus' to rebuild the
time_done does the cleanup; comment it out or define "$debug" to leave database.
the temporary files around. - 'time_start' unpacks the mail corpus and calls notmuch new if it
cannot find a cache of the appropriate corpus.
Currently there is no option processing (e.g. --debug) in the - 'time_done' does the cleanup; comment it out or pass --debug to the
performance tests. script to leave the temporary files around.