bug#22235: Document new ERT function ert-summarize-tests-batch-and-exit

bug#22235: Document new ERT function ert-summarize-tests-batch-and-exit

[Shakthi Kannan]

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

$subject

-- 
Shakthi Kannan
http://www.shakthimaan.com

[-- Attachment #2: 0001-Document-new-ERT-function-ert-summarize-tests-batch-.patch --]
[-- Type: text/x-patch, Size: 1616 bytes --]

From a53e3f74d3b7017c253b869eab91f0398aba8dc0 Mon Sep 17 00:00:00 2001
From: Shakthi Kannan <author@shakthimaan.com>
Date: Fri, 25 Dec 2015 21:47:49 +0530
Subject: [PATCH] Document new ERT function ert-summarize-tests-batch-and-exit

---
 doc/misc/ert.texi | 9 +++++++++
 etc/NEWS          | 4 ++++
 2 files changed, 13 insertions(+)

diff --git a/doc/misc/ert.texi b/doc/misc/ert.texi
index 35d315c..c236323 100644
--- a/doc/misc/ert.texi
+++ b/doc/misc/ert.texi
@@ -283,6 +283,15 @@ Running Tests in Batch Mode
 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 19c9858..f1ba79f 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'.
 
-- 
2.1.4

bug#22235: Document new ERT function ert-summarize-tests-batch-and-exit

[Eli Zaretskii]

> Date: Fri, 25 Dec 2015 21:59:44 +0530
> From: Shakthi Kannan <shakthimaan@gmail.com>
> 
> From a53e3f74d3b7017c253b869eab91f0398aba8dc0 Mon Sep 17 00:00:00 2001
> From: Shakthi Kannan <author@shakthimaan.com>
> Date: Fri, 25 Dec 2015 21:47:49 +0530
> Subject: [PATCH] Document new ERT function ert-summarize-tests-batch-and-exit

Thanks, pushed.