aboutsummaryrefslogtreecommitdiff
path: root/gdb/doc/gdbint.texinfo
diff options
context:
space:
mode:
authorJoel Brobecker <brobecker@gnat.com>2010-02-13 04:57:11 +0000
committerJoel Brobecker <brobecker@gnat.com>2010-02-13 04:57:11 +0000
commitc09529e5f88c94b55340b953174b91f8873ad593 (patch)
tree729c39ba47daa94edf2dfffd71b83140abcd6230 /gdb/doc/gdbint.texinfo
parentc5351010e0e4eca2536b911412e2c781c2ef173f (diff)
downloadgdb-c09529e5f88c94b55340b953174b91f8873ad593.zip
gdb-c09529e5f88c94b55340b953174b91f8873ad593.tar.gz
gdb-c09529e5f88c94b55340b953174b91f8873ad593.tar.bz2
Document new gdb_test_timeout global variable.
* gdbint.texinfo (Testsuite): New section "Testsuite Configuration", documenting the gdb_test_timeout variable.
Diffstat (limited to 'gdb/doc/gdbint.texinfo')
-rw-r--r--gdb/doc/gdbint.texinfo32
1 files changed, 32 insertions, 0 deletions
diff --git a/gdb/doc/gdbint.texinfo b/gdb/doc/gdbint.texinfo
index c90af05..7741855 100644
--- a/gdb/doc/gdbint.texinfo
+++ b/gdb/doc/gdbint.texinfo
@@ -7693,6 +7693,38 @@ make site.exp
runtest TRANSCRIPT=y
@end smallexample
+@section Testsuite Configuration
+@cindex 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 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.
+
+This global variable comes in handy when the debugger is slower than
+normal due to the testing environment, triggering unexpected @code{TIMEOUT}
+test failures. Examples include when testing on a remote machine, or
+against a system where communications are slow.
+
+If not specifically defined, this variable gets automatically defined
+to the same value as @code{timeout} during the testsuite initialization.
+The default value of the timeout is defined in the file
+@file{gdb/testsuite/config/unix.exp} that is part of the @value{GDBN}
+test suite@footnote{If you are using a board file, it could override
+the test-suite default; search the board file for "timeout".}.
+
+@end itemize
+
@section Testsuite Organization
@cindex test suite organization