summaryrefslogtreecommitdiff
path: root/doc/guide
diff options
context:
space:
mode:
authorrillig <rillig@pkgsrc.org>2020-01-11 11:48:59 +0000
committerrillig <rillig@pkgsrc.org>2020-01-11 11:48:59 +0000
commit758566a747fe46d2ed821b68542deeea4af8a918 (patch)
treefda6d49e924ea2a19ae12082affcf52aefcba377 /doc/guide
parentb9254bed74650ecb1d38932433c02b0d2a733d0e (diff)
downloadpkgsrc-758566a747fe46d2ed821b68542deeea4af8a918.tar.gz
doc/guide: document regress_fail for regression tests
Diffstat (limited to 'doc/guide')
-rw-r--r--doc/guide/files/regression.xml7
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/guide/files/regression.xml b/doc/guide/files/regression.xml
index b0a17604e4c..129abbe24c9 100644
--- a/doc/guide/files/regression.xml
+++ b/doc/guide/files/regression.xml
@@ -1,4 +1,4 @@
-<!-- $NetBSD: regression.xml,v 1.6 2020/01/11 11:35:50 rillig Exp $ -->
+<!-- $NetBSD: regression.xml,v 1.7 2020/01/11 11:48:59 rillig Exp $ -->
<chapter id="regression"> <?dbhtml filename="regression.html"?>
<title>Regression tests</title>
@@ -100,6 +100,11 @@ check_result() {
<variablelist>
+ <varlistentry>
+ <term><varname>regress_fail <replaceable>message...</replaceable></varname></term>
+ <listitem><para>This function makes the test fail with the given error message.</para></listitem>
+ </varlistentry>
+
<varlistentry><term><varname>exit_status expected</varname></term>
<listitem><para>This function compares the exitcode of the
<command>do_test</command> function with its first parameter.