From ff22f78d4605d7037a70fa36232986c7396f2946 Mon Sep 17 00:00:00 2001 From: Parshintsev Anatoly Date: Thu, 4 Jul 2024 20:52:13 +0300 Subject: [PATCH] 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 Reviewed-on: https://review.openocd.org/c/openocd/+/8388 Tested-by: jenkins Reviewed-by: Antonio Borneo --- doc/openocd.texi | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/openocd.texi b/doc/openocd.texi index c78638276..db787fdb2 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}