michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: kernel: fatal: update "Build Assertions" section intro paragraph

Browse source 
A long time ago, Zephyr had two macros that could be used for build-time
assertions: BUILD_ASSERT() and BUILD_ASSERT_MSG(). The latter has been
dropped in v2.7 and removed from the documentation; however, the intro
paragraph of the "Build Assertions" section has never been updated to
reflect this, and still confusingly claims that "Zephyr provides two
macros for performing build-time assertions" when only BUILD_ASSERT()
remains.

Update the introductory paragraph of "Build Assertions" section such that
it makes sense now that only one build-time assertion macro exists.

Signed-off-by: Mathieu Choplain <mathieu.choplain@st.com>
This commit is contained in:
Mathieu Choplain 2025-03-17 15:04:46 +01:00 • committed by Benjamin Cabé
commit 25fe4745e6
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/kernel/services/other/fatal.rst
View file

@ -120,8 +120,8 @@ discouraged.
Build Assertions
================
Zephyr provides two macros for performing build-time assertion checks.
These are evaluated completely at compile-time, and are always checked.
Zephyr provides a macro for performing build-time assertion checks.
It is evaluated completely at compile-time and always checked.
BUILD_ASSERT()
--------------