unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* bug#37476: [PATCH] Document ert test selectors in batch mode
@ 2019-09-21 13:09 Stefan Kangas
  2019-09-22 13:05 ` Lars Ingebrigtsen
  0 siblings, 1 reply; 8+ messages in thread
From: Stefan Kangas @ 2019-09-21 13:09 UTC (permalink / raw)
  To: 37476

[-- Attachment #1: Type: text/plain, Size: 223 bytes --]

I think it would be good to document how to use test selectors on the
ert manual page that talks about running tests in batch mode.  I came
up with the following suggested patch.

Any comments?

Best regards,
Stefan Kangas

[-- Attachment #2: 0001-Document-ert-test-selectors-in-batch-mode.patch --]
[-- Type: text/x-patch, Size: 1521 bytes --]

From a6101b99da1b046cd7c1cf3bb6e019dc0e842c20 Mon Sep 17 00:00:00 2001
From: Stefan Kangas <stefankangas@gmail.com>
Date: Sat, 21 Sep 2019 14:58:08 +0200
Subject: [PATCH] Document ert test selectors in batch mode

* doc/misc/ert.texi (Running Tests in Batch Mode): Document test
selectors.
---
 doc/misc/ert.texi | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

diff --git a/doc/misc/ert.texi b/doc/misc/ert.texi
index d2d86555e3..e853faf323 100644
--- a/doc/misc/ert.texi
+++ b/doc/misc/ert.texi
@@ -337,10 +337,20 @@ Running Tests in Batch Mode
 
 In quiet mode ERT prints only unexpected results and summary.
 
-If ERT is not part of your Emacs distribution, you may need to use
+You can specify selectors to only run a subset of your tests
+(@pxref{Test Selectors}).  For example, the following would run all
+tests where the name of the test matches the string ``to-match''.
+
+@example
+emacs -batch -l ert -l my-tests.el \
+      -eval '(ert-run-tests-batch-and-exit "to-match")'
+@end example
+
+If you are using a version of Emacs older than 24.1, ERT is not part
+of your Emacs distribution.  In this case, you may need to use
 @code{-L /path/to/ert/} so that Emacs can find it.  You may need
-additional @code{-L} flags to ensure that @code{my-tests.el} and all the
-files that it requires are on your @code{load-path}.
+additional @code{-L} flags to ensure that @code{my-tests.el} and all
+the files that it requires are on your @code{load-path}.
 
 
 @node Test Selectors
-- 
2.20.1


^ permalink raw reply related	[flat|nested] 8+ messages in thread

end of thread, other threads:[~2019-09-29 16:34 UTC | newest]

Thread overview: 8+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2019-09-21 13:09 bug#37476: [PATCH] Document ert test selectors in batch mode Stefan Kangas
2019-09-22 13:05 ` Lars Ingebrigtsen
2019-09-22 13:38   ` Stefan Kangas
2019-09-22 14:46     ` Eli Zaretskii
2019-09-22 17:23     ` Lars Ingebrigtsen
2019-09-28 16:07       ` Stefan Kangas
2019-09-29 11:10         ` Michael Albinus
2019-09-29 16:34           ` Stefan Kangas

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).