Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Paul_Koning@Dell.com
Cc: pmuldoon@redhat.com, gdb-patches@sourceware.org
Subject: Re: Doc: make python function/method descriptions look as in Python
Date: Wed, 07 Sep 2011 00:45:00 -0000	[thread overview]
Message-ID: <834o0pju66.fsf@gnu.org> (raw)
In-Reply-To: <09787EF419216C41A903FD14EE5506DD0153491B04@AUSX7MCPC103.AMER.DELL.COM>

> 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.


  reply	other threads:[~2011-09-06 20:25 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
2011-09-07  0:45                 ` Eli Zaretskii [this message]
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=834o0pju66.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=Paul_Koning@Dell.com \
    --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