From: Dmitry Kurochkin <dmitry.kurochkin@gmail.com>
Date: Mon, 4 Jul 2011 04:07:19 +0000 (+0400)
Subject: test: update documentation for test_emacs in test/README
X-Git-Tag: 0.9_rc1~39
X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=commitdiff_plain;h=0db3a4d5be93710837962b8260420cfc5a8b968e

test: update documentation for test_emacs in test/README

Update test_emacs documentation in test/README according to the latest
changes in emacs tests.  Move the note regarding setting variables
from test/emacs to test/README.
---

diff --git a/test/README b/test/README
index f9ac6073..a245bf12 100644
--- a/test/README
+++ b/test/README
@@ -181,9 +181,13 @@ library for your script to use.
 
    This function executes the provided emacs lisp script within
    emacs. The script can be a sequence of emacs lisp expressions,
-   (that is, they will be evaluated within a progn form). The lisp
-   expressions can call `message' to generate output on stdout to be
-   examined by the calling test script.
+   (that is, they will be evaluated within a progn form). Emacs
+   stdout and stderr is not available, the common way to get output
+   is to save it to a file. There are some auxiliary functions
+   useful in emacs tests provided in test-lib.el. Do not use `setq'
+   for setting variables in Emacs tests because it affects other
+   tests that may run in the same Emacs instance.  Use `let' instead
+   so the scope of the changed variables is limited to a single test.
 
  test_done
 
diff --git a/test/emacs b/test/emacs
index 53f455a3..f465e2b6 100755
--- a/test/emacs
+++ b/test/emacs
@@ -1,10 +1,5 @@
 #!/usr/bin/env bash
 
-# Note: do not use `setq' for setting variables in Emacs tests because
-# it affects other tests that may run in the same Emacs instance.  Use
-# `let' instead so the scope of the changed variables is limited to a
-# single test.
-
 test_description="emacs interface"
 . test-lib.sh