From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 12474 invoked by alias); 27 Feb 2005 20:05:39 -0000 Mailing-List: contact gdb-patches-help@sources.redhat.com; run by ezmlm Precedence: bulk List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sources.redhat.com Received: (qmail 12370 invoked from network); 27 Feb 2005 20:05:29 -0000 Received: from unknown (HELO romy.inter.net.il) (192.114.186.66) by sourceware.org with SMTP; 27 Feb 2005 20:05:29 -0000 Received: from zaretski (tony03-45-196.inter.net.il [80.230.45.196]) by romy.inter.net.il (MOS 3.5.6-GR) with ESMTP id AQC48842 (AUTH halo1); Sun, 27 Feb 2005 22:05:22 +0200 (IST) Date: Mon, 28 Feb 2005 12:27:00 -0000 From: "Eli Zaretskii" To: Nick Roberts Message-ID: <01c51d07$Blat.v2.4$9760b080@zahav.net.il> Content-Transfer-Encoding: 7BIT Content-Type: text/plain; charset=ISO-8859-1 CC: gdb-patches@sources.redhat.com In-reply-to: <16929.33581.229739.602592@farnswood.snap.net.nz> (message from Nick Roberts on Sun, 27 Feb 2005 21:22:05 +1300) Subject: Re: [PATCH: gdb/mi + doco] -var-update Reply-to: Eli Zaretskii References: <16919.7660.144228.334687@farnswood.snap.net.nz> <01c5167f$Blat.v2.4$9a7a6f60@zahav.net.il> <16919.53411.753668.336933@farnswood.snap.net.nz> <01c51709$Blat.v2.4$4a3292a0@zahav.net.il> <16921.18627.457594.938060@farnswood.snap.net.nz> <01c517d0$Blat.v2.4$09a26040@zahav.net.il> <16922.43915.346792.973282@farnswood.snap.net.nz> <01c51898$Blat.v2.4$f6fd05c0@zahav.net.il> <16929.8147.933720.246602@farnswood.snap.net.nz> <01c51c89$Blat.v2.4$a336c4e0@zahav.net.il> <16929.33581.229739.602592@farnswood.snap.net.nz> X-SW-Source: 2005-02/txt/msg00284.txt.bz2 > From: Nick Roberts > Date: Sun, 27 Feb 2005 21:22:05 +1300 > Cc: gdb-patches@sources.redhat.com > > > If @var{print-values} is 1 or @code{--with-values}, also prints > > their values. > > > > And similarly in the other hunk where @var{print-values} is > > mentioned. > > Clearly this reads much better, but will the reader realise that print-values > is optional? The use of square brackets is explained but this is right at the > beginning of the section on GDB/MI. I think the use of [this] for optional parts is sufficiently widespread in computer-related documentation, for this to be quite clear.