From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 6244 invoked by alias); 10 Jul 2006 19:53:58 -0000 Received: (qmail 6236 invoked by uid 22791); 10 Jul 2006 19:53:57 -0000 X-Spam-Check-By: sourceware.org Received: from nitzan.inter.net.il (HELO nitzan.inter.net.il) (192.114.186.20) by sourceware.org (qpsmtpd/0.31) with ESMTP; Mon, 10 Jul 2006 19:53:56 +0000 Received: from HOME-C4E4A596F7 (IGLD-80-230-142-218.inter.net.il [80.230.142.218]) by nitzan.inter.net.il (MOS 3.7.3-GA) with ESMTP id ECA21331 (AUTH halo1); Mon, 10 Jul 2006 22:53:50 +0300 (IDT) Date: Mon, 10 Jul 2006 19:53:00 -0000 Message-Id: From: Eli Zaretskii To: Joel Brobecker CC: gdb-patches@sources.redhat.com In-reply-to: <20060710054027.GF971@adacore.com> (message from Joel Brobecker on Sun, 9 Jul 2006 22:40:27 -0700) Subject: Re: [RFA] New substitute-path commands Reply-to: Eli Zaretskii References: <20060705215606.GF3580@adacore.com> <20060705230129.GA1145@nevyn.them.org> <20060706044733.GC673@adacore.com> <1152198199.6282.63.camel@dufur.beaverton.ibm.com> <20060706162952.GB24631@nevyn.them.org> <20060707052219.GA971@adacore.com> <20060707191203.GD971@adacore.com> <20060710054027.GF971@adacore.com> X-IsSubscribed: yes Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org X-SW-Source: 2006-07/txt/msg00081.txt.bz2 > Date: Sun, 9 Jul 2006 22:40:27 -0700 > From: Joel Brobecker > Cc: gdb-patches@sources.redhat.com > > > I suggested to have this text after the command description. In that > > context, @var{from} and @var{to} refer to the command's arguments. > > But you moved the description higher in the text, which made those > > reference dangling. So this needs to be reworded in some way. > > You're right. It didn't work that way at all. You'll see my attempt > at fixing it in this version of the patch. This version is okay to go in, provided that you fix these small gotchas: > +In the @ref{set substitute-path} command description, these two > +parts are named respectively @var{from} and @var{to}. @value{GDBN} @ref needs some punctuation after the closing brace (makeinfo should have griped about that). In addition, @ref produces something like "Section X.YZ [Foo Bar]" in the printed version of the manual, so this sentence will look awkwardly non-English there ("In the Section X.YZ [Source Path], p.123 command description, these two..."). So please reword, e.g. like this: In @ref{set substitute-path}, we name these two parts @var{from} and @var{to}, respectively ... > To define a source path > +substitution rule, use the @ref{set substitute-path} command. Such usage of @ref produces bad results, for the 2nd reason mentioned above. You should use @pxref here: To define a source path substitution rule, use the @code{set substitute-path} command (@pxref{set substitute-path}).