From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 12005 invoked by alias); 25 Mar 2010 18:12:27 -0000 Received: (qmail 11987 invoked by uid 22791); 25 Mar 2010 18:12:26 -0000 X-SWARE-Spam-Status: No, hits=-2.4 required=5.0 tests=AWL,BAYES_00 X-Spam-Check-By: sourceware.org Received: from mail.codesourcery.com (HELO mail.codesourcery.com) (38.113.113.100) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Thu, 25 Mar 2010 18:12:22 +0000 Received: (qmail 22103 invoked from network); 25 Mar 2010 18:12:20 -0000 Received: from unknown (HELO macbook-2.local) (stan@127.0.0.2) by mail.codesourcery.com with ESMTPA; 25 Mar 2010 18:12:20 -0000 Message-ID: <4BABA779.4060803@codesourcery.com> Date: Thu, 25 Mar 2010 18:12:00 -0000 From: Stan Shebs User-Agent: Thunderbird 2.0.0.24 (Macintosh/20100228) MIME-Version: 1.0 To: Vladimir Prus CC: Eli Zaretskii , tromey@redhat.com, gdb-patches@sources.redhat.com Subject: Re: [MI tracepoints 9/9] documentation References: <201003141204.12015.vladimir@codesourcery.com> <83hbo5gi56.fsf@gnu.org> <201003252030.35957.vladimir@codesourcery.com> <201003252036.11187.vladimir@codesourcery.com> In-Reply-To: <201003252036.11187.vladimir@codesourcery.com> Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit 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-03/txt/msg00850.txt.bz2 Vladimir Prus wrote: > On Thursday 25 March 2010 20:30:35 Vladimir Prus wrote: > > >> On Thursday 25 March 2010 07:05:57 Eli Zaretskii wrote: >> >> >>>> From: Tom Tromey >>>> Cc: gdb-patches@sources.redhat.com >>>> Date: Wed, 24 Mar 2010 15:43:42 -0600 >>>> >>>> >>>>>>>>> "Volodya" == Vladimir Prus writes: >>>>>>>>> >>>> Volodya> Sorry -- I think I did what I was asked to do, and I don't >>>> Volodya> understand what this warning is trying to tell me. Assuming >>>> Volodya> this is a valid warning, how do I fix it? >>>> >>>> According to the texinfo manual: >>>> >>>> Caution: A period or comma *must* follow the closing brace of an >>>> `@xref'. It is required to terminate the cross reference. This >>>> period or comma will appear in the output, both in the Info file >>>> and in the printed manual. >>>> >>>> So I guess you ought to add a comma after the closing brace. >>>> >>> Yes. >>> >> So, >> >> @xref{GDB/MI Frame Information} for description of this field. >> >> will become >> >> @xref{GDB/MI Frame Information}. for description of this field. >> >> ? I am not sure the result will be correct. What am I missing and how >> do I express my original intent using texinfo? >> > > Oh, I've confused comma and period. Is comma actually required per english > gramamar, or this is texinfo quirk? > It's a little of both actually. :-) The comma is acceptable English usage in this context, but if the sentence and/or cross-reference are short, I think it reads poorly, sounding like a hesitation where no speaker would actually slow down. But if the reference and sentence are both long, then you get a run-on sentence, and worse, possible ambiguity due to the juxtaposition of long cross-reference phrase and the remaining words of the sentence. So the texinfo rule sacrifices some readability for reliability. Stan