CVS commit: pkgsrc/doc/guide/files

["Roland Illig" <rillig%netbsd.org@localhost>]

Module Name:    pkgsrc
Committed By:   rillig
Date:           Sat Jan 11 11:48:59 UTC 2020

Modified Files:
        pkgsrc/doc/guide/files: regression.xml

Log Message:
doc/guide: document regress_fail for regression tests


To generate a diff of this commit:
cvs rdiff -u -r1.6 -r1.7 pkgsrc/doc/guide/files/regression.xml

Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.

Modified files:

Index: pkgsrc/doc/guide/files/regression.xml
diff -u pkgsrc/doc/guide/files/regression.xml:1.6 pkgsrc/doc/guide/files/regression.xml:1.7
--- pkgsrc/doc/guide/files/regression.xml:1.6   Sat Jan 11 11:35:50 2020
+++ pkgsrc/doc/guide/files/regression.xml       Sat Jan 11 11:48:59 2020
@@ -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.