]> git.notmuchmail.org Git - notmuch/commitdiff
test: update documentation for test_emacs in test/README
authorDmitry Kurochkin <dmitry.kurochkin@gmail.com>
Mon, 4 Jul 2011 04:07:19 +0000 (08:07 +0400)
committerDavid Bremner <bremner@debian.org>
Sat, 10 Sep 2011 13:12:03 +0000 (10:12 -0300)
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.

test/README
test/emacs

index f9ac6073d97b4739c80b8ba5ec6da00a88d0e154..a245bf121fec9b77c95325d9d2f51b9c4a933124 100644 (file)
@@ -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
 
index 53f455a34b641dbd8e51610dffbb365e0602a631..f465e2b69d42b594abecede69694707e9e40fb52 100755 (executable)
@@ -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