gdbmi.texinfo cleanup

[Brian Youmans <3diff at flib dot gnu dot ai dot mit dot edu>]

Here is a diff file for gdbmi.texinfo, from the file in
the May 4 distribution.  Most of the changes are pretty
basic typos and grammar fixes.  One spot is a comment that
the line above it should be fixed, since I didn't know
exactly how to fix the problem.

- Brian Y., FSF office staff

*** gdbmi.old.texinfo	Thu May  4 17:36:43 2000
--- gdbmi.texinfo	Fri May  5 12:01:24 2000
***************
*** 110,116 ****
  * GDB/MI Breakpoint Table Commands::
  * GDB/MI Data Manipulation::
  * GDB/MI Program Control::
! * GDB/MI Misc Commands::
  * GDB/MI Stack Manipulation::
  * GDB/MI Symbol Query::
  * GDB/MI Target Manipulation::
--- 110,116 ----
  * GDB/MI Breakpoint Table Commands::
  * GDB/MI Data Manipulation::
  * GDB/MI Program Control::
! * GDB/MI Miscellaneous Commands::
  * GDB/MI Stack Manipulation::
  * GDB/MI Symbol Query::
  * GDB/MI Target Manipulation::
***************
*** 215,222 ****
  @cindex output syntax of @sc{gdb/mi}
  @cindex @sc{gdb/mi}, output syntax
  The output from @sc{gdb/mi} consists of zero or more out-of-band records
! followed, optionally, by a single result record.  The result record
! being for the most recent command.  The sequence of output records is
  terminated by @samp{(gdb)}.
  
  If an input command was prefixed with a @code{@var{token}} then the
--- 215,222 ----
  @cindex output syntax of @sc{gdb/mi}
  @cindex @sc{gdb/mi}, output syntax
  The output from @sc{gdb/mi} consists of zero or more out-of-band records
! followed, optionally, by a single result record.  This result record
! is for the most recent command.  The sequence of output records is
  terminated by @samp{(gdb)}.
  
  If an input command was prefixed with a @code{@var{token}} then the
***************
*** 405,411 ****
  
  @cindex compatibility, @sc{gdb/mi} and CLI
  @cindex @sc{gdb/mi}, compatibility with CLI
! To help users familiar with the GDB's existing CLI interface, @sc{gdb/mi}
  accepts existing CLI commands.  As specified by the syntax, such
  commands can be directly entered into the @sc{gdb/mi} interface and GDB will
  respond.
--- 405,411 ----
  
  @cindex compatibility, @sc{gdb/mi} and CLI
  @cindex @sc{gdb/mi}, compatibility with CLI
! To help users familiar with GDB's existing CLI interface, @sc{gdb/mi}
  accepts existing CLI commands.  As specified by the syntax, such
  commands can be directly entered into the @sc{gdb/mi} interface and GDB will
  respond.
***************
*** 891,897 ****
  @end example
  
  Create a watchpoint.  With the @samp{-a} option it will create an
! @dfn{access} watchpoint, i.e. a watchpoints that triggers either on a
  read from or on a write to the memory location.  With the @samp{-r}
  option, the watchpoint created is a @dfn{read} watchpoint, i.e. it will
  trigger only when the memory location is accessed for reading.  Without
--- 891,897 ----
  @end example
  
  Create a watchpoint.  With the @samp{-a} option it will create an
! @dfn{access} watchpoint, i.e. a watchpoint that triggers either on a
  read from or on a write to the memory location.  With the @samp{-r}
  option, the watchpoint created is a @dfn{read} watchpoint, i.e. it will
  trigger only when the memory location is accessed for reading.  Without
***************
*** 1039,1047 ****
  is the line number to disassemble around
  @item @var{lines}
  is the the number of disassembly lines to be produced.  If it is -1,
! the whole function will be disassembled, in case no @var{end-add} is
  specified.  If @var{end-addr} is specified as a non-zero value, and
