[gentoo-commits] repo/gentoo:master commit in: app-emacs/regress/

[Ulrich Müller]

commit:     f34d0957046324b448f33271612d89b9c1c18cb4
Author:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Sat Oct  3 18:07:11 2020 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Sat Oct  3 18:09:00 2020 +0000
URL:        https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=f34d0957

app-emacs/regress: Restore longdescription.

Package-Manager: Portage-3.0.8, Repoman-3.0.1
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>

 app-emacs/regress/metadata.xml | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/app-emacs/regress/metadata.xml b/app-emacs/regress/metadata.xml
index c918cdef959..2281e41d620 100644
--- a/app-emacs/regress/metadata.xml
+++ b/app-emacs/regress/metadata.xml
@@ -5,5 +5,28 @@
   <email>gnu-emacs@g.o</email>
   <name>Gentoo GNU Emacs project</name>
 </maintainer>
+<longdescription>
+  This module provides support for writing and executing regression tests
+  for Emacs Lisp code.
+
+  This module makes it easy for Emacs lisp programmers to write
+  complete, well-documented regression tests and to run them often
+  during the developement and enhancement processes.
+
+  Here's the idea:
+    1. The programmer puts one or more test suites directly in the lisp
+       file, wrapped inside an "eval-when-compile" special form.  This
+       causes the test suites to be available when .el file is loaded
+       (or when the buffer is evaluated), but not when the .elc file is
+       loaded.
+
+    2. The programmer runs the tests in one of two ways:
+         a. Interactively, with the M-x regress command.
+         b. Automatically, every time the file is evaluated, by putting
+            a small bit of code at the end of the file.
+
+    3. If there are any regressions, a report is produced detailing the
+       problems.
+</longdescription>
 <stabilize-allarches/>
 </pkgmetadata>