# HG changeset patch
# User Fernando Alvarruiz <feralber@upvnet.upv.es>
# Date 1709978741 -3600
# Node ID 0f9fe0289e9b2aab96a2a8c884f78de3cff82a88
# Parent  773c6bd1963034b0508a9fbf29e7dad22238c69e
doc: Add note about modification of shared variables in BISTs (bug #65296)

* testfun.txi: add note about modification of shared variables.

diff -r 773c6bd19630 -r 0f9fe0289e9b doc/interpreter/testfun.txi
--- a/doc/interpreter/testfun.txi	Tue Mar 12 14:59:09 2024 -0400
+++ b/doc/interpreter/testfun.txi	Sat Mar 09 11:05:41 2024 +0100
@@ -186,6 +186,12 @@
 %!shared @var{a}, @var{b}
 @end example
 
+Modifications to shared variables persist from one test to the next
+@strong{only} if the test succeeds.  Thus, if one test modifies a shared
+variable, later tests cannot know which value of the shared variable to expect
+because the pass/fail status of earlier tests is unknown.  For this reason, it
+is not recommended to modify shared variables in tests.
+
 You can also share test functions:
 
 @example