! @var{lines} is lower that the number of disassembly lines between
  @var{start-addr} and @var{end-addr}, only @var{lines} lines are
  displayed; if @var{lines} is higher than the number of lines between
  @var{start-addr} and @var{end-addr}, only the lines up to @var{end-addr}
--- 1039,1047 ----
  is the line number to disassemble around
  @item @var{lines}
  is the the number of disassembly lines to be produced.  If it is -1,
! the whole function will be disassembled, in case no @var{end-addr} is
  specified.  If @var{end-addr} is specified as a non-zero value, and
! @var{lines} is lower than the number of disassembly lines between
  @var{start-addr} and @var{end-addr}, only @var{lines} lines are
  displayed; if @var{lines} is higher than the number of lines between
  @var{start-addr} and @var{end-addr}, only the lines up to @var{end-addr}
***************
*** 1109,1115 ****
  (gdb)
  @end smallexample
  
! Disassemble 3 instruction from the start of @code{main}:
  
  @smallexample
  (gdb)
--- 1109,1115 ----
  (gdb)
  @end smallexample
  
! Disassemble 3 instructions from the start of @code{main}:
  
  @smallexample
  (gdb)
***************
*** 1124,1130 ****
  (gdb)
  @end smallexample
  
! Disassemble 3 instruction from the start of @code{main} in mixed mode:
  
  @smallexample
  (gdb)
--- 1124,1130 ----
  (gdb)
  @end smallexample
  
! Disassemble 3 instructions from the start of @code{main} in mixed mode:
  
  @smallexample
  (gdb)
***************
*** 1163,1169 ****
  @subsubheading GDB Command
  
  The corresponding GDB commands are @samp{print}, @samp{output}, and
! @code{call}.  In @code{gdbtk} only, there's a corresponding
  @samp{gdb_eval} command.
  
  @subsubheading Example
--- 1163,1169 ----
  @subsubheading GDB Command
  
  The corresponding GDB commands are @samp{print}, @samp{output}, and
! @samp{call}.  In @code{gdbtk} only, there's a corresponding
  @samp{gdb_eval} command.
  
  @subsubheading Example
***************
*** 1274,1281 ****
   -data-list-register-values @var{fmt} [ ( @var{regno} )*]
  @end example
  
! Display the registers contents.  @var{fmt} is the format according to
! which the registers contents are to be returned, followed by an optional
  list of numbers specifying the registers to display.  A missing list of
  numbers indicates that the contents of all the registers must be returned.
  
--- 1274,1281 ----
   -data-list-register-values @var{fmt} [ ( @var{regno} )*]
  @end example
  
! Display the registers' contents.  @var{fmt} is the format according to
! which the registers' contents are to be returned, followed by an optional
  list of numbers specifying the registers to display.  A missing list of
  numbers indicates that the contents of all the registers must be returned.
  
***************
*** 1400,1408 ****
  This command displays memory contents as a table of @var{nr-rows} by
  @var{nr-cols} words, each word being @var{word-size} bytes.  In total,
  @code{@var{nr-rows} * @var{nr-cols} * @var{word-size}} bytes are read
