]> code.delx.au - gnu-emacs/blobdiff - test/README
; Merge from origin/emacs-25
[gnu-emacs] / test / README
index ee9994d109d5dded79d9c9416aadf02cc2224b55..2994fca6c859aee4235207fcf1ce74dd338c0324 100644 (file)
@@ -1,2 +1,61 @@
+Copyright (C) 2008-2016 Free Software Foundation, Inc.
+See the end of the file for license conditions.
+
 This directory contains files intended to test various aspects of
 Emacs's functionality.  Please help add tests!
+
+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.
+
+The Makefile in this directory supports the following targets:
+
+* make check
+  Run all tests as defined in the directory.  Expensive tests are
+  suppressed.  The result of the tests for <filename>.el is stored in
+  <filename>.log.
+
+* make check-maybe
+  Like "make check", but run only the tests for files which have
+  unresolved prerequisites.
+
+* make check-expensive
+  Like "make check", but run also the tests marked as expensive.
+
+* make <filename>  or  make <filename>.log
+  Run all tests declared in <filename>.el.  This includes expensive
+  tests.  In the former case the output is shown on the terminal, in
+  the latter case the output is written to <filename>.log.
+
+ERT offers selectors, which make it possible to filter out which test
+cases shall run.  The make variable $(SELECTOR) gives you a simple
+mean to use your own selectors.  The ERT manual describes how
+selectors are constructed, see (info "(ert)Test Selectors") or
+https://www.gnu.org/software/emacs/manual/html_node/ert/Test-Selectors.html
+
+You could use predefined selectors of the Makefile.  "make <filename>
+SELECTOR='$(SELECTOR_DEFAULT)'" runs all tests for <filename>.el
+except the tests tagged as expensive.
+
+If your test file contains the tests "test-foo", "test2-foo" and
+"test-foo-remote", and you want to run only the former two tests, you
+could use a selector regexp: "make <filename> SELECTOR='\"foo$$\"'".
+
+\f
+(Also, see etc/compilation.txt for compilation mode font lock tests.)
+
+\f
+This file is part of GNU Emacs.
+
+GNU Emacs is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+GNU Emacs is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.