--- /dev/null
+Return-Path: <too@guru-group.fi>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+ by arlo.cworth.org (Postfix) with ESMTP id A439A6DE0FB0\r
+ for <notmuch@notmuchmail.org>; Fri, 12 Feb 2016 11:16:49 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at cworth.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0.044\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0.044 tagged_above=-999 required=5 tests=[AWL=0.584, \r
+ RP_MATCHES_RCVD=-0.55, T_HEADER_FROM_DIFFERENT_DOMAINS=0.01]\r
+ autolearn=disabled\r
+Received: from arlo.cworth.org ([127.0.0.1])\r
+ by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024)\r
+ with ESMTP id YeuN-feF2Dd2 for <notmuch@notmuchmail.org>;\r
+ Fri, 12 Feb 2016 11:16:47 -0800 (PST)\r
+Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])\r
+ by arlo.cworth.org (Postfix) with ESMTP id DC3336DE0C51\r
+ for <notmuch@notmuchmail.org>; Fri, 12 Feb 2016 11:16:46 -0800 (PST)\r
+Received: by guru.guru-group.fi (Postfix, from userid 501)\r
+ id 4468510008D; Fri, 12 Feb 2016 21:17:02 +0200 (EET)\r
+From: Tomi Ollila <tomi.ollila@iki.fi>\r
+To: notmuch@notmuchmail.org\r
+Cc: tomi.ollila@iki.fi\r
+Subject: [PATCH] test/README: have matching test script file names\r
+Date: Fri, 12 Feb 2016 21:17:00 +0200\r
+Message-Id: <1455304620-14588-1-git-send-email-tomi.ollila@iki.fi>\r
+X-Mailer: git-send-email 2.6.4\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.20\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+ <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <https://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: <https://notmuchmail.org/mailman/listinfo/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Fri, 12 Feb 2016 19:16:49 -0000\r
+\r
+A while ago test script names were changed to format\r
+Tddd-basename.sh. Update README to reflect that.\r
+\r
+While at it, included some small requirements updates.\r
+---\r
+\r
+'A while ago' here means like 25 months (change was done Jan 2014).\r
+I started doing this change in March 2014 but dropped after got\r
+too exhaustive thoughts of how to continue. Now I did minor change\r
+to make TEST_EMACS=my-emacs TEST_EMACSCLIENT=my-emacsclient make test\r
+lines fit on 80 columns...\r
+\r
+ test/README | 34 ++++++++++++++++++++++++++--------\r
+ 1 file changed, 26 insertions(+), 8 deletions(-)\r
+\r
+diff --git a/test/README b/test/README\r
+index e54e36b..bd9ab54 100644\r
+--- a/test/README\r
++++ b/test/README\r
+@@ -8,10 +8,17 @@ enhance.\r
+ \r
+ Prerequisites\r
+ -------------\r
++The test system itself requires:\r
++\r
++ - bash(1) version 4.0 or newer\r
++\r
++Without bash 4.0+ the tests just refuse to run.\r
++\r
+ Some tests require external dependencies to run. Without them, they\r
+ will be skipped, or (rarely) marked failed. Please install these, so\r
+ that you know if you break anything.\r
+ \r
++ - GNU tar(1)\r
+ - dtach(1)\r
+ - emacs(1)\r
+ - emacsclient(1)\r
+@@ -19,14 +26,21 @@ that you know if you break anything.\r
+ - gpg(1)\r
+ - python(1)\r
+ \r
++If your system lacks these tools or have older, non-upgreable versions\r
++of these, please (possibly compile and) install these to some other\r
++path, for example /usr/local/bin or /opt/gnu/bin. Then prepend the\r
++chosen directory to your PATH before running the tests.\r
++\r
++e.g. env PATH=/opt/gnu/bin:$PATH make test\r
++\r
+ Running Tests\r
+ -------------\r
+ The easiest way to run tests is to say "make test", (or simply run the\r
+ notmuch-test script). Either command will run all available 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 ./search,\r
+-./reply, etc). Note that you will probably want "make test-binaries"\r
++one of the executable scripts in this directory, (such as ./T*-search.sh,\r
++./T*-reply.sh, etc). Note that you will probably want "make test-binaries"\r
+ before running individual tests.\r
+ \r
+ The following command-line options are available when running tests:\r
+@@ -80,9 +94,9 @@ can be specified as follows:\r
+ You can choose an emacs binary (and corresponding emacsclient) to run\r
+ the tests in one of the following ways.\r
+ \r
+- TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient make test\r
+- TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient ./emacs\r
+- make test TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient\r
++ TEST_EMACS=my-emacs TEST_EMACSCLIENT=my-emacsclient make test\r
++ TEST_EMACS=my-emacs TEST_EMACSCLIENT=my-emacsclient ./T*-emacs.sh\r
++ make test TEST_EMACS=my-emacs TEST_EMACSCLIENT=my-emacsclient\r
+ \r
+ Some tests may require a c compiler. You can choose the name and flags similarly\r
+ to with emacs, e.g.\r
+@@ -126,9 +140,13 @@ skipped by the user, as failures.\r
+ \r
+ Writing Tests\r
+ -------------\r
+-The test script is written as a shell script. It should start with\r
+-the standard "#!/usr/bin/env bash" with copyright notices, and an\r
+-assignment to variable 'test_description', like this:\r
++The test script is written as a shell script. It is to be named as\r
++Tddd-testname.sh where 'ddd' is three digits and 'testname' the "bare"\r
++name of your test. Tests will be run in order the 'ddd' part determines.\r
++\r
++The test script should start with the standard "#!/usr/bin/env bash"\r
++with copyright notices, and an assignment to variable 'test_description',\r
++like this:\r
+ \r
+ #!/usr/bin/env bash\r
+ #\r
+-- \r
+1.9.3\r
+\r
projects / notmuch-archives.git / commitdiff