[PATCH]: cc8be1f4b4 target: document possibly unreachable target in deinit_target()

[gerrit]

This is an automated email from Gerrit.

"Tomas Vanek <van...@fbl.cz>" just uploaded a new patch set to Gerrit, which 
you can find at https://review.openocd.org/c/openocd/+/6953

-- gerrit

commit cc8be1f4b45fddd9ab5274fbd837821837f3c58e
Author: Tomas Vanek <van...@fbl.cz>
Date:   Fri Apr 29 10:10:58 2022 +0200

    target: document possibly unreachable target in deinit_target()
    
    Change-Id: I95ff3d200bb2c8f5bc43a34c92726d9c47f8c172
    Signed-off-by: Tomas Vanek <van...@fbl.cz>

diff --git a/src/target/target_type.h b/src/target/target_type.h
index d6b6086b3c..ccd4318ec9 100644
--- a/src/target/target_type.h
+++ b/src/target/target_type.h
@@ -242,6 +242,11 @@ struct target_type {
        /**
         * Free all the resources allocated by the target.
         *
+        * WARNING: deinit_target is called also if a problem prevents to 
establish
+        * JTAG/SWD/... communication.
+        * If you need to talk to the target during deinit, check if
+        * target_was_examined().
+        *
         * @param target The target to deinit
         */
        void (*deinit_target)(struct target *target);

--