unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
blob 239d2fbdf90af64ee243f4aefa8918f5e0dc8164 1169 bytes (raw)
name: performance-test/README 	 # note: path name is non-authoritative(*)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
Pre-requisites
--------------

In addition to having notmuch, you need:

- gpg
- gnu tar
- gnu time
- xz. Some speedup can be gotten by installing "pixz", but this is
  probably only worthwhile if you are debugging the tests.

Getting set up to run tests:
----------------------------

First, you need to get the corpus.

It should work to run

   % make download-corpus

In case that fails or is too slow, check

   http://notmuchmail.org/corpus

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
available performance tests.

Alternately, you can run a specific subset of tests by simply invoking
one of the executable scripts in this directory, (such as ./basic).


Writing tests
-------------

Have a look at "basic" for an example.

add_email_corpus takes arguments "--small" and "--medium" for when you
want smaller corpuses to check.

time_done does the cleanup; comment it out or define "$debug" to leave
the temporary files around.

Currently there is no option processing (e.g. --debug) in the
performance tests.

debug log:

solving 239d2fb ...
found 239d2fb in https://yhetil.org/notmuch/1353855745-11697-3-git-send-email-david@tethera.net/

applying [1/1] https://yhetil.org/notmuch/1353855745-11697-3-git-send-email-david@tethera.net/
diff --git a/performance-test/README b/performance-test/README
new file mode 100644
index 0000000..239d2fb

Checking patch performance-test/README...
Applied patch performance-test/README cleanly.

index at:
100644 239d2fbdf90af64ee243f4aefa8918f5e0dc8164	performance-test/README

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).