diff options
| author | David Bremner <david@tethera.net> | 2021-04-25 12:23:52 -0300 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2021-04-28 08:49:07 -0300 |
| commit | 6a20478abb517a8c6c046a1ff640fa02d118aa88 (patch) | |
| tree | f7ecda7fb110857eeb10d9c7052d51351937a291 /performance-test/README | |
| parent | 9e2e723881029d5041c4a34845a0265bbf144e02 (diff) | |
perf-test: add option to run perf
Although the generation of perf data is not as slow as valgrind, it
seems simplest to re-use the machinery already there to save the logs
in a timestamped subdirectory.
Diffstat (limited to 'performance-test/README')
| -rw-r--r-- | performance-test/README | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/performance-test/README b/performance-test/README index fbc61028..59b37b1b 100644 --- a/performance-test/README +++ b/performance-test/README @@ -16,6 +16,7 @@ In addition to having notmuch, you need: - xz. Some speedup can be gotten by installing "pixz", but this is probably only worthwhile if you are debugging the tests. - valgrind (for the memory tests) +- perf (optional, for more fine-grained timing) Getting set up to run tests: ---------------------------- @@ -56,11 +57,24 @@ supports the following arguments --small / --medium / --large Choose corpus size. --debug Enable debugging. In particular don't delete - temporary directories. + temporary directories. +--perf Run perf record in place of /usr/bin/time. Perf output can be + found in a log directory. +--call-graph {fp,lbr,dwarf} Call graph option for perf record. Default is 'lbr'. When using the make targets, you can pass arguments to all test scripts by defining the make variable OPTIONS. +Log Directory +------------- + +The memory tests, and the time tests when option '--perf' is given +save their output in a directory named as follows + + log.$test_name-$corpus_size-$timestamp + +These directories are removed by "make clean". + Writing tests ------------- |