! (returned as @samp{total-bytes}.  Should less then the requested number
  of bytes be returned by the target, the missing words are identified
! using @samp{N/A}.  The number of bytes read  from the target is returned
  in @samp{nr-bytes} and the starting address used to read memory in
  @samp{addr}.
  
--- 1400,1408 ----
  This command displays memory contents as a table of @var{nr-rows} by
  @var{nr-cols} words, each word being @var{word-size} bytes.  In total,
  @code{@var{nr-rows} * @var{nr-cols} * @var{word-size}} bytes are read
! (returned as @samp{total-bytes}).  Should less then the requested number
  of bytes be returned by the target, the missing words are identified
! using @samp{N/A}.  The number of bytes read from the target is returned
  in @samp{nr-bytes} and the starting address used to read memory in
  @samp{addr}.
  
***************
*** 1499,1505 ****
  
  @subsubheading GDB Command
  
! the corresponding GDB command is @samp{disable display}.
  
  @subsubheading Example
  N.A.
--- 1499,1505 ----
  
  @subsubheading GDB Command
  
! The corresponding GDB command is @samp{disable display}.
  
  @subsubheading Example
  N.A.
***************
*** 1575,1581 ****
  
  @subsubheading GDB Command
  
! the corresponding GDB command is @samp{cd}.
  
  @subsubheading Example
  
--- 1575,1581 ----
  
  @subsubheading GDB Command
  
! The corresponding GDB command is @samp{cd}.
  
  @subsubheading Example
  
***************
*** 1984,1990 ****
  
  @subsubheading GDB Command
  
! The corresponding GDB command is @samp{run}
  
  @subsubheading Example
  
--- 1984,1990 ----
  
  @subsubheading GDB Command
  
! The corresponding GDB command is @samp{run}.
  
  @subsubheading Example
  
***************
*** 2076,2081 ****
--- 2076,2083 ----
  
  Asynchronous command.  Resumes the inferior which executes one machine
  instruction.  The output, once stop, will vary depend on whether we have
+ @c Someone who knows this should figure out what 'once stop' is supposed
+ @c to be.  'once stop is reached'?  - BTY
  stopped in the middle of a source line or not.  In the former case, the
  address at which the program stopped will be printed as well.
  
***************
*** 2154,2160 ****
  which the symbol table is also read.  If no file is specified, the
  command clears the executable and symbol information.  If breakpoints
  are set when using this command with no arguments, gdb will produce
! error messages.  Oterwise, no output is produced, except a completion
  notification.
  
  @subsubheading GDB Command
--- 2156,2162 ----
  which the symbol table is also read.  If no file is specified, the
  command clears the executable and symbol information.  If breakpoints
  are set when using this command with no arguments, gdb will produce
! error messages.  Otherwise, no output is produced, except a completion
  notification.
  
  @subsubheading GDB Command
***************
*** 2254,2260 ****
  
  @subsubheading GDB Command
  
! The corresponding GDB command os @samp{info shared}.
  
  @subsubheading Example
  N.A.
--- 2256,2262 ----
  
  @subsubheading GDB Command
  
! The corresponding GDB command is @samp{info shared}.
  
  @subsubheading Example
  N.A.
***************
*** 2289,2295 ****
  @end example
  
  Read symbol table info from the specified @var{file} argument.  When
! used without arguments, clears GDB'S symbol table info.  No output is
  produced, except for a completion notification.
  
  @subsubheading GDB Command
--- 2291,2297 ----
  @end example
  
  Read symbol table info from the specified @var{file} argument.  When
! used without arguments, clears GDB's symbol table info.  No output is
  produced, except for a completion notification.
  
  @subsubheading GDB Command
***************
*** 2306,2313 ****
  @end smallexample
  
  @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
! @node GDB/MI Misc Commands
! @section Misc GDB commands in @sc{gdb/mi}
  
  @c @subheading -gdb-complete
  
--- 2308,2315 ----
  @end smallexample
  
  @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
! @node GDB/MI Miscellaneous Commands
! @section Miscellaneous GDB commands in @sc{gdb/mi}
  
  @c @subheading -gdb-complete
  
***************
*** 2552,2558 ****
  
  The @var{show-values} argument must have a value of 0 or 1.  A value of
  0 means that only the names of the arguments are listed, a value of 1
! means that both names and values of the argumetns are printed.
  
  @subsubheading GDB Command
  
--- 2554,2560 ----
  
  The @var{show-values} argument must have a value of 0 or 1.  A value of
  0 means that only the names of the arguments are listed, a value of 1
! means that both names and values of the arguments are printed.
  
  @subsubheading GDB Command
  
***************
*** 2720,2726 ****
   -stack-list-locals @var{print-values}
  @end example
  
! Display the local variables names for the current frame.  With an
  argument of 0 prints only the names of the variables, with argument of 1
  prints also their values.
  
--- 2722,2728 ----
   -stack-list-locals @var{print-values}
  @end example
  
! Display the local variable names for the current frame.  With an
  argument of 0 prints only the names of the variables, with argument of 1
  prints also their values.
  
***************
*** 2786,2792 ****
  
  @subsubheading GDB Command
  
! the corresponding GDB command is @samp{info address}.
  
  @subsubheading Example
  N.A.
--- 2788,2794 ----
  
  @subsubheading GDB Command
  
! The corresponding GDB command is @samp{info address}.
  
  @subsubheading Example
  N.A.
***************
*** 3086,3092 ****
  @subsubheading Example
  
  Note: each status message appears on a single line.  Here the messages
! have been broken down, so they can fit into a page.
  
  @smallexample
  (gdb)
--- 3088,3094 ----
  @subsubheading Example
  
  Note: each status message appears on a single line.  Here the messages
! have been broken down so that they can fit onto a page.
  
  @smallexample
  (gdb)
***************
*** 3419,3425 ****
  @subheading Motivation for Variable Objects in @sc{gdb/mi}
  
  For the implementation of a variable debugger window (locals, watched
! expressions, etc.), we are proposing the adaptation of the existent code
  used by @code{Insight}.
  
  The two main reasons for that are:
--- 3421,3427 ----
  @subheading Motivation for Variable Objects in @sc{gdb/mi}
  
  For the implementation of a variable debugger window (locals, watched
! expressions, etc.), we are proposing the adaptation of the existing code
  used by @code{Insight}.
  
  The two main reasons for that are:
***************
*** 3466,3472 ****
  When returning the actual values of the objects, this facility allows
  for the individual selection of the display format used in the result
  creation.  It can be chosen among: binary, decimal, hexadecimal, octal
! and natural.  Natural refers to the a default format automatically
  chosen based on the variable type (like decimal for an @code{int}, hex
  for pointers, etc.).
  
--- 3468,3474 ----
  When returning the actual values of the objects, this facility allows
  for the individual selection of the display format used in the result
  creation.  It can be chosen among: binary, decimal, hexadecimal, octal
! and natural.  Natural refers to a default format automatically
  chosen based on the variable type (like decimal for an @code{int}, hex
  for pointers, etc.).
  
***************
*** 3532,3538 ****
  specified by @var{frame-addr}.  A @samp{*} indicates that the current
  frame should be used.
  
! Expression is any expression valid on the current language set (must not
  begin with a @samp{*}), or one of the following:
  
  @itemize @bullet
--- 3534,3540 ----
  specified by @var{frame-addr}.  A @samp{*} indicates that the current
  frame should be used.
  
! @var{expression} is any expression valid on the current language set (must not
  begin with a @samp{*}), or one of the following:
  
  @itemize @bullet
***************
*** 3763,3770 ****
  addresses this problem.
  
  The output from @sc{gdb/mi} consists of zero or more out-of-band records
! optionally followed by a single result record.  The result record being
! for the most recent command input.  The sequence being terminated by
  ``(gdb)''.
  
  Asynchronous @sc{gdb/mi} output is similar.
--- 3765,3772 ----
  addresses this problem.
  
  The output from @sc{gdb/mi} consists of zero or more out-of-band records
! optionally followed by a single result record, the result record being
! for the most recent command input.  The sequence is terminated by
  ``(gdb)''.
  
  Asynchronous @sc{gdb/mi} output is similar.
***************
*** 3879,3885 ****
  the prefix `='.
  
  @item
! @var{console-stream-output} is output that should be displayed as is in the
  console.  It is the textual response to a CLI command. All the console
  output is prefixed by the prefix ``~''.
  
--- 3881,3887 ----
  the prefix `='.
  
  @item
! @var{console-stream-output} is output that should be displayed as is, in the
  console.  It is the textual response to a CLI command. All the console
  output is prefixed by the prefix ``~''.