coreboot/Documentation
Julius Werner 2bd18edc84 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>
2022-12-28 05:41:23 +00:00
..
_static Documentation: Add static CSS file to fix tables 2018-05-14 17:21:37 +00:00
acpi Documentation: Move devicetree documentation 2022-09-01 23:20:11 +00:00
arch cpu/x86/64bit: Generate static page tables from an assembly file 2022-04-25 14:00:41 +00:00
community Documentation/community: Update leadership meeting link 2022-09-09 20:28:12 +00:00
contributing coding_style: Add more guidelines on error handling, die() and assert() 2022-12-28 05:41:23 +00:00
drivers Documentation: Add wake source info to device tree documentation 2022-12-13 18:50:54 +00:00
getting_started Docs/architecture: Fix filename for coreboot architecture diagram 2022-10-10 07:25:19 +00:00
gfx drivers/intel/gma: Add override for presence straps 2020-05-20 23:38:05 +00:00
infrastructure docs/infra/services: Add Gerrit SSH host keys and fingerprints 2022-07-12 22:41:33 +00:00
lib treewide: Unify Google branding 2022-07-04 14:02:26 +00:00
mainboard doc/mb/ocp/deltalake: add section on how to work on coreboot 2022-12-22 18:55:20 +00:00
northbridge treewide: Unify Google branding 2022-07-04 14:02:26 +00:00
releases Docs/releases: Update release checklist document 2022-10-29 22:51:06 +00:00
RFC Documentation: Get rid of trailing whitespaces 2022-10-13 08:01:01 +00:00
security Documentation/security: Update list of boards supporting vboot 2022-10-16 20:14:31 +00:00
soc Doc/psp_integration.md: Update infomation with latest document 2022-08-12 14:16:18 +00:00
superio Documentation/lint: Use Super I/O instead of SuperIO 2021-11-19 14:47:20 +00:00
technotes Documentation: document the new smbus console feature 2022-10-03 16:15:08 +00:00
tutorial Documentation/flashing_firmware: Add info about SPI flash header 2022-10-10 21:51:43 +00:00
util docs/utils/ifdtool: Fix waning of malformed table 2022-08-10 19:24:16 +00:00
vendorcode Documentation/vendorcode/eltan: Update security document 2020-01-30 13:28:24 +00:00
.gitignore .gitignore: Split into subdirectory files 2020-10-30 07:05:27 +00:00
.mdl_style.rb Documentation: Add mdl style file 2022-07-14 12:38:56 +00:00
acronyms.md Documentation: Add some more acronyms to the list 2022-11-16 15:20:44 +00:00
AMD-S3.txt Documentation: change coreboot to lowercase 2017-06-12 04:06:40 +02:00
beginverbatim.tex Rename documentation -> Documentation 2015-05-06 19:09:47 +02:00
cbfs.txt Fix typos involving "the the" 2018-12-18 13:24:28 +00:00
codeflow.svg Documentation: Remove whitespace before tab 2018-06-04 11:48:23 +00:00
conf.py Documentation: Fix spelling errors 2021-10-05 18:06:24 +00:00
COPYING Documentation/COPYING: Remove trailing whitespace 2018-04-27 09:10:20 +00:00
coreboot_logo.bmp Documentation: Add coreboot logo in BMP format for payload use 2022-07-27 13:58:27 +00:00
coreboot_logo.png Rename documentation -> Documentation 2015-05-06 19:09:47 +02:00
coreboot_logo.svg Documentation: Add the coreboot logo in SVG format 2022-07-21 10:35:16 +00:00
corebootBuildingGuide.tex Use git HTTP URLs without /p in it 2018-04-17 10:38:06 +00:00
distributions.md payloads/tianocore: Rename TianoCore to edk2 2022-08-13 16:35:18 +00:00
documentation_license.md Documentation: Move documentation license to main menu 2022-03-24 15:47:11 +00:00
endverbatim.tex Rename documentation -> Documentation 2015-05-06 19:09:47 +02:00
external_docs.md Docs: Add page for external resources 2022-12-23 02:54:48 +00:00
gcov.txt Documentation: Fix spelling errors 2021-10-05 18:06:24 +00:00
hypertransport.svg Rename documentation -> Documentation 2015-05-06 19:09:47 +02:00
index.md Docs: Add page for external resources 2022-12-23 02:54:48 +00:00
Makefile Docs: Add SPDX headers to Makefiles 2022-11-20 15:24:32 +00:00
Makefile.sphinx Docs: Add SPDX headers to Makefiles 2022-11-20 15:24:32 +00:00
payloads.md Documentation: Get rid of trailing whitespaces 2022-10-13 08:01:01 +00:00
POSTCODES post_code: add post code for video initialization failure 2019-05-22 17:45:11 +00:00
util.md treewide: Unify Google branding 2022-07-04 14:02:26 +00:00