From 6b654bdc870eaf85afa403d4957397823480bca2 Mon Sep 17 00:00:00 2001 From: Jamie McCrae Date: Mon, 14 Aug 2023 11:43:38 +0100 Subject: [PATCH] doc: release: 3.5: Add MCUmgr SMP version 2 stable change note Adds a note on the stable API change of changing the MCUmgr SMP version 2 error entry name to avoid a collision with shell_mgmt which already used "ret". Signed-off-by: Jamie McCrae --- doc/releases/release-notes-3.5.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/releases/release-notes-3.5.rst b/doc/releases/release-notes-3.5.rst index 5652fe8e264..8ac55354256 100644 --- a/doc/releases/release-notes-3.5.rst +++ b/doc/releases/release-notes-3.5.rst @@ -50,6 +50,14 @@ Deprecated in this release Stable API changes in this release ================================== +* MCUmgr SMP version 2 error codes entry has changed due to a collision with an + existing response in shell_mgmt. Previously, these errors had the entry ``ret`` + but now have the entry ``err``. ``smp_add_cmd_ret()`` is now deprecated and + :c:func:`smp_add_cmd_err` should be used instead, ``MGMT_CB_ERROR_RET`` is + now deprecated and :c:enumerator:`MGMT_CB_ERROR_ERR` should be used instead. + SMP version 2 error code defines for in-tree modules have been updated to + replace the ``*_RET_RC_*`` parts with ``*_ERR_*``. + New APIs in this release ========================