test: update documentation for test_emacs in test/README

[notmuch] / test / README

diff --git a/test/README b/test/README
index f9ac6073d97b4739c80b8ba5ec6da00a88d0e154..a245bf121fec9b77c95325d9d2f51b9c4a933124 100644 (file)
--- 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,
 
    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
 
 
  test_done