[PATCH] More tracepoint doc improvements

[Stan Shebs <stan@codesourcery.com>]

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

This patch finishes off the general tweaks we've made to the manual 
clarifying aspects of tracepoint behavior.

Stan

2010-03-29  Stan Shebs  <stan@codesourcery.com>
        Nathan Sidwell  <nathan@codesourcery.com>

    * gdb.texinfo (GDB/MI Tracepoint Commands): Add notes about the
    GDBN equivalent.
    (Set Tracepoints): Remove mention that conditional tracepoints
    don't exist.
    (Tracepoint Actions): Clarify when while-stepping collection
    happens, note that while-stepping does not automatically collect
    $pc.



[-- Attachment #2: manfixes-patch-1 --]
[-- Type: text/plain, Size: 6727 bytes --]

Index: gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.687
diff -p -r1.687 gdb.texinfo
*** gdb.texinfo	27 Mar 2010 09:01:26 -0000	1.687
--- gdb.texinfo	29 Mar 2010 21:19:56 -0000
*************** local variables, or global data.  Later,
*** 9334,9343 ****
  commands to examine the values these data had at the time the
  tracepoint was hit.
  
! Tracepoints do not support every breakpoint feature.  Conditional
! expressions and ignore counts on tracepoints have no effect, and
! tracepoints cannot run @value{GDBN} commands when they are
! hit.  Tracepoints may not be thread-specific either.
  
  @cindex fast tracepoints
  Some targets may support @dfn{fast tracepoints}, which are inserted in
--- 9334,9343 ----
  commands to examine the values these data had at the time the
  tracepoint was hit.
  
! Tracepoints do not support every breakpoint feature.  Ignore counts on
! tracepoints have no effect, and tracepoints cannot run @value{GDBN}
! commands when they are hit.  Tracepoints may not be thread-specific
! either.
  
  @cindex fast tracepoints
  Some targets may support @dfn{fast tracepoints}, which are inserted in
*************** recently defined (so that you can define
*** 9601,9607 ****
  @code{actions} without bothering about its number).  You specify the
  actions themselves on the following lines, one action at a time, and
  terminate the actions list with a line containing just @code{end}.  So
! far, the only defined actions are @code{collect} and
  @code{while-stepping}.
  
  @cindex remove actions from a tracepoint
--- 9601,9607 ----
  @code{actions} without bothering about its number).  You specify the
  actions themselves on the following lines, one action at a time, and
  terminate the actions list with a line containing just @code{end}.  So
! far, the only defined actions are @code{collect}, @code{teval}, and
  @code{while-stepping}.
  
  @cindex remove actions from a tracepoint
*************** In the following example, the action lis
*** 9620,9629 ****
  commands indicating the things to be collected when the tracepoint is
  hit.  Then, in order to single-step and collect additional data
  following the tracepoint, a @code{while-stepping} command is used,
! followed by the list of things to be collected while stepping.  The
! @code{while-stepping} command is terminated by its own separate
! @code{end} command.  Lastly, the action list is terminated by an
! @code{end} command.
  
  @smallexample
  (@value{GDBP}) @b{trace foo}
--- 9620,9629 ----
  commands indicating the things to be collected when the tracepoint is
  hit.  Then, in order to single-step and collect additional data
  following the tracepoint, a @code{while-stepping} command is used,
! followed by the list of things to be collected after each step in a
! sequence of single steps.  The @code{while-stepping} command is
! terminated by its own separate @code{end} command.  Lastly, the action
! list is terminated by an @code{end} command.
  
  @smallexample
  (@value{GDBP}) @b{trace foo}
*************** action were used.
*** 9674,9680 ****
  @kindex while-stepping @r{(tracepoints)}
  @item while-stepping @var{n}
  Perform @var{n} single-step instruction traces after the tracepoint,
! collecting new data at each instruction.  The @code{while-stepping}
  command is followed by the list of what to collect while stepping
  (followed by its own @code{end} command):
  
--- 9674,9680 ----
  @kindex while-stepping @r{(tracepoints)}
  @item while-stepping @var{n}
  Perform @var{n} single-step instruction traces after the tracepoint,
! collecting new data after each step.  The @code{while-stepping}
  command is followed by the list of what to collect while stepping
  (followed by its own @code{end} command):
  
*************** command is followed by the list of what 
*** 9686,9692 ****
  @end smallexample
  
  @noindent
! You may abbreviate @code{while-stepping} as @code{ws} or
  @code{stepping}.
  
  @item set default-collect @var{expr1}, @var{expr2}, @dots{}
--- 9686,9694 ----
  @end smallexample
  
  @noindent
! Note that @code{$pc} is not automatically collected by
! @code{while-stepping}; you need to explicitly collect that register if
! you need it.  You may abbreviate @code{while-stepping} as @code{ws} or
  @code{stepping}.
  
  @item set default-collect @var{expr1}, @var{expr2}, @dots{}
*************** frame.  This field is present only if a 
*** 26073,26078 ****
--- 26075,26084 ----
  
  @end table
  
+ @subsubheading @value{GDBN} Command
+ 
+ The corresponding @value{GDBN} command is @samp{tfind}.
+ 
  @subheading -trace-define-variable
  @findex -trace-define-variable
  
*************** Create trace variable @var{name} if it d
*** 26087,26092 ****
--- 26093,26102 ----
  trace variable to that value.  Note that the @var{name} should start
  with the @samp{$} character.
  
+ @subsubheading @value{GDBN} Command
+ 
+ The corresponding @value{GDBN} command is @samp{tvariable}.
+ 
  @subheading -trace-list-variables
  @findex -trace-list-variables
  
*************** presently running.
*** 26115,26120 ****
--- 26125,26134 ----
  
  @end table
  
+ @subsubheading @value{GDBN} Command
+ 
+ The corresponding @value{GDBN} command is @samp{tvariables}.
+ 
  @subsubheading Example
  
  @smallexample
*************** Saves the collected trace data to @var{f
*** 26143,26148 ****
--- 26157,26166 ----
  in a local file.  With the @samp{-r} option the target is asked
  to perform the save.
  
+ @subsubheading @value{GDBN} Command
+ 
+ The corresponding @value{GDBN} command is @samp{tsave}.
+ 
  
  @subheading -trace-start
  @findex -trace-start
*************** to perform the save.
*** 26156,26161 ****
--- 26174,26183 ----
  Starts a tracing experiments.  The result of this command does not
  have any fields.
  
+ @subsubheading @value{GDBN} Command
+ 
+ The corresponding @value{GDBN} command is @samp{tstart}.
+ 
  @subheading -trace-status
  @findex -trace-status
  
*************** remaining space.  These field is optiona
*** 26209,26214 ****
--- 26231,26240 ----
  
  @end table
  
+ @subsubheading @value{GDBN} Command
+ 
+ The corresponding @value{GDBN} command is @samp{tstatus}.
+ 
  @subheading -trace-stop
  @findex -trace-stop
  
*************** Stops a tracing experiment.  The result 
*** 26222,26227 ****
--- 26248,26257 ----
  fields as @code{-trace-status}, except that the @samp{supported} and
  @samp{running} fields are not output.
  
+ @subsubheading @value{GDBN} Command
+ 
+ The corresponding @value{GDBN} command is @samp{tstop}.
+ 
  
  @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  @node GDB/MI Symbol Query