This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: Doc: make python function/method descriptions look as in Python
> From: <Paul_Koning@Dell.com>
> CC: <pmuldoon@redhat.com>, <gdb-patches@sourceware.org>
> 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.