Re: [RFA] Update REG_STRUCT_HAS_ADDR doco

[Eli Zaretskii <eliz at delorie dot com>]

> Date: Sat, 29 Apr 2000 17:36:50 +1000
> From: Andrew Cagney <ac131313@cygnus.com>
>
> In expanding target architecture entries I'm constantly adding
> references to other vector members.  How should I be adding the cross
> reference links?
> 
> For instance:
> 
> 	REMOTE_BREAKPOINT 
> 	LITTLE_REMOTE_BREAKPOINT 
> 	BIG_REMOTE_BREAKPOINT 
> 	       Similar to BREAKPOINT, but used for remote targets. 
> 
> 	       BIG_REMOTE_BREAKPOINT and LITTLE_REMOTE_BREAKPOINT have been
> deprecated in favour of BREAKPOINT_FROM_PC. 
> 
> What magic should be added to xref to BREAKPOINT_FROM_PC.

The traditional way is this:

	REMOTE_BREAKPOINT 
	LITTLE_REMOTE_BREAKPOINT 
	BIG_REMOTE_BREAKPOINT 
	       Similar to BREAKPOINT, but used for remote targets. 

	       BIG_REMOTE_BREAKPOINT and LITTLE_REMOTE_BREAKPOINT have been
        deprecated in favour of BREAKPOINT_FROM_PC.
        @xref{Target Architecture Definition, BREAKPOINT_FROM_PC,
        Target Architecture Definition}.

The problem with this is that the pointer goes to the node, not to the
specific place where BREAKPOINT_FROM_PC is described in that node.
Most Info readers will search for the second argument of @xref from
the beginning of the node, and more often than not will land you where
you want them, but in the printed docs this doesn't happen: the page
number is for the beginning of the chapter/section.

A better way would be this:

	@item BREAKPOINT_FROM_PC
	@anchor{foobar}
	...

	       BIG_REMOTE_BREAKPOINT and LITTLE_REMOTE_BREAKPOINT have been
        deprecated in favour of BREAKPOINT_FROM_PC.  @xref{foobar, , 
	Target Architecture Definition}.

However, @anchor is new with Texinfo 4.0, and we decided not to use
the new features just yet.

Does this answer the question?  If not, please tell me what did I
miss.