[commit] [doc ping] for: Write bpt at the ON_STACK bpt address

[Jan Kratochvil <jan dot kratochvil at redhat dot com>]

On Thu, 13 Sep 2012 19:30:08 +0200, Eli Zaretskii wrote:
> I understand that NULL is the return value of the function, and not
> the value of pcptr.  So how about this variant:
> 
>  On input, the program counter (@code{*@var{pcptr}} is the encoded
>  inferior's PC register.  If software breakpoints are supported, the
>  function sets this argument to the PC's plain address.  If software
>  breakpoints are not supported, the function returns NULL instead of
>  the encoded breakpoint instruction.

I find it fine.

Checked in.


Thanks,
Jan


http://sourceware.org/ml/gdb-cvs/2012-09/msg00060.html

--- src/gdb/doc/ChangeLog	2012/08/27 16:50:54	1.1363
+++ src/gdb/doc/ChangeLog	2012/09/13 17:35:34	1.1364
@@ -1,3 +1,10 @@
+2012-09-13  Jan Kratochvil  <jan.kratochvil@redhat.com>
+	    Eli Zaretskii  <eliz@gnu.org>
+
+	* gdbint.texinfo (Defining Other Architecture Features): Clarify *pcptr
+	encoding for gdbarch_breakpoint_from_pc, bp_addr for
+	gdbarch_push_dummy_call and bp_addr for gdbarch_push_dummy_code.
+
 2012-08-27  Jan Kratochvil  <jan.kratochvil@redhat.com>
 
 	* gdb.texinfo (objfile-gdb.py file): New paragraph for .exe stripping.
--- src/gdb/doc/gdbint.texinfo	2012/08/22 17:31:45	1.341
+++ src/gdb/doc/gdbint.texinfo	2012/09/13 17:35:35	1.342
@@ -4532,8 +4532,11 @@
 a static string of bytes that encode a breakpoint instruction, stores the
 length of the string to @code{*@var{lenptr}}, and adjusts the program
 counter (if necessary) to point to the actual memory location where the
-breakpoint should be inserted.  May return @code{NULL} to indicate that
-software breakpoints are not supported.
+breakpoint should be inserted.  On input, the program counter
+(@code{*@var{pcptr}} is the encoded inferior's PC register.  If software
+breakpoints are supported, the function sets this argument to the PC's
+plain address.  If software breakpoints are not supported, the function
+returns NULL instead of the encoded breakpoint instruction.
 
 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
@@ -4813,7 +4816,7 @@
 @anchor{gdbarch_push_dummy_call} Define this to push the dummy frame's call to
 the inferior function onto the stack.  In addition to pushing @var{nargs}, the
 code should push @var{struct_addr} (when @var{struct_return} is non-zero), and
-the return address (@var{bp_addr}).
+the return address (@var{bp_addr}, in inferior's PC register encoding).
 
 @var{function} is a pointer to a @code{struct value}; on architectures that use
 function descriptors, this contains the function descriptor value.
@@ -4827,12 +4830,14 @@
 called function should return.
 
 Set @var{bp_addr} to the address at which the breakpoint instruction
-should be inserted, @var{real_pc} to the resume address when starting
-the call sequence, and return the updated inner-most stack address.
+should be inserted (in inferior's PC register encoding), @var{real_pc} to the
+resume address when starting the call sequence, and return the updated
+inner-most stack address.
 
 By default, the stack is grown sufficient to hold a frame-aligned
 (@pxref{frame_align}) breakpoint, @var{bp_addr} is set to the address
-reserved for that breakpoint, and @var{real_pc} set to @var{funaddr}.
+reserved for that breakpoint (in inferior's PC register encoding), and
+@var{real_pc} set to @var{funaddr}.
 
 This method replaces @w{@code{gdbarch_call_dummy_location (@var{gdbarch})}}.