[PATCH]: 21e735b628 doc: document that breakpoints are disabled on step/resume

[gerrit]

This is an automated email from Gerrit.

"Anatoly P <anatoly.parshint...@syntacore.com>" just uploaded a new patch set 
to Gerrit, which you can find at https://review.openocd.org/c/openocd/+/8388

-- gerrit

commit 21e735b62801241a2dfcd1ca7d07008203aff59b
Author: Parshintsev Anatoly <anatoly.parshint...@syntacore.com>
Date:   Thu Jul 4 20:52:13 2024 +0300

    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.parshint...@syntacore.com>

diff --git a/doc/openocd.texi b/doc/openocd.texi
index e46e6004bc..b42c7c750b 100644
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -9240,11 +9240,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}

--