53/38958ff06e9933934d2ce0cb07401958c42f0d

   1 Return-Path: <too@guru-group.fi>\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 arlo.cworth.org (Postfix) with ESMTP id A439A6DE0FB0\r
   6  for <notmuch@notmuchmail.org>; Fri, 12 Feb 2016 11:16:49 -0800 (PST)\r
   7 X-Virus-Scanned: Debian amavisd-new at cworth.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: 0.044\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=0.044 tagged_above=-999 required=5 tests=[AWL=0.584, \r
  12  RP_MATCHES_RCVD=-0.55, T_HEADER_FROM_DIFFERENT_DOMAINS=0.01]\r
  13  autolearn=disabled\r
  14 Received: from arlo.cworth.org ([127.0.0.1])\r
  15  by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024)\r
  16  with ESMTP id YeuN-feF2Dd2 for <notmuch@notmuchmail.org>;\r
  17  Fri, 12 Feb 2016 11:16:47 -0800 (PST)\r
  18 Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])\r
  19  by arlo.cworth.org (Postfix) with ESMTP id DC3336DE0C51\r
  20  for <notmuch@notmuchmail.org>; Fri, 12 Feb 2016 11:16:46 -0800 (PST)\r
  21 Received: by guru.guru-group.fi (Postfix, from userid 501)\r
  22  id 4468510008D; Fri, 12 Feb 2016 21:17:02 +0200 (EET)\r
  23 From: Tomi Ollila <tomi.ollila@iki.fi>\r
  24 To: notmuch@notmuchmail.org\r
  25 Cc: tomi.ollila@iki.fi\r
  26 Subject: [PATCH] test/README: have matching test script file names\r
  27 Date: Fri, 12 Feb 2016 21:17:00 +0200\r
  28 Message-Id: <1455304620-14588-1-git-send-email-tomi.ollila@iki.fi>\r
  29 X-Mailer: git-send-email 2.6.4\r
  30 X-BeenThere: notmuch@notmuchmail.org\r
  31 X-Mailman-Version: 2.1.20\r
  32 Precedence: list\r
  33 List-Id: "Use and development of the notmuch mail system."\r
  34  <notmuch.notmuchmail.org>\r
  35 List-Unsubscribe: <https://notmuchmail.org/mailman/options/notmuch>,\r
  36  <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  37 List-Archive: <http://notmuchmail.org/pipermail/notmuch/>\r
  38 List-Post: <mailto:notmuch@notmuchmail.org>\r
  39 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  40 List-Subscribe: <https://notmuchmail.org/mailman/listinfo/notmuch>,\r
  41  <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  42 X-List-Received-Date: Fri, 12 Feb 2016 19:16:49 -0000\r
  43 \r
  44 A while ago test script names were changed to format\r
  45 Tddd-basename.sh. Update README to reflect that.\r
  46 \r
  47 While at it, included some small requirements updates.\r
  48 ---\r
  49 \r
  50 'A while ago' here means like 25 months (change was done Jan 2014).\r
  51 I started doing this change in March 2014 but dropped after got\r
  52 too exhaustive thoughts of how to continue. Now I did minor change\r
  53 to make TEST_EMACS=my-emacs TEST_EMACSCLIENT=my-emacsclient make test\r
  54 lines fit on 80 columns...\r
  55 \r
  56  test/README | 34 ++++++++++++++++++++++++++--------\r
  57  1 file changed, 26 insertions(+), 8 deletions(-)\r
  58 \r
  59 diff --git a/test/README b/test/README\r
  60 index e54e36b..bd9ab54 100644\r
  61 --- a/test/README\r
  62 +++ b/test/README\r
  63 @@ -8,10 +8,17 @@ enhance.\r
  64  \r
  65  Prerequisites\r
  66  -------------\r
  67 +The test system itself requires:\r
  68 +\r
  69 +  - bash(1) version 4.0 or newer\r
  70 +\r
  71 +Without bash 4.0+ the tests just refuse to run.\r
  72 +\r
  73  Some tests require external dependencies to run. Without them, they\r
  74  will be skipped, or (rarely) marked failed. Please install these, so\r
  75  that you know if you break anything.\r
  76  \r
  77 +  - GNU tar(1)\r
  78    - dtach(1)\r
  79    - emacs(1)\r
  80    - emacsclient(1)\r
  81 @@ -19,14 +26,21 @@ that you know if you break anything.\r
  82    - gpg(1)\r
  83    - python(1)\r
  84  \r
  85 +If your system lacks these tools or have older, non-upgreable versions\r
  86 +of these, please (possibly compile and) install these to some other\r
  87 +path, for example /usr/local/bin or /opt/gnu/bin. Then prepend the\r
  88 +chosen directory to your PATH before running the tests.\r
  89 +\r
  90 +e.g. env PATH=/opt/gnu/bin:$PATH make test\r
  91 +\r
  92  Running Tests\r
  93  -------------\r
  94  The easiest way to run tests is to say "make test", (or simply run the\r
  95  notmuch-test script). Either command will run all available tests.\r
  96  \r
  97  Alternately, you can run a specific subset of tests by simply invoking\r
  98 -one of the executable scripts in this directory, (such as ./search,\r
  99 -./reply, etc). Note that you will probably want "make test-binaries"\r
 100 +one of the executable scripts in this directory, (such as ./T*-search.sh,\r
 101 +./T*-reply.sh, etc). Note that you will probably want "make test-binaries"\r
 102  before running individual tests.\r
 103  \r
 104  The following command-line options are available when running tests:\r
 105 @@ -80,9 +94,9 @@ can be specified as follows:\r
 106  You can choose an emacs binary (and corresponding emacsclient) to run\r
 107  the tests in one of the following ways.\r
 108  \r
 109 -       TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient make test\r
 110 -       TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient ./emacs\r
 111 -       make test TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient\r
 112 +       TEST_EMACS=my-emacs TEST_EMACSCLIENT=my-emacsclient make test\r
 113 +       TEST_EMACS=my-emacs TEST_EMACSCLIENT=my-emacsclient ./T*-emacs.sh\r
 114 +       make test TEST_EMACS=my-emacs TEST_EMACSCLIENT=my-emacsclient\r
 115  \r
 116  Some tests may require a c compiler. You can choose the name and flags similarly\r
 117  to with emacs, e.g.\r
 118 @@ -126,9 +140,13 @@ skipped by the user, as failures.\r
 119  \r
 120  Writing Tests\r
 121  -------------\r
 122 -The test script is written as a shell script.  It should start with\r
 123 -the standard "#!/usr/bin/env bash" with copyright notices, and an\r
 124 -assignment to variable 'test_description', like this:\r
 125 +The test script is written as a shell script. It is to be named as\r
 126 +Tddd-testname.sh where 'ddd' is three digits and 'testname' the "bare"\r
 127 +name of your test. Tests will be run in order the 'ddd' part determines.\r
 128 +\r
 129 +The test script should start with the standard "#!/usr/bin/env bash"\r
 130 +with copyright notices, and an assignment to variable 'test_description',\r
 131 +like this:\r
 132  \r
 133         #!/usr/bin/env bash\r
 134         #\r
 135 -- \r
 136 1.9.3\r
 137 \r