doc: document that breakpoints are disabled on step/resume

OpenOCD disables breakpoints on step/resume if they
match the current code position. This is a non-obvious
behavior that should be documented

Change-Id: Id762066569ec6452869a58dfcd9df88c8a14d6ab
Signed-off-by: Parshintsev Anatoly <anatoly.parshintsev@syntacore.com>
Reviewed-on: https://review.openocd.org/c/openocd/+/8388
Tested-by: jenkins
Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>
This commit is contained in:
Parshintsev Anatoly 2024-07-04 20:52:13 +03:00 committed by Antonio Borneo
parent 0bf3373e80
commit ff22f78d46
1 changed files with 8 additions and 0 deletions

View File

@ -9273,11 +9273,19 @@ power consumption (because the CPU is needlessly clocked).
@deffn {Command} {resume} [address] @deffn {Command} {resume} [address]
Resume the target at its current code position, Resume the target at its current code position,
or the optional @var{address} if it is provided. or the optional @var{address} if it is provided.
@b{NOTE:} targets are expected to temporary disable breakpoints
if they match the address of the current code position
or the @var{address} provided by user.
@end deffn @end deffn
@deffn {Command} {step} [address] @deffn {Command} {step} [address]
Single-step the target at its current code position, Single-step the target at its current code position,
or the optional @var{address} if it is provided. or the optional @var{address} if it is provided.
@b{NOTE:} targets are expected to temporary disable breakpoints
if they match the address of the current code position
or the @var{address} provided by user.
@end deffn @end deffn
@anchor{resetcommand} @anchor{resetcommand}