X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=performance-test%2FREADME;h=fbc61028d2db4dfdc204cd4a78e2613cadd78c3c;hp=996724cdf9472b0cb110446402d97e199668ca0e;hb=HEAD;hpb=098ef4af4d0a52a6b4daed5324a7c77f6c9108da

diff --git a/performance-test/README b/performance-test/README
index 996724cd..1ca0df2f 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:
 ----------------------------
@@ -23,11 +24,11 @@ Getting set up to run tests:
 First, you need to get the corpus.  If you don't already have the gpg
 key for David Bremner, run
 
-   % gpg --search 'david@tethera.net'
+   % gpg --locate-external-key 'david@tethera.net'
 
 This should get you a key with fingerprint
 
-    815B 6398 2A79 F8E7 C727  86C4 762B 57BB 7842 06AD
+    7A18 807F 100A 4570 C596  8420 7E4E 65C8 720B 706B
 
 (the last 8 digits are printed as the "key id").
 
@@ -37,7 +38,7 @@ To fetch the actual corpus it should work to run
 
 In case that fails or is too slow, check
 
-   http://notmuchmail.org/corpus
+   https://notmuchmail.org/corpus
 
 for a list of mirrors.
 
@@ -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
 -------------