diff options
Diffstat (limited to 'test/README')
| -rw-r--r-- | test/README | 21 |
1 files changed, 19 insertions, 2 deletions
diff --git a/test/README b/test/README index 5f3c10adbe1..97611cf8644 100644 --- a/test/README +++ b/test/README @@ -7,6 +7,9 @@ Emacs's functionality. Please help add tests! See the file file-organization.org for the details of the directory structure and file-naming conventions. +For tests in the manual/ subdirectory, look there for separate README +files, or look for instructions in the test files themselves. + Emacs uses ERT, Emacs Lisp Regression Testing, for testing. See (info "(ert)") or https://www.gnu.org/software/emacs/manual/html_node/ert/ for more information on writing and running tests. @@ -22,7 +25,10 @@ following tags are recognized: * :unstable The test is under development. It shall run on demand only. -The Makefile in this directory supports the following targets: +The Makefile sets the environment variable $EMACS_TEST_DIRECTORY, +which points to this directory. This environment variable does not +exist when the tests are run outside make. The Makefile supports the +following targets: * make check Run all tests as defined in the directory. Expensive and unstable @@ -99,6 +105,11 @@ debugging. To do that, use make TEST_INTERACTIVE=yes ... +By default, ERT test failure summaries are quite brief in batch +mode--only the names of the failed tests are listed. If the +$EMACS_TEST_VERBOSE environment variable is set, the failure summaries +will also include the data from the failing test. + Some of the tests require a remote temporary directory (autorevert-tests.el, filenotify-tests.el, shadowfile-tests.el and tramp-tests.el). Per default, a mock-up connection method is used @@ -106,7 +117,13 @@ tramp-tests.el). Per default, a mock-up connection method is used to test a real remote connection, set $REMOTE_TEMPORARY_FILE_DIRECTORY to a suitable value in order to overwrite the default value: - env REMOTE_TEMPORARY_FILE_DIRECTORY=/ssh:host:/tmp make ... + env REMOTE_TEMPORARY_FILE_DIRECTORY=/ssh:host:/tmp make ... + +Some optional tests require packages from GNU ELPA. By default +../../elpa will be checked for these packages. If GNU ELPA is checked +out somewhere else, use + + make GNU_ELPA_DIRECTORY=/path/to/elpa ... There are also continuous integration tests on |