unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
* [PATCH v2] Document external dependencies in the test suite
@ 2012-01-16 18:52 Ethan Glasser-Camp
  2012-01-16 21:09 ` Xavier Maillard
  2012-01-21 13:15 ` David Bremner
  0 siblings, 2 replies; 5+ messages in thread
From: Ethan Glasser-Camp @ 2012-01-16 18:52 UTC (permalink / raw)
  To: notmuch; +Cc: 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

^ permalink raw reply related	[flat|nested] 5+ messages in thread

* Re: [PATCH v2] Document external dependencies in the test suite
  2012-01-16 21:09 ` Xavier Maillard
@ 2012-01-16 21:01   ` Ethan Glasser-Camp
  2012-01-16 21:17   ` Jani Nikula
  1 sibling, 0 replies; 5+ messages in thread
From: Ethan Glasser-Camp @ 2012-01-16 21:01 UTC (permalink / raw)
  To: Xavier Maillard; +Cc: notmuch, Xavier Maillard, 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

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH v2] Document external dependencies in the test suite
  2012-01-16 18:52 [PATCH v2] Document external dependencies in the test suite Ethan Glasser-Camp
@ 2012-01-16 21:09 ` Xavier Maillard
  2012-01-16 21:01   ` Ethan Glasser-Camp
  2012-01-16 21:17   ` Jani Nikula
  2012-01-21 13:15 ` David Bremner
  1 sibling, 2 replies; 5+ messages in thread
From: Xavier Maillard @ 2012-01-16 21:09 UTC (permalink / raw)
  To: Ethan Glasser-Camp, notmuch; +Cc: Ethan Glasser-Camp

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

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH v2] Document external dependencies in the test suite
  2012-01-16 21:09 ` Xavier Maillard
  2012-01-16 21:01   ` Ethan Glasser-Camp
@ 2012-01-16 21:17   ` Jani Nikula
  1 sibling, 0 replies; 5+ messages in thread
From: Jani Nikula @ 2012-01-16 21:17 UTC (permalink / raw)
  To: Xavier Maillard, Ethan Glasser-Camp, notmuch; +Cc: Ethan Glasser-Camp

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.

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH v2] Document external dependencies in the test suite
  2012-01-16 18:52 [PATCH v2] Document external dependencies in the test suite Ethan Glasser-Camp
  2012-01-16 21:09 ` Xavier Maillard
@ 2012-01-21 13:15 ` David Bremner
  1 sibling, 0 replies; 5+ messages in thread
From: David Bremner @ 2012-01-21 13:15 UTC (permalink / raw)
  To: Ethan Glasser-Camp, notmuch; +Cc: Ethan Glasser-Camp

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

^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2012-01-21 13:15 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2012-01-16 18:52 [PATCH v2] Document external dependencies in the test suite Ethan Glasser-Camp
2012-01-16 21:09 ` Xavier Maillard
2012-01-16 21:01   ` Ethan Glasser-Camp
2012-01-16 21:17   ` Jani Nikula
2012-01-21 13:15 ` David Bremner

Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).