From c09529e5f88c94b55340b953174b91f8873ad593 Mon Sep 17 00:00:00 2001 From: Joel Brobecker Date: Sat, 13 Feb 2010 04:57:11 +0000 Subject: [PATCH] Document new gdb_test_timeout global variable. * gdbint.texinfo (Testsuite): New section "Testsuite Configuration", documenting the gdb_test_timeout variable. --- gdb/doc/ChangeLog | 5 +++++ gdb/doc/gdbint.texinfo | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+) diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog index 4031a4a43b8..1361c3c4072 100644 --- a/gdb/doc/ChangeLog +++ b/gdb/doc/ChangeLog @@ -1,3 +1,8 @@ +2010-02-13 Joel Brobecker + + * gdbint.texinfo (Testsuite): New section "Testsuite Configuration", + documenting the gdb_test_timeout variable. + 2010-02-12 Jakob Engblom * gdb.texinfo (MI commands): Added documentation of --reverse diff --git a/gdb/doc/gdbint.texinfo b/gdb/doc/gdbint.texinfo index c90af0534f3..77418557ca9 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 -- 2.30.2