[PATCH v2 1/3] test: update documentation for test_emacs in test/README
Dmitry Kurochkin
dmitry.kurochkin at gmail.com
Sun Jul 3 21:07:19 PDT 2011
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 | 10 +++++++---
test/emacs | 5 -----
2 files changed, 7 insertions(+), 8 deletions(-)
diff --git a/test/README b/test/README
index f9ac607..a245bf1 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 53f455a..f465e2b 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
--
1.7.5.4
More information about the notmuch
mailing list