mirror of
https://github.com/espressif/esp-idf.git
synced 2025-12-07 17:08:49 +00:00
docs: Add section about assertions to the style guide
This commit is contained in:
@@ -10,13 +10,13 @@ Overview
|
||||
Identifying and handling run-time errors is important for developing robust applications. There can be multiple kinds of run-time errors:
|
||||
|
||||
- Recoverable errors:
|
||||
|
||||
|
||||
- Errors indicated by functions through return values (error codes)
|
||||
- C++ exceptions, thrown using ``throw`` keyword
|
||||
|
||||
- Unrecoverable (fatal) errors:
|
||||
|
||||
- Failed assertions (using ``assert`` macro and equivalent methods) and ``abort()`` calls.
|
||||
|
||||
- Failed assertions (using ``assert`` macro and equivalent methods, see :ref:`assertions`) and ``abort()`` calls.
|
||||
- CPU exceptions: access to protected regions of memory, illegal instruction, etc.
|
||||
- System level checks: watchdog timeout, cache access error, stack overflow, stack smashing, heap corruption, etc.
|
||||
|
||||
@@ -43,6 +43,8 @@ Additionally, :cpp:func:`esp_err_to_name_r` function will attempt to interpret t
|
||||
|
||||
This feature is enabled by default, but can be disabled to reduce application binary size. See :ref:`CONFIG_ESP_ERR_TO_NAME_LOOKUP`. When this feature is disabled, :cpp:func:`esp_err_to_name` and :cpp:func:`esp_err_to_name_r` are still defined and can be called. In this case, :cpp:func:`esp_err_to_name` will return ``UNKNOWN ERROR``, and :cpp:func:`esp_err_to_name_r` will return ``Unknown error 0xXXXX(YYYYY)``, where ``0xXXXX`` and ``YYYYY`` are the hexadecimal and decimal representations of the error code, respectively.
|
||||
|
||||
.. _esp-error-check-macro:
|
||||
|
||||
``ESP_ERROR_CHECK`` macro
|
||||
-------------------------
|
||||
|
||||
|
||||
Reference in New Issue
Block a user