From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 1991 invoked by alias); 6 Sep 2011 20:25:27 -0000 Received: (qmail 1977 invoked by uid 22791); 6 Sep 2011 20:25:26 -0000 X-SWARE-Spam-Status: No, hits=-1.0 required=5.0 tests=AWL,BAYES_00,SPF_SOFTFAIL X-Spam-Check-By: sourceware.org Received: from mtaout20.012.net.il (HELO mtaout20.012.net.il) (80.179.55.166) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Tue, 06 Sep 2011 20:25:12 +0000 Received: from conversion-daemon.a-mtaout20.012.net.il by a-mtaout20.012.net.il (HyperSendmail v2007.08) id <0LR400J00B949700@a-mtaout20.012.net.il> for gdb-patches@sourceware.org; Tue, 06 Sep 2011 23:24:29 +0300 (IDT) Received: from HOME-C4E4A596F7 ([84.229.83.44]) by a-mtaout20.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0LR400IAEBCRQK60@a-mtaout20.012.net.il>; Tue, 06 Sep 2011 23:24:29 +0300 (IDT) Date: Wed, 07 Sep 2011 00:45:00 -0000 From: Eli Zaretskii Subject: Re: Doc: make python function/method descriptions look as in Python In-reply-to: <09787EF419216C41A903FD14EE5506DD0153491B04@AUSX7MCPC103.AMER.DELL.COM> To: Paul_Koning@Dell.com Cc: pmuldoon@redhat.com, gdb-patches@sourceware.org Reply-to: Eli Zaretskii Message-id: <834o0pju66.fsf@gnu.org> References: <09787EF419216C41A903FD14EE5506DD015343BFAE@AUSX7MCPC103.AMER.DELL.COM> <837h5p2a6g.fsf@gnu.org> <09787EF419216C41A903FD14EE5506DD01534911A3@AUSX7MCPC103.AMER.DELL.COM> <09787EF419216C41A903FD14EE5506DD01534916A6@AUSX7MCPC103.AMER.DELL.COM> <09787EF419216C41A903FD14EE5506DD0153491A82@AUSX7MCPC103.AMER.DELL.COM> <8362l5jvao.fsf@gnu.org> <09787EF419216C41A903FD14EE5506DD0153491B04@AUSX7MCPC103.AMER.DELL.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: 2011-09/txt/msg00100.txt.bz2 > From: > CC: , > Date: Tue, 6 Sep 2011 15:06:31 -0500 > Accept-Language: en-US > acceptlanguage: en-US > > >That magic is @anchor, but you broke it because you changed the name of the anchor, which you shouldn't: > > > >> -@defop Operation {@value{GDBN}} prompt_hook current_prompt > >> -@anchor{prompt_hook} > >> +@defun gdb.prompt_hook (current_prompt) @anchor{gdb.prompt_hook} > > > >You shouldn't change the @anchor line at all, because its label has nothing to do with the method name. It's just a label, is not visible to the reader, and it _must_ match the label inside @xref. You cannot change one without changing the other to match. > > I changed both -- that way the cross-reference appears as "Note: gdb.promp_hook" or "See gdb.prompt_hook". And that's why XEmacs stopped working: the label cannot have periods in it. Some Info readers support that, others don't. From the Texinfo manual: * Unfortunately, you cannot use periods, commas, colons or parentheses within a node name; these confuse the Texinfo processors. Perhaps this limitation will be removed some day, too. For example, the following is a section title in this manual: @code{@@unnumberedsec}, @code{@@appendixsec}, @code{@@heading} But the corresponding node name lacks the commas and the @'s: unnumberedsec appendixsec heading The same restrictions affect @anchor labels. So I think you should rename the @anchor and the corresponding @xref back to their previous names.