xref: /aosp_15_r20/external/pigweed/pw_assert_trap/docs.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1*61c4878aSAndroid Build Coastguard Worker.. _module-pw_assert_trap:
2*61c4878aSAndroid Build Coastguard Worker
3*61c4878aSAndroid Build Coastguard Worker===============
4*61c4878aSAndroid Build Coastguard Workerpw_assert_trap
5*61c4878aSAndroid Build Coastguard Worker===============
6*61c4878aSAndroid Build Coastguard Worker
7*61c4878aSAndroid Build Coastguard Worker--------
8*61c4878aSAndroid Build Coastguard WorkerOverview
9*61c4878aSAndroid Build Coastguard Worker--------
10*61c4878aSAndroid Build Coastguard WorkerThe ``pw_assert_trap`` module provides ``PW_ASSERT()`` and ``PW_CHECK_*()``
11*61c4878aSAndroid Build Coastguard Workerbackends for the ``pw_assert`` module. This backend will call
12*61c4878aSAndroid Build Coastguard Worker``__builtin_trap()`` on assert.
13*61c4878aSAndroid Build Coastguard Worker
14*61c4878aSAndroid Build Coastguard Worker..
15*61c4878aSAndroid Build Coastguard Worker   TODO: https://pwbug.dev/351886600 - add docs
16