xref: /aosp_15_r20/external/pigweed/pw_assert_zephyr/docs.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1.. _module-pw_assert_zephyr:
2
3================
4pw_assert_zephyr
5================
6
7--------
8Overview
9--------
10This assert backend implements the ``pw_assert`` facade, by routing the assert
11message to the Zephyr assert subsystem. Failed asserts will call:
121) ``__ASSERT_LOC(condition)``
132) If and only if there's a message ``__ASSERT_MSG_INFO(message, ...)``
143) ``__ASSERT_POST_ACTION()``
15
16To enable the assert module, set ``CONFIG_PIGWEED_ASSERT=y``. After that,
17Zephyr's assert configs can be used to control the behavior via CONFIG_ASSERT_
18and CONFIG_ASSERT_LEVEL_.
19
20.. _CONFIG_ASSERT: https://docs.zephyrproject.org/latest/kconfig.html#CONFIG_ASSERT
21.. _CONFIG_ASSERT_LEVEL: https://docs.zephyrproject.org/latest/kconfig.html#CONFIG_ASSERT_LEVEL
22