From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 6262 invoked by alias); 8 Feb 2010 18:24:31 -0000 Received: (qmail 6253 invoked by uid 22791); 8 Feb 2010 18:24:30 -0000 X-SWARE-Spam-Status: No, hits=-1.5 required=5.0 tests=AWL,BAYES_00,SPF_SOFTFAIL X-Spam-Check-By: sourceware.org Received: from mtaout21.012.net.il (HELO mtaout21.012.net.il) (80.179.55.169) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Mon, 08 Feb 2010 18:24:25 +0000 Received: from conversion-daemon.a-mtaout21.012.net.il by a-mtaout21.012.net.il (HyperSendmail v2007.08) id <0KXJ00000BIJTJ00@a-mtaout21.012.net.il> for gdb-patches@sourceware.org; Mon, 08 Feb 2010 20:23:43 +0200 (IST) Received: from HOME-C4E4A596F7 ([87.70.67.249]) by a-mtaout21.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0KXJ00L3ACFGSPA0@a-mtaout21.012.net.il>; Mon, 08 Feb 2010 20:23:41 +0200 (IST) Date: Mon, 08 Feb 2010 18:24:00 -0000 From: Eli Zaretskii Subject: Re: [RFA/doco/testsuite] Document new gdb_test_timeout global variable. In-reply-to: <1265631452-2476-1-git-send-email-brobecker@adacore.com> To: Joel Brobecker Cc: gdb-patches@sourceware.org Reply-to: Eli Zaretskii Message-id: <83eikvegcs.fsf@gnu.org> References: <1265631452-2476-1-git-send-email-brobecker@adacore.com> X-IsSubscribed: yes 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/msg00212.txt.bz2 > From: Joel Brobecker > Date: Mon, 8 Feb 2010 16:17:32 +0400 > > 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. Thanks. > +@section Testsuite Configuration It's usually a good idea to put a @cindex entry with the same text as the name of the section (with all words lower-cased) right after the section header. That is because most section names introduce a topic, and users looking for that info will likely think about that topic as well. > +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. Why "board" is in @code, not in @file? Isn't it a file? > +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). It would be worth saying more about how to find out the default value. If I'm a reader of this section, I might ask myself whether I need to set the variable to a non-default value, but it is impossible to answer that question without knowing what would be the value if I don't do anything. > +This global variable is usually used when the debugger is slower than "usually used" sounds awkward. How about "comes in handy"? > +test failures. For instance, when testing on a remote machine, or against > +a system where communications are slow. The last sentence is not a complete one. How about Examples include testing on a remote ... ?