This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [RFA/doco/testsuite] Document new gdb_test_timeout global variable.
> How about this?
Works for me! Thanks for the suggestion. Attached is the new version.
I moved up a bit the paragraph explaining why this global variable
might be useful - I felt it was nicer and more natural to have it
before explaining what the default value was, and where to find it.
But I can move it back.
OK to commit this version?
Thanks,
--
Joel
commit bdb6c0007cdba70be6f48515823368aca6dc8eee
Author: Joel Brobecker <brobecker@adacore.com>
Date: Mon Feb 8 16:11:28 2010 +0400
[testsuite] Document new gdb_test_timeout global variable.
gdb/doc/ChangeLog:
* gdbint.texinfo (Testsuite): New section "Testsuite Configuration",
documenting the gdb_test_timeout variable.
diff --git a/gdb/doc/gdbint.texinfo b/gdb/doc/gdbint.texinfo
index c90af05..7c3fb7e 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 @file{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