changeset 30676:c3494f408895 stable

doc: Document "*" prepended to bug number in tests (bug #61863). * doc/interpreter/testfun.txi: Document that tests with bug IDs preceeded by an asterisk are for fixed bugs.
author Markus Mützel <markus.muetzel@gmx.de>
date Thu, 27 Jan 2022 18:06:01 +0100
parents 3ca33008c4a9
children 50d055179c74 79d6280fb00a
files doc/interpreter/testfun.txi
diffstat 1 files changed, 14 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/testfun.txi	Thu Jan 27 12:42:43 2022 +0100
+++ b/doc/interpreter/testfun.txi	Thu Jan 27 18:06:01 2022 +0100
@@ -352,7 +352,7 @@
 if the test fails, like this:
 
 @example
-!!!!! Known bug:  MESSAGE
+!!!!! known bug:  MESSAGE
 @end example
 
 @noindent
@@ -360,13 +360,25 @@
 Octave bug tracker and reported as
 
 @example
-!!!!! Known bug: https://octave.org/testfailure/?BUG-ID
+!!!!! known bug: https://octave.org/testfailure/?BUG-ID
 @end example
 
 @noindent
 in which BUG-ID is the integer bug number.  The intent is to allow
 clearer documentation of known problems.
 
+@noindent
+If @code{MESSAGE} is an integer preceeded by an asterisk (e.g.,
+@code{*12345}), it is interpreted as the id for a bug report that has
+been closed.  That usually means that the issue probed in this test has
+been resolved.  If such tests are failing, they are reported as
+regressions by the @code{test} function:
+
+@example
+!!!!! regression: https://octave.org/testfailure/?BUG-ID
+@end example
+
+
 @item  %!error
 @itemx %!error <MESSAGE>
 @itemx %!warning