This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [RFA/doco] Document task-specific breakpoints


> Date: Thu, 9 Apr 2009 09:59:26 -0700
> From: Joel Brobecker <brobecker@adacore.com>
> Cc: Eli Zaretskii <eliz@gnu.org>, gdb-patches@sourceware.org
> 
> > Joel> +It is also possible to insert a breakpoint that will stop the program
> > Joel> +only if a specific thread or a specific task hits that breakpoint.
> > Joel> +@xref{Thread-Specific Breakpoints} and @ref{Ada Tasks} for more
> > 
> > ../../../archer/gdb/doc/gdb.texinfo:3057: warning: `.' or `,' must follow @xref, not `a'.
> 
> Umpf :-(, sorry about that. Is it OK if I add a coma after the xref.

Yes, that's the canonical way of handling this.  Note that @ref also
needs a comma after its argument.

>     See Thread-Specific Breakpoints, and Ada Tasks for more [...]
> 
> I would have prefered the current version, though.

Right, but this is a limitation of Texinfo.

> Perhaps we need to change the way we wrote the references?

In general, it is not a very good idea to have several
cross-references to close in the same sentence.  Something like the
following might be better:

  @xref{Thread-Specific Breakpoints}, for more about this.  For
  Ada-specific aspects, see @ref{Ada Tasks}.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]