From: <Paul_Koning@Dell.com>
To: <eliz@gnu.org>
Cc: <pmuldoon@redhat.com>, <gdb-patches@sourceware.org>
Subject: RE: Doc: make python function/method descriptions look as in Python
Date: Tue, 06 Sep 2011 20:25:00 -0000 [thread overview]
Message-ID: <09787EF419216C41A903FD14EE5506DD0153491B04@AUSX7MCPC103.AMER.DELL.COM> (raw)
In-Reply-To: <8362l5jvao.fsf@gnu.org>
>> I spotted one problem. Changing the description of gdb.prompt_hook from a defop to a defun made the xref{prompt_hook} not work. Either that or it was broken already. I made it xref{gdb.prompt_hook} but that produces an error when I click on that cross-reference. What's the texinfo magic to define what xref points to?
>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".
paul
next prev parent reply other threads:[~2011-09-06 20:07 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-09-01 21:23 Paul_Koning
2011-09-02 12:26 ` Pedro Alves
2011-09-02 16:45 ` Paul_Koning
2011-09-02 17:08 ` Pedro Alves
2011-09-03 19:46 ` Eli Zaretskii
2011-09-03 21:53 ` Matt Rice
2011-09-04 8:38 ` Paul_Koning
2011-09-04 10:37 ` Eli Zaretskii
2011-09-06 15:42 ` Paul_Koning
[not found] ` <09787EF419216C41A903FD14EE5506DD01534916B2@AUSX7MCPC103.AMER.DELL.COM>
2011-09-06 18:01 ` Paul Koning
2011-09-09 21:15 ` Paul Koning
2011-09-09 21:33 ` Eli Zaretskii
2011-09-15 17:19 ` Paul_Koning
2011-10-21 14:17 ` Kevin Pouget
2011-10-21 15:51 ` Tom Tromey
2011-09-06 19:39 ` Phil Muldoon
2011-09-06 19:45 ` Paul_Koning
2011-09-06 19:57 ` Paul_Koning
2011-09-06 20:07 ` Eli Zaretskii
2011-09-06 20:25 ` Paul_Koning [this message]
2011-09-07 0:45 ` Eli Zaretskii
2011-09-06 19:56 ` Eli Zaretskii
2011-09-06 20:01 ` Paul_Koning
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=09787EF419216C41A903FD14EE5506DD0153491B04@AUSX7MCPC103.AMER.DELL.COM \
--to=paul_koning@dell.com \
--cc=eliz@gnu.org \
--cc=gdb-patches@sourceware.org \
--cc=pmuldoon@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox