This is the mail archive of the gdb-patches@sources.redhat.com 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 frame_align()


On Wed, 18 Sep 2002, Andrew Cagney wrote:

> This documents the frame_align() architecture method.  It also clarifies 
> the behavior of stack_align().
> 
> ok?

Yes.  However:

  Unlike @ref{STACK_ALIGN}, this function always adjusts the address

Please don't use this technique.  It sounds cute at first glance, but 
produces text in the Info version which looks awkwardly:

  Unlike *note STACK_ALIGN, this function always adjusts the address

Instead, do it more straightforwardly:

  Unlike @code{STACK_ALIGN} (@pxref{STACK_ALIGN}), ...

(In this particular case, the @pxref is actually redundant, since you 
have a @pxref like that a few lines before that.)


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