Skip to content

Commit 28eb479

Browse files
rodrigopexjhedberg
authored andcommitted
doc: zbus: add entries to the migration guide
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 <[email protected]>
1 parent d2001ee commit 28eb479

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

doc/releases/migration-guide-3.5.rst

+11
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,17 @@ Required changes
271271
* The :kconfig:option:`CONFIG_RISCV_MTVEC_VECTORED_MODE` Kconfig option was renamed to
272272
:kconfig:option:`CONFIG_RISCV_VECTORED_MODE`.
273273

274+
* ZBus runtime observers implementation now relies on the HEAP memory instead of a memory slab.
275+
Thus, zbus' configuration (kconfig) related to runtime observers has changed. To keep your runtime
276+
observers code working correctly, you need to:
277+
278+
- Replace the integer ``CONFIG_ZBUS_RUNTIME_OBSERVERS_POOL_SIZE`` with the boolean
279+
:kconfig:option:`CONFIG_ZBUS_RUNTIME_OBSERVERS`;
280+
- Set the HEAP size with the :kconfig:option:`CONFIG_HEAP_MEM_POOL_SIZE`.
281+
282+
* The zbus VDED delivery sequence has changed. Check the :ref:`documentation<zbus delivery
283+
sequence>` to verify if it will affect your code.
284+
274285
Recommended Changes
275286
*******************
276287

0 commit comments

Comments
 (0)