[Patch v3 07/11] perf-test: update README

diff --git a/c9/47c2da4542c749ad210f52c87245304c5ecd9c b/c9/47c2da4542c749ad210f52c87245304c5ecd9c
new file mode 100644 (file)
index 0000000..00b806f
--- /dev/null
+++ b/c9/47c2da4542c749ad210f52c87245304c5ecd9c
@@ -0,0 +1,102 @@
+Return-Path: <bremner@tethera.net>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id BA3AD431FBF\r
+       for <notmuch@notmuchmail.org>; Sat, 15 Dec 2012 04:45:31 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
+       autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id ag+3wX9j+D+p for <notmuch@notmuchmail.org>;\r
+       Sat, 15 Dec 2012 04:45:30 -0800 (PST)\r
+Received: from tesseract.cs.unb.ca (tesseract.cs.unb.ca [131.202.240.238])\r
+       (using TLSv1 with cipher AES256-SHA (256/256 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id C64C8431FC2\r
+       for <notmuch@notmuchmail.org>; Sat, 15 Dec 2012 04:45:28 -0800 (PST)\r
+Received: from fctnnbsc30w-142167090129.dhcp-dynamic.fibreop.nb.bellaliant.net\r
+       ([142.167.90.129] helo=zancas.localnet)\r
+       by tesseract.cs.unb.ca with esmtpsa\r
+       (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.72)\r
+       (envelope-from <bremner@tethera.net>)\r
+       id 1Tjr7Q-0006C1-2g; Sat, 15 Dec 2012 08:45:28 -0400\r
+Received: from bremner by zancas.localnet with local (Exim 4.80)\r
+       (envelope-from <bremner@tethera.net>)\r
+       id 1Tjr7K-00008a-IY; Sat, 15 Dec 2012 08:45:22 -0400\r
+From: david@tethera.net\r
+To: notmuch@notmuchmail.org\r
+Subject: [Patch v3 07/11] perf-test: update README\r
+Date: Sat, 15 Dec 2012 08:45:10 -0400\r
+Message-Id: <1355575514-32735-8-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 1.7.10.4\r
+In-Reply-To: <1355575514-32735-1-git-send-email-david@tethera.net>\r
+References: <1355575514-32735-1-git-send-email-david@tethera.net>\r
+X-Spam_bar: -\r
+Cc: David Bremner <bremner@debian.org>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sat, 15 Dec 2012 12:45:32 -0000\r
+\r
+From: David Bremner <bremner@debian.org>\r
+\r
+Describe new argument parsing and mention cache handling routines.\r
+---\r
+ performance-test/README |   26 ++++++++++++++++----------\r
+ 1 file changed, 16 insertions(+), 10 deletions(-)\r
+\r
+diff --git a/performance-test/README b/performance-test/README\r
+index 36f1dac..d36612d 100644\r
+--- a/performance-test/README\r
++++ b/performance-test/README\r
+@@ -42,17 +42,23 @@ available performance tests.\r
+ \r
+ Alternately, you can run a specific subset of tests by simply invoking\r
+ one of the executable scripts in this directory, (such as ./basic).\r
++Each test script supports the following arguments\r
++\r
++--small / --medium / --large  Choose corpus size.\r
++--debug                               Enable debugging. In particular don't delete\r
++                              temporary directories.\r
+ \r
+ Writing tests\r
+ -------------\r
+ \r
+-Have a look at "basic" for an example.\r
+-\r
+-add_email_corpus takes arguments "--small" and "--medium" for when you\r
+-want smaller subsets of the corpus to check.\r
+-\r
+-time_done does the cleanup; comment it out or define "$debug" to leave\r
+-the temporary files around.\r
+-\r
+-Currently there is no option processing (e.g. --debug) in the\r
+-performance tests.\r
++Have a look at "basic" for an example. Sourcing "perf-test-lib.sh" is\r
++mandatory.  Utility functions include\r
++\r
++- 'add_email_corpus' unpacks a set of messages and adds them to the database.\r
++- 'cache_database': makes a snapshot of the current database\r
++- 'uncache_database': forces the next 'add_email_corpus' to rebuild the\r
++  database.\r
++- 'time_start' unpacks the mail corpus and calls notmuch new if it\r
++   cannot find a cache of the appropriate corpus.\r
++- 'time_done' does the cleanup; comment it out or pass --debug to the\r
++  script to leave the temporary files around.\r
+-- \r
+1.7.10.4\r
+\r