[PATCH v2] Document external dependencies in the test suite

[PATCH v2] Document external dependencies in the test suite

[Ethan Glasser-Camp]

From: Ethan Glasser-Camp <ethan@betacantrips.com>

Add an explicit note to the README explaining what programs are
necessary and the perhaps-surprising behavior of skipping tests if
they aren't present.

Signed-off-by: Ethan Glasser-Camp <ethan@betacantrips.com>
---

v2 suggested by Dmitry Kurochkin: document all the dependencies.

 test/README |   13 +++++++++++++
 1 files changed, 13 insertions(+), 0 deletions(-)

diff --git a/test/README b/test/README
index bde6db0..44ff653 100644
--- a/test/README
+++ b/test/README
@@ -6,6 +6,19 @@ When fixing bugs or enhancing notmuch, you are strongly encouraged to
 add tests in this directory to cover what you are trying to fix or
 enhance.
 
+Prerequisites
+-------------
+Some tests require external dependencies to run. Without them, they
+will be skipped, or (rarely) marked failed. Please install these, so
+that you know if you break anything.
+
+  - dtach(1)
+  - emacs(1)
+  - emacsclient(1)
+  - gdb(1)
+  - gpg(1)
+  - python(1)
+
 Running Tests
 -------------
 The easiest way to run tests is to say "make test", (or simply run the
-- 
1.7.5.4

Re: [PATCH v2] Document external dependencies in the test suite

[Xavier Maillard]

Hi,

On Mon, 16 Jan 2012 13:52:47 -0500, Ethan Glasser-Camp <glasse@cs.rpi.edu> wrote:

[...]

> +Prerequisites
> +-------------
> +Some tests require external dependencies to run. Without them, they
> +will be skipped, or (rarely) marked failed. Please install these, so
> +that you know if you break anything.
> +
> +  - dtach(1)
> +  - emacs(1)
> +  - emacsclient(1)
> +  - gdb(1)
> +  - gpg(1)
> +  - python(1)

Looks good but just a nit: what is the meaning of the '1' ?

/Xavier

Re: [PATCH v2] Document external dependencies in the test suite

[Ethan Glasser-Camp]

On 01/16/2012 04:09 PM, Xavier Maillard wrote:
> Looks good but just a nit: what is the meaning of the '1' ? 

It's a manpage-like indication that these are standalone programs and 
not, say, libraries or system calls :) Not that I expect there to be 
library dependencies for just the test suite, I just followed Dmitry's 
suggestion.

Ethan

Re: [PATCH v2] Document external dependencies in the test suite

[Jani Nikula]

On Mon, 16 Jan 2012 22:09:55 +0100, Xavier Maillard <xavier@maillard.im> wrote:
> Hi,
> 
> On Mon, 16 Jan 2012 13:52:47 -0500, Ethan Glasser-Camp <glasse@cs.rpi.edu> wrote:
> 
> [...]
> 
> > +Prerequisites
> > +-------------
> > +Some tests require external dependencies to run. Without them, they
> > +will be skipped, or (rarely) marked failed. Please install these, so
> > +that you know if you break anything.
> > +
> > +  - dtach(1)
> > +  - emacs(1)
> > +  - emacsclient(1)
> > +  - gdb(1)
> > +  - gpg(1)
> > +  - python(1)
> 
> Looks good but just a nit: what is the meaning of the '1' ?

It's the man page section. See 'man man'.

HTH,
Jani.

Re: [PATCH v2] Document external dependencies in the test suite

[David Bremner]

On Mon, 16 Jan 2012 13:52:47 -0500, Ethan Glasser-Camp <glasse@cs.rpi.edu> wrote:
> From: Ethan Glasser-Camp <ethan@betacantrips.com>
> 
> Add an explicit note to the README explaining what programs are
> necessary and the perhaps-surprising behavior of skipping tests if
> they aren't present.

Pushed,

d