c9/47c2da4542c749ad210f52c87245304c5ecd9c

   1 Return-Path: <bremner@tethera.net>\r
   2 X-Original-To: notmuch@notmuchmail.org\r
   3 Delivered-To: notmuch@notmuchmail.org\r
   4 Received: from localhost (localhost [127.0.0.1])\r
   5         by olra.theworths.org (Postfix) with ESMTP id BA3AD431FBF\r
   6         for <notmuch@notmuchmail.org>; Sat, 15 Dec 2012 04:45:31 -0800 (PST)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: 0\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
  12         autolearn=disabled\r
  13 Received: from olra.theworths.org ([127.0.0.1])\r
  14         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  15         with ESMTP id ag+3wX9j+D+p for <notmuch@notmuchmail.org>;\r
  16         Sat, 15 Dec 2012 04:45:30 -0800 (PST)\r
  17 Received: from tesseract.cs.unb.ca (tesseract.cs.unb.ca [131.202.240.238])\r
  18         (using TLSv1 with cipher AES256-SHA (256/256 bits))\r
  19         (No client certificate requested)\r
  20         by olra.theworths.org (Postfix) with ESMTPS id C64C8431FC2\r
  21         for <notmuch@notmuchmail.org>; Sat, 15 Dec 2012 04:45:28 -0800 (PST)\r
  22 Received: from fctnnbsc30w-142167090129.dhcp-dynamic.fibreop.nb.bellaliant.net\r
  23         ([142.167.90.129] helo=zancas.localnet)\r
  24         by tesseract.cs.unb.ca with esmtpsa\r
  25         (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.72)\r
  26         (envelope-from <bremner@tethera.net>)\r
  27         id 1Tjr7Q-0006C1-2g; Sat, 15 Dec 2012 08:45:28 -0400\r
  28 Received: from bremner by zancas.localnet with local (Exim 4.80)\r
  29         (envelope-from <bremner@tethera.net>)\r
  30         id 1Tjr7K-00008a-IY; Sat, 15 Dec 2012 08:45:22 -0400\r
  31 From: david@tethera.net\r
  32 To: notmuch@notmuchmail.org\r
  33 Subject: [Patch v3 07/11] perf-test: update README\r
  34 Date: Sat, 15 Dec 2012 08:45:10 -0400\r
  35 Message-Id: <1355575514-32735-8-git-send-email-david@tethera.net>\r
  36 X-Mailer: git-send-email 1.7.10.4\r
  37 In-Reply-To: <1355575514-32735-1-git-send-email-david@tethera.net>\r
  38 References: <1355575514-32735-1-git-send-email-david@tethera.net>\r
  39 X-Spam_bar: -\r
  40 Cc: David Bremner <bremner@debian.org>\r
  41 X-BeenThere: notmuch@notmuchmail.org\r
  42 X-Mailman-Version: 2.1.13\r
  43 Precedence: list\r
  44 List-Id: "Use and development of the notmuch mail system."\r
  45         <notmuch.notmuchmail.org>\r
  46 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  47         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  48 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  49 List-Post: <mailto:notmuch@notmuchmail.org>\r
  50 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  51 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  52         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  53 X-List-Received-Date: Sat, 15 Dec 2012 12:45:32 -0000\r
  54 \r
  55 From: David Bremner <bremner@debian.org>\r
  56 \r
  57 Describe new argument parsing and mention cache handling routines.\r
  58 ---\r
  59  performance-test/README |   26 ++++++++++++++++----------\r
  60  1 file changed, 16 insertions(+), 10 deletions(-)\r
  61 \r
  62 diff --git a/performance-test/README b/performance-test/README\r
  63 index 36f1dac..d36612d 100644\r
  64 --- a/performance-test/README\r
  65 +++ b/performance-test/README\r
  66 @@ -42,17 +42,23 @@ available performance tests.\r
  67  \r
  68  Alternately, you can run a specific subset of tests by simply invoking\r
  69  one of the executable scripts in this directory, (such as ./basic).\r
  70 +Each test script supports the following arguments\r
  71 +\r
  72 +--small / --medium / --large   Choose corpus size.\r
  73 +--debug                                Enable debugging. In particular don't delete\r
  74 +                               temporary directories.\r
  75  \r
  76  Writing tests\r
  77  -------------\r
  78  \r
  79 -Have a look at "basic" for an example.\r
  80 -\r
  81 -add_email_corpus takes arguments "--small" and "--medium" for when you\r
  82 -want smaller subsets of the corpus to check.\r
  83 -\r
  84 -time_done does the cleanup; comment it out or define "$debug" to leave\r
  85 -the temporary files around.\r
  86 -\r
  87 -Currently there is no option processing (e.g. --debug) in the\r
  88 -performance tests.\r
  89 +Have a look at "basic" for an example. Sourcing "perf-test-lib.sh" is\r
  90 +mandatory.  Utility functions include\r
  91 +\r
  92 +- 'add_email_corpus' unpacks a set of messages and adds them to the database.\r
  93 +- 'cache_database': makes a snapshot of the current database\r
  94 +- 'uncache_database': forces the next 'add_email_corpus' to rebuild the\r
  95 +  database.\r
  96 +- 'time_start' unpacks the mail corpus and calls notmuch new if it\r
  97 +   cannot find a cache of the appropriate corpus.\r
  98 +- 'time_done' does the cleanup; comment it out or pass --debug to the\r
  99 +  script to leave the temporary files around.\r
 100 -- \r
 101 1.7.10.4\r
 102 \r