[pkgsrc/trunk]: pkgsrc/doc/guide/files doc/guide: document regress_fail for r...

[rillig <rillig%pkgsrc.org@localhost>]

details:   https://anonhg.NetBSD.org/pkgsrc/rev/7197aa40012c
branches:  trunk
changeset: 421102:7197aa40012c
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Sat Jan 11 11:48:59 2020 +0000

description:
doc/guide: document regress_fail for regression tests

diffstat:

 doc/guide/files/regression.xml |  7 ++++++-
 1 files changed, 6 insertions(+), 1 deletions(-)

diffs (21 lines):

diff -r 3420e43be3b2 -r 7197aa40012c doc/guide/files/regression.xml
--- a/doc/guide/files/regression.xml    Sat Jan 11 11:44:35 2020 +0000
+++ b/doc/guide/files/regression.xml    Sat Jan 11 11:48:59 2020 +0000
@@ -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 @@
 
 <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.