[PATCH] Add autoload-breakpoints [7/7] autoload-breakpoints doc

[Hui Zhu <hui_zhu@mentor.com>]

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

Hi,

This patch add the doc for the autoload-breakpoints.

Thanks,
Hui

2012-03-17  Hui Zhu  <hui_zhu@mentor.com>

	* gdb.texinfo (Setting Breakpoints): Add set breakpoint autoload.
	(Remote Serial Protocol): Add Autoload-breakpoints Format.

[-- Attachment #2: autoload-breakpoints-doc.txt --]
[-- Type: text/plain, Size: 4453 bytes --]

---
 doc/gdb.texinfo |   98 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 98 insertions(+)

--- a/doc/gdb.texinfo
+++ b/doc/gdb.texinfo
@@ -3741,6 +3741,31 @@ not support breakpoint condition evaluat
 to evaluating all these conditions on the host's side.
 @end table
 
+If the remote stub support, @value{GDBN} can get autoload-breakpoints from
+remote stub.
+
+This feature can be controlled via the following commands:
+
+@kindex set breakpoint autoload
+@kindex show breakpoint autoload
+@table @code
+@item set breakpoint autoload query
+If this option is query (the default), @value{GDBN} will query to user
+how to handle the autoload-breakpints when @value{GDBN} connect to the stub.
+
+@item set breakpoint autoload merge
+If this option is merge, the autoload-breakpoints of @value{GDBN}
+and stub will merge together when @value{GDBN} connect to stub.
+
+@item set breakpoint autoload gdb
+If this option is gdb, the autoload-breakpoints of stub will be removed
+when GDB connect to stub.
+
+@item set breakpoint autoload stub
+If this option is stub, the autoload-breakpoints of GDB will be removed
+when GDB connect to stub.
+@end table
+
 
 @cindex negative breakpoint numbers
 @cindex internal @value{GDBN} breakpoints
@@ -33578,6 +33603,7 @@ Show the current setting of the target w
 * Memory Map Format::
 * Thread List Format::
 * Traceframe Info Format::
+* Autoload-breakpoints Format::
 @end menu
 
 @node Overview
@@ -38205,6 +38231,78 @@ The formal DTD for the traceframe info f
                         length  CDATA   #REQUIRED>
 @end smallexample
 
+@node Autoload-breakpoints Format
+@section Autoload-breakpoints Format
+@cindex Autoload-breakpoints Format
+
+@subsection Autoload-breakpoints base format
+
+Autoload-breakpoints base format describe the operation of
+the autoload-breakpints in @value{GDBN} and the stub.
+
+@table @samp
+
+@item @var{id}@samp{:}@var{command}@samp{:}@var{addr_string}@samp{:}@var{type}@samp{:}@var{ignore_num}
+@cindex @var{id}@samp{:}@var{command}@samp{:}@var{addr_string}@samp{:}@var{type}@samp{:}@var{ignore_num} packet
+@table @samp
+@item @var{id}
+This is the id in hex string format of this command want to control.
+0 means all autoload-breakpoints.
+@item @var{command}
+This is command char. Include E (enable) and D (disable).
+If this autoload-breakpoint @var{id} is not exist, create one and
+enable or disable it.  If it is exist, item follow it will be ignore
+and just disable and enable the autoload-breakpoints.
+@item @var{addr_string}
+If need create an autoload-breakpoint, this is the address string
+that encoded in hex string.
+@item @var{type}
+If need create an autoload-breakpoint, this is the type in char
+include H (hardware) and S (software).
+@item @var{ignore_num}
+If need create an autoload-breakpoint, this is the ignore_num in hex string.
+@end table
+
+@item @var{id}@samp{:}@samp{R}
+@cindex @var{id}@samp{:}@samp{R} packet
+This is the remove packet.
+@var{id} is the id in hex string format of this command want to remove.
+0 means all autoload-breakpoints.
+
+@item @var{id}@samp{:}@samp{C}@samp{:}@var{cmd_str}
+@cindex @var{id}@samp{:}@samp{C}@samp{:}@var{cmd_str} packet
+This packet add @var{cmd_str} to the commands list of
+autoload-breakpoint @var{id}.  If @var{cmd_str} is empty,
+clear commands list of autoload-breakpoint @var{id}.
+@var{cmd_str} is encoded to hex string.
+
+@item @var{id}@samp{:}@samp{O}@samp{:}@var{condition_str}
+@cindex @var{id}@samp{:}@samp{O}@samp{:}@var{condition_str} packet
+This packet set @var{condition_str} as the condition of
+autoload-breakpoint @var{id}.  If @var{condition_str} is empty,
+clear condition of autoload-breakpoint @var{id}.
+@var{condition_str} is encoded to hex string.
+
+@end table
+
+@subsection Autoload-breakpints request packets
+@table @samp
+@item qBfP
+@itemx qBsP
+These packets request data in autoload-breakpoints base format
+about autoload-breakpints from the stub.
+@value{GDBN} sends @code{qBfP} to get the first piece
+of data, and multiple @code{qTsP} to get additional pieces.
+@end table
+
+@subsection Autoload-breakpints control packets
+@table @samp
+@item @samp{QBDP}@var{autoload-breakpoints base format}
+@value{GDBN} and the stub use this packet to control
+the autoload-breakpoints in the remote.  The stub will translate
+this packet through reportAsync Packets.
+@end table
+
 @include agentexpr.texi
 
 @node Target Descriptions