[RFA/doco/testsuite] Document new gdb_test_timeout global variable.

[Joel Brobecker <brobecker at adacore dot com>]

Hello,

This patch documents a new testsuite variable introduced to allow
the user to configure the timeout duration used while running
the testsuite.

    http://www.sourceware.org/ml/gdb-patches/2010-02/msg00101.html

gdb/doc/ChangeLog:

        * gdbint.texinfo (Testsuite): New section "Testsuite Configuration",
        documenting the gdb_test_timeout variable.

This patch was tested on x86_64-linux by rebuilding the PDF, PS and
HTML documentation.

OK to apply?

Thanks,
-- 
Joel

---
 gdb/doc/gdbint.texinfo |   28 ++++++++++++++++++++++++++++
 1 files changed, 28 insertions(+), 0 deletions(-)

diff --git a/gdb/doc/gdbint.texinfo b/gdb/doc/gdbint.texinfo
index c90af05..b97d0e1 100644
--- a/gdb/doc/gdbint.texinfo
+++ b/gdb/doc/gdbint.texinfo
@@ -7693,6 +7693,34 @@ make site.exp
 runtest TRANSCRIPT=y
 @end smallexample
 
+@section Testsuite Configuration
+
+It is possible to adjust the behavior of the testsuite by defining
+the global variables listed below, either in a @file{site.exp} file,
+or in a @code{board} file.
+
+@itemize @bullet
+
+@item @code{gdb_test_timeout}
+
+Defining this variable changes the default timeout duration used during
+communication with @value{GDBN}.  More specifically, the global variable
+used during testing is @code{timeout}, but this variable gets reset to
+@code{gdb_test_timeout} at the beginning of each testcase, making sure
+that any local change to @code{timeout} in a testcase does not affect
+subsequent testcases.
+
+If not specifically defined, this variable gets automatically defined
+to the same value as @code{timeout} during the testsuite initialization
+(the actual value depends on the exact running parameters).
+
+This global variable is usually used when the debugger is slower than
+normal due to the testing environment, triggering unexpected @code{TIMEOUT}
+test failures.  For instance, when testing on a remote machine, or against
+a system where communications are slow.
+
+@end itemize
+
 @section Testsuite Organization
 
 @cindex test suite organization
-- 
1.6.3.3