Patch to gdbmi.texinfo
Dmitry S. Sivachenko
dima@Chg.RU
Mon Aug 21 13:03:00 GMT 2000
Hello!
Please apply this patch to gdbmi.texinfo.
It was made agaist latest revision of gdbmi.texinfo.
It fixes several typos and markup bugs, missed by me in my previous patch.
Thank you in advance,
Dima.
Index: gdbmi.texinfo
===================================================================
RCS file: /home/cvs/en-gdbman/gdbmi.texinfo,v
retrieving revision 1.3
diff -u -r1.3 gdbmi.texinfo
--- gdbmi.texinfo 2000/07/29 14:29:42 1.3
+++ gdbmi.texinfo 2000/08/19 12:05:07
@@ -158,7 +158,7 @@
@code{[} " --" @code{]} ( " " @var{parameter} )* @var{nl}}
@item @var{token} @expansion{}
-@code{"any sequence of digits"}
+"any sequence of digits"
@item @var{option} @expansion{}
@code{"-" @var{parameter} [ " " @var{parameter} ]}
@@ -167,7 +167,7 @@
@code{@var{non-blank-sequence} | @var{c-string}}
@item @var{operation} @expansion{}
-@emph{any of the operations described in this document}
+@emph{any of the operations described in this chapter}
@item @var{non-blank-sequence} @expansion{}
@emph{anything, provided it doesn't contain special characters such as
@@ -180,6 +180,7 @@
@code{CR | CR-LF}
@end table
+@noindent
Notes:
@itemize @bullet
@@ -193,7 +194,7 @@
@item
Some @sc{mi} commands accept optional arguments as part of the parameter
-list. Each option is identified by a leading @samp{-} (dash) and may be
+list. Each option is identified by a leading @samp{-} (dash) and may be
followed by an optional argument parameter. Options occur first in the
parameter list and can be delimited from normal parameters using
@samp{--} (this is useful when some parameters begin with a dash).
@@ -217,7 +218,7 @@
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)}.
+terminated by @samp{(@value{GDBP})}.
If an input command was prefixed with a @code{@var{token}} then the
corresponding output for that command will also be prefixed by that same
@@ -283,6 +284,7 @@
@emph{any sequence of digits}.
@end table
+@noindent
In addition, the following are still being developed:
@table @code
@@ -290,6 +292,7 @@
This action is currently undefined.
@end table
+@noindent
Notes:
@itemize @bullet
@@ -299,8 +302,8 @@
@item
The @code{@var{token}} is from the corresponding request. If an execution
command is interrupted by the @samp{-exec-interrupt} command, the
-@var{token} associated with the `*stopped' message is the one of the
-original execution command, not the one of the interrupt-command.
+@var{token} associated with the @samp{*stopped} message is the one of the
+original execution command, not the one of the interrupt command.
@item
@cindex status output in @sc{gdb/mi}
@@ -359,7 +362,7 @@
@example
-> -stop
-<- (gdb)
+<- (@value{GDBP})
@end example
@noindent
@@ -367,7 +370,7 @@
@example
<- *stop,reason="stop",address="0x123",source="a.c:123"
-<- (gdb)
+<- (@value{GDBP})
@end example
@subsubheading Simple CLI Command
@@ -378,7 +381,7 @@
@example
-> print 1+2
<- ~3\n
-<- (gdb)
+<- (@value{GDBP})
@end example
@subsubheading Command With Side Effects
@@ -386,7 +389,7 @@
@example
-> -symbol-file xyz.exe
<- *breakpoint,nr="3",address="0x123",source="a.c:123"
-<- (gdb)
+<- (@value{GDBP})
@end example
@subsubheading A Bad Command
@@ -396,7 +399,7 @@
@example
-> -rubbish
<- error,"Rubbish not found"
-<- (gdb)
+<- (@value{GDBP})
@end example
@c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -437,8 +440,8 @@
@table @code
@findex ^done
@item "^done" [ "," @var{results} ]
-The synchronous operation was successful, @code{@var{results}} is the return
-value.
+The synchronous operation was successful, @code{@var{results}} are the return
+values.
@item "^running"
@findex ^running
@@ -503,10 +506,10 @@
@section @sc{gdb/mi} Command Description Format
The remaining sections describe blocks of commands. Each block of
-commands is laid out in a fashion similar to this chapter.
+commands is laid out in a fashion similar to this section.
Note the the line breaks shown in the examples are here only for
-readability. They don't appear in the real output.
+readability. They don't appear in the real output.
Also note that the commands with a non-available example (N.A.@:) are
not yet implemented.
@@ -596,7 +599,7 @@
@end ignore
-@subheading The -break-condition Command
+@subheading The @code{-break-condition} Command
@findex -break-condition
@subsubheading Synopsis
@@ -852,8 +855,8 @@
number of times the breakpoint has been hit
@end table
-If there are no breakpoints or watchpoints, the BreakpointTable field is
-an empty list.
+If there are no breakpoints or watchpoints, the @code{BreakpointTable}
+field is an empty list.
@subsubheading @value{GDBN} Command
@@ -1053,7 +1056,7 @@
@subsubheading Result
-The output for each instruction is composed of two fields:
+The output for each instruction is composed of four fields:
@itemize @bullet
@item Address
@@ -1406,7 +1409,7 @@
in @samp{nr-bytes} and the starting address used to read memory in
@samp{addr}.
-The address of the next/previous page or row is available in
+The address of the next/previous row or page is available in
@samp{next-row} and @samp{prev-row}, @samp{next-page} and
@samp{prev-page}.
@@ -1447,7 +1450,7 @@
@end smallexample
Read thirty two bytes of memory starting at @code{bytes+16} and format
-as eight rows of four columns. Include a string encoding with @code{x}
+as eight rows of four columns. Include a string encoding with @samp{x}
used as the non-printable character.
@smallexample
@@ -1621,7 +1624,7 @@
-environment-path ( @var{pathdir} )+
@end example
-Add directories to beginning of search path for object files.
+Add directories @var{pathdir} to beginning of search path for object files.
@subsubheading @value{GDBN} Command
@@ -1672,7 +1675,7 @@
it doesn't encounter any breakpoints. In this case the output will
include an exit code, if the program has exited exceptionally.
-@subsubheading Examples:
+@subsubheading Examples
@noindent
Program exited normally:
@@ -2118,7 +2121,7 @@
Asynchronous command. Executes the inferior until the @var{location}
specified in the argument is reached. If there is no argument, the inferior
executes until a source line greater than the current one is reached.
-The reason for stopping in this case will be ``location-reached''.
+The reason for stopping in this case will be @samp{location-reached}.
@subsubheading @value{GDBN} Command
@@ -3316,7 +3319,7 @@
@subsubheading Example
-No threads present, besides the main process.
+No threads present, besides the main process:
@smallexample
(@value{GDBP})
@@ -3326,7 +3329,7 @@
@end smallexample
-Several threads.
+Several threads:
@smallexample
(@value{GDBP})
@@ -3445,10 +3448,10 @@
least, the following operations:
@itemize @bullet
-@item -gdb-show output-radix
-@item -stack-list-arguments
-@item -stack-list-locals
-@item -stack-select-frame
+@item @code{-gdb-show} @code{output-radix}
+@item @code{-stack-list-arguments}
+@item @code{-stack-list-locals}
+@item @code{-stack-select-frame}
@end itemize
@subheading Introduction to Variable Objects in @sc{gdb/mi}
@@ -3479,29 +3482,29 @@
@item @strong{Operation}
@tab @strong{Description}
-@item -var-create
+@item @code{-var-create}
@tab create a variable object
-@item -var-delete
+@item @code{-var-delete}
@tab delete the variable object and its children
-@item -var-set-format
+@item @code{-var-set-format}
@tab set the display format of this variable
-@item -var-show-format
+@item @code{-var-show-format}
@tab show the display format of this variable
-@item -var-info-num-children
+@item @code{-var-info-num-children}
@tab tells how many children this object has
-@item -var-list-children
+@item @code{-var-list-children}
@tab return a list of the object's children
-@item -var-info-type
+@item @code{-var-info-type}
@tab show the type of this variable object
-@item -var-info-expression
+@item @code{-var-info-expression}
@tab print what this variable object represents
-@item -var-show-attributes
+@item @code{-var-show-attributes}
@tab is this variable editable? does it exist here?
-@item -var-evaluate-expression
+@item @code{-var-evaluate-expression}
@tab get the value of this variable
-@item -var-assign
+@item @code{-var-assign}
@tab set the value of this variable
-@item -var-update
+@item @code{-var-update}
@tab update the variable and its children
@end multitable
@@ -3526,7 +3529,7 @@
The @var{name} parameter is the string by which the object can be
referenced. It must be unique. If @samp{-} is specified, the varobj
-system will generate a string "varNNNNNN'' automatically. It will be
+system will generate a string ``varNNNNNN'' automatically. It will be
unique provided that one does not specify @var{name} on that format.
The command fails if a duplicate name is found.
@@ -3542,10 +3545,10 @@
@samp{*@var{addr}}, where @var{addr} is the address of a memory cell
@item
-@samp{*@var{addr}-@var{addr}} -- a memory address range (TBD)
+@samp{*@var{addr}-@var{addr}} --- a memory address range (TBD)
@item
-@samp{$@var{regname}} -- a CPU register name
+@samp{$@var{regname}} --- a CPU register name
@end itemize
@subsubheading Result
@@ -3605,7 +3608,7 @@
Returns the format used to display the value of the object @var{name}.
@example
- format @expansion{}
+ @var{format} @expansion{}
@var{format-spec}
@end example
@@ -3639,7 +3642,7 @@
@example
numchild=@var{n},children=@{@{name=@var{name},
- numchild=@var{n},type=@var{type}@},(repeats N times)@}
+ numchild=@var{n},type=@var{type}@},@r{(repeats N times)}@}
@end example
@@ -3724,7 +3727,7 @@
@end example
Assigns the value of @var{expression} to the variable object specified
-by @var{name}. The object must be ``editable''.
+by @var{name}. The object must be @samp{editable}.
@subheading The @code{-var-update} Command
@findex -var-update
@@ -3768,16 +3771,16 @@
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
-``(@value{GDBP})''.
+@samp{(@value{GDBP})}.
Asynchronous @sc{gdb/mi} output is similar.
Each output record directly associated with an input command is prefixed
-by the input commands @code{@var{token}}.
+by the input command's @code{@var{token}}.
@table @code
@item @var{output} @expansion{}
-@{ @var{out-of-band-record} @} @code{[} @var{result-record} @code{]} "(@value{GDBP})" @var{nl}
+@{ @var{out-of-band-record} @} @code{[} @var{result-record} @code{]} "@code{(@value{GDBP})}" @var{nl}
@item @var{result-record} @expansion{}
@code{[} @var{token} @code{]} "^" @var{result-class} @{ "," @var{result} @} @var{nl}
@@ -3862,38 +3865,38 @@
@item
The @code{@var{token}} is from the corresponding request. If an execution
-command is interrupted by the -exec-interrupt command, the token
+command is interrupted by the @code{-exec-interrupt} command, the token
associated with the `*stopped' message is the one of the original
-execution command, not the one of the interrupt-command.
+execution command, not the one of the interrupt command.
@item
-@var{status-async-output} contains on-going status information about the progress
-of a slow operation. It can be discarded. All status output is prefixed by
-the prefix `+'.
+@var{status-async-output} contains on-going status information about the
+progress of a slow operation. It can be discarded. All status output is
+prefixed by the prefix @samp{+}.
@item
@var{exec-async-output} contains asynchronous state change on the target
-(stopped, started, disappeared). All async output is prefixed by
-the prefix `*'.
+(stopped, started, disappeared). All async output is prefixed by
+the prefix @samp{*}.
@item
-@var{notify-async-output} contains supplementary information that the client should
-handle (new breakpoint information). All notify output is prefixed by
-the prefix `='.
+@var{notify-async-output} contains supplementary information that the
+client should handle (new breakpoint information). All notify output is
+prefixed by the prefix @samp{=}.
@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 ``~''.
+console. It is the textual response to a CLI command. All the console
+output is prefixed by the prefix @samp{~}.
@item
@var{target-stream-output} is the output produced by the target program.
-All the target output is prefixed by the prefix ``@@''.
+All the target output is prefixed by the prefix @samp{@@}.
@item
@var{log-stream-output} is output text coming from @value{GDBN}'s
internals, for instance messages that should be displayed as part of an
-error log. All the log output is prefixed by the prefix ``&''.
+error log. All the log output is prefixed by the prefix @samp{&}.
@end itemize
More information about the Gdb-patches
mailing list