c-user: Document RTEMS_FATAL_SOURCE_HEAP

Close #3806.
2025-05-14 00:59:17 +08:00 · 2019-10-31 13:29:41 +01:00 · 2019-10-31 13:29:41 +01:00 · dee158cd68
commit dee158cd68
parent 13ed966164
1 changed files with 4 additions and 0 deletions
--- a/c-user/fatal_error.rst
+++ b/c-user/fatal_error.rst
@ -129,6 +129,10 @@ RTEMS_FATAL_SOURCE_INVALID_HEAP_FREE (12)
    Fatal source for invalid C program heap frees via :c:func:`free`.  The
    fatal code is the bad pointer.

+RTEMS_FATAL_SOURCE_HEAP (13)
+    Fatal source for heap errors.  The fatal code is the address to a heap error
+    context.  See :c:type:`Heap_Error_context`.
+
 .. _internal_errors:

 Internal Error Codes