FreeChainXenon/binutils-gdb
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

gdb.texinfo (Source Annotations): Fix index entries by adding

Browse source 
"annotation" to them, to discriminate from index entries that point
	to the more general topic descriptions.
This commit is contained in:
Eli Zaretskii 2006-10-21 13:06:04 +00:00
parent 0ced0c34ad
commit e5ac9b532c
2 changed files with 36 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
gdb/doc/ChangeLog
View file

@ -3,6 +3,10 @@
* gdb.texinfo (Breakpoints, Set Watchpoints): Elaborate and * gdb.texinfo (Breakpoints, Set Watchpoints): Elaborate and
clarify on the possible meanings of ``expression'' watched by clarify on the possible meanings of ``expression'' watched by
watchpoints. Add indexing. watchpoints. Add indexing.
(Prompting, Errors, Invalidation, Annotations for Running)
(Source Annotations): Fix index entries by adding "annotation" to
them, to discriminate from index entries that point to the more
general topic descriptions.
2006-10-17 Daniel Jacobowitz <dan@codesourcery.com> 2006-10-17 Daniel Jacobowitz <dan@codesourcery.com>

64
gdb/doc/gdb.texinfo
View file

@ -21529,34 +21529,34 @@ features the following annotations:
The input types are The input types are
@table @code @table @code
@findex pre-prompt @findex pre-prompt annotation
@findex prompt @findex prompt annotation
@findex post-prompt @findex post-prompt annotation
@item prompt @item prompt
When @value{GDBN} is prompting for a command (the main @value{GDBN} prompt). When @value{GDBN} is prompting for a command (the main @value{GDBN} prompt).
@findex pre-commands @findex pre-commands annotation
@findex commands @findex commands annotation
@findex post-commands @findex post-commands annotation
@item commands @item commands
When @value{GDBN} prompts for a set of commands, like in the @code{commands} When @value{GDBN} prompts for a set of commands, like in the @code{commands}
command. The annotations are repeated for each command which is input. command. The annotations are repeated for each command which is input.
@findex pre-overload-choice @findex pre-overload-choice annotation
@findex overload-choice @findex overload-choice annotation
@findex post-overload-choice @findex post-overload-choice annotation
@item overload-choice @item overload-choice
When @value{GDBN} wants the user to select between various overloaded functions. When @value{GDBN} wants the user to select between various overloaded functions.
@findex pre-query @findex pre-query annotation
@findex query @findex query annotation
@findex post-query @findex post-query annotation
@item query @item query
When @value{GDBN} wants the user to confirm a potentially dangerous operation. When @value{GDBN} wants the user to confirm a potentially dangerous operation.
@findex pre-prompt-for-continue @findex pre-prompt-for-continue annotation
@findex prompt-for-continue @findex prompt-for-continue annotation
@findex post-prompt-for-continue @findex post-prompt-for-continue annotation
@item prompt-for-continue @item prompt-for-continue
When @value{GDBN} is asking the user to press return to continue. Note: Don't When @value{GDBN} is asking the user to press return to continue. Note: Don't
expect this to work well; instead use @code{set height 0} to disable expect this to work well; instead use @code{set height 0} to disable
@ -21568,14 +21568,14 @@ presence of annotations.
@section Errors @section Errors
@cindex annotations for errors, warnings and interrupts @cindex annotations for errors, warnings and interrupts
@findex quit @findex quit annotation
@smallexample @smallexample
^Z^Zquit ^Z^Zquit
@end smallexample @end smallexample
This annotation occurs right before @value{GDBN} responds to an interrupt. This annotation occurs right before @value{GDBN} responds to an interrupt.
@findex error @findex error annotation
@smallexample @smallexample
^Z^Zerror ^Z^Zerror
@end smallexample @end smallexample
@ -21590,7 +21590,7 @@ cannot expect not to receive it either, however; an error annotation
does not necessarily mean that @value{GDBN} is immediately returning all the way does not necessarily mean that @value{GDBN} is immediately returning all the way
to the top level. to the top level.
@findex error-begin @findex error-begin annotation
A quit or error annotation may be preceded by A quit or error annotation may be preceded by
@smallexample @smallexample
@ -21612,13 +21612,13 @@ The following annotations say that certain pieces of state may have
changed. changed.
@table @code @table @code
@findex frames-invalid @findex frames-invalid annotation
@item ^Z^Zframes-invalid @item ^Z^Zframes-invalid
The frames (for example, output from the @code{backtrace} command) may The frames (for example, output from the @code{backtrace} command) may
have changed. have changed.
@findex breakpoints-invalid @findex breakpoints-invalid annotation
@item ^Z^Zbreakpoints-invalid @item ^Z^Zbreakpoints-invalid
The breakpoints may have changed. For example, the user just added or The breakpoints may have changed. For example, the user just added or
@ -21629,8 +21629,8 @@ deleted a breakpoint.
@section Running the Program @section Running the Program
@cindex annotations for running programs @cindex annotations for running programs
@findex starting @findex starting annotation
@findex stopping @findex stopping annotation
When the program starts executing due to a @value{GDBN} command such as When the program starts executing due to a @value{GDBN} command such as
@code{step} or @code{continue}, @code{step} or @code{continue},
@ -21648,16 +21648,16 @@ is output. Before the @code{stopped} annotation, a variety of
annotations describe how the program stopped. annotations describe how the program stopped.
@table @code @table @code
@findex exited @findex exited annotation
@item ^Z^Zexited @var{exit-status} @item ^Z^Zexited @var{exit-status}
The program exited, and @var{exit-status} is the exit status (zero for The program exited, and @var{exit-status} is the exit status (zero for
successful exit, otherwise nonzero). successful exit, otherwise nonzero).
@findex signalled @findex signalled annotation
@findex signal-name @findex signal-name annotation
@findex signal-name-end @findex signal-name-end annotation
@findex signal-string @findex signal-string annotation
@findex signal-string-end @findex signal-string-end annotation
@item ^Z^Zsignalled @item ^Z^Zsignalled
The program exited with a signal. After the @code{^Z^Zsignalled}, the The program exited with a signal. After the @code{^Z^Zsignalled}, the
annotation continues: annotation continues:
@ -21681,17 +21681,17 @@ as @code{Illegal Instruction} or @code{Segmentation fault}.
@var{intro-text}, @var{middle-text}, and @var{end-text} are for the @var{intro-text}, @var{middle-text}, and @var{end-text} are for the
user's benefit and have no particular format. user's benefit and have no particular format.
@findex signal @findex signal annotation
@item ^Z^Zsignal @item ^Z^Zsignal
The syntax of this annotation is just like @code{signalled}, but @value{GDBN} is The syntax of this annotation is just like @code{signalled}, but @value{GDBN} is
just saying that the program received the signal, not that it was just saying that the program received the signal, not that it was
terminated with it. terminated with it.
@findex breakpoint @findex breakpoint annotation
@item ^Z^Zbreakpoint @var{number} @item ^Z^Zbreakpoint @var{number}
The program hit breakpoint number @var{number}. The program hit breakpoint number @var{number}.
@findex watchpoint @findex watchpoint annotation
@item ^Z^Zwatchpoint @var{number} @item ^Z^Zwatchpoint @var{number}
The program hit watchpoint number @var{number}. The program hit watchpoint number @var{number}.
@end table @end table
@ -21700,7 +21700,7 @@ The program hit watchpoint number @var{number}.
@section Displaying Source @section Displaying Source
@cindex annotations for source display @cindex annotations for source display
@findex source @findex source annotation
The following annotation is used instead of displaying source code: The following annotation is used instead of displaying source code:
@smallexample @smallexample