From: Shakthi Kannan <shakthimaan@gmail.com>
Date: Sat, 26 Dec 2015 11:05:06 +0000 (+0200)
Subject: Document 'ert-summarize-tests-batch-and-exit'
X-Git-Tag: emacs-25.0.90~379
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=406d132244867fe079580fa003c9dac88063283e;p=emacs.git

Document 'ert-summarize-tests-batch-and-exit'

* doc/misc/ert.texi (Running Tests in Batch Mode): Document
'ert-summarize-tests-batch-and-exit'.
---

diff --git a/doc/misc/ert.texi b/doc/misc/ert.texi
index 35d315c64b8..c2363237b97 100644
--- a/doc/misc/ert.texi
+++ b/doc/misc/ert.texi
@@ -283,6 +283,15 @@ with a zero exit status if all tests passed, or nonzero if any tests
 failed or if anything else went wrong.  It will also print progress
 messages and error diagnostics to standard output.
 
+You can also redirect the above output to a log file, say
+@file{output.log}, and use the
+@code{ert-summarize-tests-batch-and-exit} function to produce a neat
+summary as shown below:
+
+@example
+emacs -batch -l ert -f ert-summarize-tests-batch-and-exit output.log
+@end example
+
 If ERT is not part of your Emacs distribution, 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
diff --git a/etc/NEWS b/etc/NEWS
index 19c9858b80d..f1ba79f5b03 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -696,7 +696,11 @@ The remainder were:
 
 **** The nil and list forms of `diary-display-function'.
 
++++
 ** New ERT function `ert-summarize-tests-batch-and-exit'.
+If the output of ERT tests in batch mode execution can be saved to a
+log file, then it can be passed as an argument to the above function
+to produce a neat summary.
 
 ** New js.el option `js-indent-first-init'.