[rfa:doco] Update REMOTE_BREAKPOINT doco

[rfa:doco] Update REMOTE_BREAKPOINT doco

[Andrew Cagney]

[-- Attachment #1: Type: text/plain, Size: 25 bytes --]

Update the doco?

Andrew

[-- Attachment #2: diffs --]
[-- Type: text/plain, Size: 2463 bytes --]

2003-06-08  Andrew Cagney  <cagney@redhat.com>

	* gdbint.texinfo (Target Architecture Definition): Deprecate
	REMOTE_BREAKPOINT, LITTLE_REMOTE_BREAKPOINT, and
	BIG_REMOTE_BREAKPOINT.  Cross reference BREAKPOINT_FROM_PC.

Index: gdbint.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdbint.texinfo,v
retrieving revision 1.148
diff -u -r1.148 gdbint.texinfo
--- gdbint.texinfo	1 Jun 2003 23:05:43 -0000	1.148
+++ gdbint.texinfo	8 Jun 2003 22:59:11 -0000
@@ -3012,24 +3012,26 @@
 @code{BIG_BREAKPOINT} and @code{LITTLE_BREAKPOINT} have been deprecated in
 favor of @code{BREAKPOINT_FROM_PC}.
 
-@item REMOTE_BREAKPOINT
-@itemx LITTLE_REMOTE_BREAKPOINT
-@itemx BIG_REMOTE_BREAKPOINT
-@findex BIG_REMOTE_BREAKPOINT
-@findex LITTLE_REMOTE_BREAKPOINT
-@findex REMOTE_BREAKPOINT
-Similar to BREAKPOINT, but used for remote targets.
-
-@code{BIG_REMOTE_BREAKPOINT} and @code{LITTLE_REMOTE_BREAKPOINT} have been
-deprecated in favor of @code{BREAKPOINT_FROM_PC}.
+@item DEPRECATED_REMOTE_BREAKPOINT
+@itemx DEPRECATED_LITTLE_REMOTE_BREAKPOINT
+@itemx DEPRECATED_BIG_REMOTE_BREAKPOINT
+@findex DEPRECATED_BIG_REMOTE_BREAKPOINT
+@findex DEPRECATED_LITTLE_REMOTE_BREAKPOINT
+@findex DEPRECATED_REMOTE_BREAKPOINT
+Specify the breakpoint instruction sequence for a remote target.
+@code{DEPRECATED_REMOTE_BREAKPOINT},
+@code{DEPRECATED_BIG_REMOTE_BREAKPOINT} and
+@code{DEPRECATED_LITTLE_REMOTE_BREAKPOINT} have been deprecated in
+favor of @code{BREAKPOINT_FROM_PC} (@pxref{BREAKPOINT_FROM_PC}).
 
 @item BREAKPOINT_FROM_PC (@var{pcptr}, @var{lenptr})
 @findex BREAKPOINT_FROM_PC
-Use the program counter to determine the contents and size of a
-breakpoint instruction.  It returns a pointer to a string of bytes
-that encode a breakpoint instruction, stores the length of the string
-to *@var{lenptr}, and adjusts pc (if necessary) to point to the actual
-memory location where the breakpoint should be inserted.
+@anchor{BREAKPOINT_FROM_PC} Use the program counter to determine the
+contents and size of a breakpoint instruction.  It returns a pointer to
+a string of bytes that encode a breakpoint instruction, stores the
+length of the string to *@var{lenptr}, and adjusts pc (if necessary) to
+point to the actual memory location where the breakpoint should be
+inserted.
 
 Although it is common to use a trap instruction for a breakpoint, it's
 not required; for instance, the bit pattern could be an invalid

Re: [rfa:doco] Update REMOTE_BREAKPOINT doco

[Eli Zaretskii]

> Date: Sun, 08 Jun 2003 19:02:17 -0400
> From: Andrew Cagney <ac131313@redhat.com>
> 
> Update the doco?

Approved, but please correct this bit:

> +a string of bytes that encode a breakpoint instruction, stores the
> +length of the string to *@var{lenptr}, and adjusts pc (if necessary) to
                           ^^^^^^^^^^^^^
This should say @code{*@var{lenptr}}.

Also, I'd replace "pc" with "program counter".

Re: [rfa:doco] Update REMOTE_BREAKPOINT doco

[Andrew Cagney]

>> Date: Sun, 08 Jun 2003 19:02:17 -0400
>> From: Andrew Cagney <ac131313@redhat.com>
>> 
>> Update the doco?
> 
> 
> Approved, but please correct this bit:
> 
> 
>> +a string of bytes that encode a breakpoint instruction, stores the
>> +length of the string to *@var{lenptr}, and adjusts pc (if necessary) to
> 
>                            ^^^^^^^^^^^^^
> This should say @code{*@var{lenptr}}.
> 
> Also, I'd replace "pc" with "program counter".

Done.

Andrew