From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 16868 invoked by alias); 12 Feb 2010 04:49:24 -0000 Received: (qmail 16858 invoked by uid 22791); 12 Feb 2010 04:49:23 -0000 X-SWARE-Spam-Status: No, hits=-2.4 required=5.0 tests=AWL,BAYES_00 X-Spam-Check-By: sourceware.org Received: from rock.gnat.com (HELO rock.gnat.com) (205.232.38.15) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Fri, 12 Feb 2010 04:49:19 +0000 Received: from localhost (localhost.localdomain [127.0.0.1]) by filtered-rock.gnat.com (Postfix) with ESMTP id 10A8E2BAC29; Thu, 11 Feb 2010 23:49:18 -0500 (EST) Received: from rock.gnat.com ([127.0.0.1]) by localhost (rock.gnat.com [127.0.0.1]) (amavisd-new, port 10024) with LMTP id 9AfrMy7vfbPq; Thu, 11 Feb 2010 23:49:17 -0500 (EST) Received: from joel.gnat.com (localhost.localdomain [127.0.0.1]) by rock.gnat.com (Postfix) with ESMTP id 73B9C2BAB75; Thu, 11 Feb 2010 23:49:17 -0500 (EST) Received: by joel.gnat.com (Postfix, from userid 1000) id 621B3F59AE; Fri, 12 Feb 2010 08:49:08 +0400 (RET) Date: Fri, 12 Feb 2010 04:49:00 -0000 From: Joel Brobecker To: Eli Zaretskii Cc: gdb-patches@sourceware.org Subject: Re: [RFA/doco/testsuite] Document new gdb_test_timeout global variable. Message-ID: <20100212044908.GF2907@adacore.com> References: <1265631452-2476-1-git-send-email-brobecker@adacore.com> <83eikvegcs.fsf@gnu.org> <20100209131015.GH16325@adacore.com> <836366dzd0.fsf@gnu.org> <20100211075223.GB2907@adacore.com> <83sk97d35w.fsf@gnu.org> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="uh9ZiVrAOUUm9fzH" Content-Disposition: inline In-Reply-To: <83sk97d35w.fsf@gnu.org> User-Agent: Mutt/1.5.20 (2009-06-14) Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org X-SW-Source: 2010-02/txt/msg00315.txt.bz2 --uh9ZiVrAOUUm9fzH Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-length: 1182 > > +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. > > I learn that "board" is the name of a file, is that right? If so, > then please give the @file markup to its 2 other instances, inside the > @footnote: Hmmm, that's a good question. As far as my understanding of these things goes, I think I made a mistake in my text. The correct terms should be either a "board file" (no @file markup), because "board" is not the name of a file. We could have used "@file{boards} files" with boards being a reference to the directory where the board files are stored, but as far as I can tell from the dejagnu documentation, this is just a convention at best - this seems to be something entirely configurable although the dejagnu documentation is quite vague about it (I couldn't find a single line of text explaining the significance of this directory or how dejagnu even locates it - using "boards_dir"?). I think "board file" is what we should use. Attached is the revised version (the only change was to remove the one @file markup for board). -- Joel --uh9ZiVrAOUUm9fzH Content-Type: text/x-diff; charset=us-ascii Content-Disposition: attachment; filename="gdb-test-timeout-doco.diff" Content-length: 2004 commit 7191e16411c47b0df2eb8ec051dcb725795fcb89 Author: Joel Brobecker 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..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 --uh9ZiVrAOUUm9fzH--