aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorParshintsev Anatoly <anatoly.parshintsev@syntacore.com>2024-07-04 20:52:13 +0300
committerAntonio Borneo <borneo.antonio@gmail.com>2024-08-25 12:42:14 +0000
commitff22f78d4605d7037a70fa36232986c7396f2946 (patch)
tree7262c122471b892556f5c6bcbffcdec40e56ac86
parent0bf3373e808a097fdf50fc04f987c26b35ddf09d (diff)
downloadriscv-openocd-ff22f78d4605d7037a70fa36232986c7396f2946.zip
riscv-openocd-ff22f78d4605d7037a70fa36232986c7396f2946.tar.gz
riscv-openocd-ff22f78d4605d7037a70fa36232986c7396f2946.tar.bz2
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>
-rw-r--r--doc/openocd.texi8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/openocd.texi b/doc/openocd.texi
index c786382..db787fd 100644
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -9273,11 +9273,19 @@ power consumption (because the CPU is needlessly clocked).
@deffn {Command} {resume} [address]
Resume the target at its current code position,
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
@deffn {Command} {step} [address]
Single-step the target at its current code position,
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
@anchor{resetcommand}