coding_style: Add more guidelines on error handling, die() and assert()
commit2bd18edc84b4d9be3a251880d4921f58b0f11d5f
authorJulius Werner <jwerner@chromium.org>
Thu, 15 Dec 2022 16:56:14 +0000 (15 08:56 -0800)
committerMartin L Roth <gaumless@gmail.com>
Wed, 28 Dec 2022 05:41:23 +0000 (28 05:41 +0000)
tree9d5e358fd12deaf6a78cd70c9090cfafa88a9c76
parent5cbf45e1e8d041000b257ebb89b69f0f6de5922d
coding_style: Add more guidelines on error handling, die() and assert()

This patch adds a new section to the coding style which codifies
existing practices about how to handle errors and how to use the die()
and assert() macros. Also clean up some references to Linux-specific
facilities that do not exist in coreboot in the adjacent function return
type guidelines, and add a small blurb of documentation to the
definition of the assert() macro itself.

Signed-off-by: Julius Werner <jwerner@chromium.org>
Change-Id: Ice37ed9f995a56d69476e95a352209041b337284
Reviewed-on: https://review.coreboot.org/c/coreboot/+/70775
Reviewed-by: Elyes Haouas <ehaouas@noos.fr>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Martin L Roth <gaumless@gmail.com>
Documentation/contributing/coding_style.md
src/include/assert.h