bartoszek/zephyr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: zbus: add entries to the migration guide

Browse Source 
ZBus had one break change related to the runtime observers'
configuration, and the VDED delivery sequence has changed. This commit
adds entries on the migration guide about the mentioned changes.

Signed-off-by: Rodrigo Peixoto <rodrigopex@gmail.com>
This commit is contained in:
Rodrigo Peixoto 2023-10-11 08:44:44 -03:00 committed by Johan Hedberg
parent d2001eeb96
commit 28eb47922e
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/releases/migration-guide-3.5.rst
View File

@ -271,6 +271,17 @@ Required changes
* The :kconfig:option:`CONFIG_RISCV_MTVEC_VECTORED_MODE` Kconfig option was renamed to
:kconfig:option:`CONFIG_RISCV_VECTORED_MODE`.
* ZBus runtime observers implementation now relies on the HEAP memory instead of a memory slab.
Thus, zbus' configuration (kconfig) related to runtime observers has changed. To keep your runtime
observers code working correctly, you need to:
- Replace the integer ``CONFIG_ZBUS_RUNTIME_OBSERVERS_POOL_SIZE`` with the boolean
:kconfig:option:`CONFIG_ZBUS_RUNTIME_OBSERVERS`;
- Set the HEAP size with the :kconfig:option:`CONFIG_HEAP_MEM_POOL_SIZE`.
* The zbus VDED delivery sequence has changed. Check the :ref:`documentation<zbus delivery
sequence>` to verify if it will affect your code.
Recommended Changes
*******************