[PATCH] Document the dependency on dtach in the test suite

[Dmitry Kurochkin]

On Mon, 16 Jan 2012 12:16:08 -0500, Ethan Glasser-Camp <glasse at cs.rpi.edu> wrote:
> From: Ethan Glasser-Camp <ethan at betacantrips.com>
> 
> dtach (and before that, screen) are used to run emacs with more
> verisimilitude, but this is only mentioned in the NEWS. Mention this
> in the test/README file, to make it easier to find out why a bunch of
> tests are failing/skipped.
> 

Can you please add other prerequisites as well?  There is gpg and
probably more.

Can we just make it an alphabetically-sorted list?  That would make it
easier to read and add more dependencies in the future.  I.e.:

  Some tests require the following external dependencies to run:

    * emacs(1)
    * emacsclient(1)
    ...

Regards,
  Dmitry

> Signed-off-by: Ethan Glasser-Camp <ethan at betacantrips.com>
> ---
> 
> Just cutting my teeth on the codebase, and it took me a little while
> to figure this out, so I thought I'd document it.
> 
>  test/README |    5 +++++
>  1 files changed, 5 insertions(+), 0 deletions(-)
> 
> diff --git a/test/README b/test/README
> index bde6db0..29afb3b 100644
> --- a/test/README
> +++ b/test/README
> @@ -6,6 +6,11 @@ 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
> +-------------
> +emacs is run within dtach, so you need to have that installed to run
> +emacs tests (or crypto tests, which rely on emacs to run).
> +
>  Running Tests
>  -------------
>  The easiest way to run tests is to say "make test", (or simply run the
> -- 
> 1.7.5.4
> 
> _______________________________________________
> notmuch mailing list
> notmuch at notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch