michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: release: 3.5: Add MCUmgr SMP version 2 stable change note

Browse source 
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 <jamie.mccrae@nordicsemi.no>
This commit is contained in:
Jamie McCrae 2023-08-14 11:43:38 +01:00 • committed by Carles Cufí
commit 6b654bdc87
1 changed files with 8 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/releases/release-notes-3.5.rst
View file

@ -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
========================