aboutsummaryrefslogtreecommitdiffhomepage
path: root/test/README
diff options
context:
space:
mode:
authorGravatar Austin Clements <amdragon@MIT.EDU>2012-11-27 22:24:59 -0500
committerGravatar David Bremner <bremner@debian.org>2012-11-29 09:24:12 -0400
commitd59d9c81522d9127dde089ae9457f44de53f28e9 (patch)
treec9623fa99e71da96af7af304fbdf69c6f02fd984 /test/README
parentdba1f6e43247fb66ef1068ad88672dfb6a2df624 (diff)
test: Make the emacsclient binary user-configurable
And require that if TEST_EMACS is specified, so is TEST_EMACSCLIENT. Previously, the test framework always used "emacsclient", even if the Emacs in use was overridden by TEST_EMACS. This causes problems if both Emacs 23 and Emacs 24 are installed, the Emacs 23 emacsclient is the system default, but TEST_EMACS is set to emacs24. Specifically, with an Emacs 24 server and an Emacs 23 client, emacs tests that run very quickly may produce no output from emacsclient, causing the test to fail. The Emacs server uses a very simple line-oriented protocol in which the client sends a request to evaluate an expression and the server sends a request to print the result of evaluation. Prior to Emacs bzr commit 107565 on March 11th, 2012 (released in Emacs 24.1), if multiple commands were sent to the emacsclient between when it sent the evaluation command and when it entered its receive loop, it would only process the first response command, ignoring the rest of the received buffer. This wasn't a problem with the Emacs 23 server because it sent only the command to print the evaluation result. However, the Emacs 24 server first sends an unprompted command specifying the PID of the Emacs server, then processes the evaluation request, then sends the command to print the result. If the evaluation is fast enough, it can send both of these commands before emacsclient enters the receive loop. Hence, if an Emacs 24 server is used with an Emacs 23 emacsclient, it may miss the response printing command, ultimately causing intermittent notmuch test failures.
Diffstat (limited to 'test/README')
-rw-r--r--test/README10
1 files changed, 5 insertions, 5 deletions
diff --git a/test/README b/test/README
index 6dc30346..81c232dd 100644
--- a/test/README
+++ b/test/README
@@ -69,12 +69,12 @@ can be specified as follows:
make test OPTIONS="--verbose"
-You can choose an emacs binary to run the tests in one of the
-following ways.
+You can choose an emacs binary (and corresponding emacsclient) to run
+the tests in one of the following ways.
- TEST_EMACS=my-special-emacs make test
- TEST_EMACS=my-special-emacs ./emacs
- make test TEST_EMACS=my-special-emacs
+ TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient make test
+ TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient ./emacs
+ make test TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient
Skipping Tests
--------------