Return-Path: X-Original-To: notmuch@notmuchmail.org Delivered-To: notmuch@notmuchmail.org Received: from localhost (localhost [127.0.0.1]) by olra.theworths.org (Postfix) with ESMTP id BA3AD431FBF for ; Sat, 15 Dec 2012 04:45:31 -0800 (PST) X-Virus-Scanned: Debian amavisd-new at olra.theworths.org X-Spam-Flag: NO X-Spam-Score: 0 X-Spam-Level: X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none] autolearn=disabled Received: from olra.theworths.org ([127.0.0.1]) by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id ag+3wX9j+D+p for ; Sat, 15 Dec 2012 04:45:30 -0800 (PST) Received: from tesseract.cs.unb.ca (tesseract.cs.unb.ca [131.202.240.238]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by olra.theworths.org (Postfix) with ESMTPS id C64C8431FC2 for ; Sat, 15 Dec 2012 04:45:28 -0800 (PST) Received: from fctnnbsc30w-142167090129.dhcp-dynamic.fibreop.nb.bellaliant.net ([142.167.90.129] helo=zancas.localnet) by tesseract.cs.unb.ca with esmtpsa (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.72) (envelope-from ) id 1Tjr7Q-0006C1-2g; Sat, 15 Dec 2012 08:45:28 -0400 Received: from bremner by zancas.localnet with local (Exim 4.80) (envelope-from ) id 1Tjr7K-00008a-IY; Sat, 15 Dec 2012 08:45:22 -0400 From: david@tethera.net To: notmuch@notmuchmail.org Subject: [Patch v3 07/11] perf-test: update README Date: Sat, 15 Dec 2012 08:45:10 -0400 Message-Id: <1355575514-32735-8-git-send-email-david@tethera.net> X-Mailer: git-send-email 1.7.10.4 In-Reply-To: <1355575514-32735-1-git-send-email-david@tethera.net> References: <1355575514-32735-1-git-send-email-david@tethera.net> X-Spam_bar: - Cc: David Bremner X-BeenThere: notmuch@notmuchmail.org X-Mailman-Version: 2.1.13 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 15 Dec 2012 12:45:32 -0000 From: David Bremner Describe new argument parsing and mention cache handling routines. --- performance-test/README | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/performance-test/README b/performance-test/README index 36f1dac..d36612d 100644 --- a/performance-test/README +++ b/performance-test/README @@ -42,17 +42,23 @@ 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). +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 ------------- -Have a look at "basic" for an example. - -add_email_corpus takes arguments "--small" and "--medium" for when you -want smaller subsets of the corpus 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. +Have a look at "basic" 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 +- 'uncache_database': forces the next 'add_email_corpus' to rebuild the + database. +- 'time_start' unpacks the mail corpus and calls notmuch new if it + 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. -- 1.7.10.4