RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

doxygen: Clarify system termination

Browse Source
This commit is contained in:
Sebastian Huber
2024-06-21 18:30:01 +02:00
parent 2089f993c0
commit d09d61ffe4
1 changed files with 12 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
cpukit/doxygen/appl-config.h
View File

@@ -1792,8 +1792,8 @@
* *
* then the event records are dumped in Base64 encoding in a fatal error * then the event records are dumped in Base64 encoding in a fatal error
* extension (see <a * extension (see <a
* href="https://docs.rtems.org/branches/master/c-user/fatal_error.html#announcing-a-fatal-error">Announcing * href="https://docs.rtems.org/branches/master/c-user/fatal-error/background.html#terminate">System
* a Fatal Error</a>). * Termination Procedure</a>).
* *
* @par Default Configuration * @par Default Configuration
* If this configuration option is undefined, then the described feature is not * If this configuration option is undefined, then the described feature is not
@@ -1819,8 +1819,8 @@
* *
* then the event records are compressed by zlib and dumped in Base64 encoding * then the event records are compressed by zlib and dumped in Base64 encoding
* in a fatal error extension (see <a * in a fatal error extension (see <a
* href="https://docs.rtems.org/branches/master/c-user/fatal_error.html#announcing-a-fatal-error">Announcing * href="https://docs.rtems.org/branches/master/c-user/fatal-error/background.html#terminate">System
* a Fatal Error</a>). * Termination Procedure</a>).
* *
* @par Default Configuration * @par Default Configuration
* If this configuration option is undefined, then the described feature is not * If this configuration option is undefined, then the described feature is not
@@ -2801,9 +2801,16 @@
* structures of type ::rtems_extensions_table. * structures of type ::rtems_extensions_table.
* *
* @par Notes * @par Notes
* @parblock
* The value of this configuration option is placed before the entries of * The value of this configuration option is placed before the entries of
* #BSP_INITIAL_EXTENSION and after the entries of all other initial user * #BSP_INITIAL_EXTENSION and after the entries of all other initial user
* extensions. * extensions.
*
* It is recommended that applications provide a fatal extension to customize
* the <a
* href="https://docs.rtems.org/branches/master/c-user/fatal-error/background.html#terminate">System
* Termination Procedure</a>.
* @endparblock
*/ */
#define CONFIGURE_INITIAL_EXTENSIONS #define CONFIGURE_INITIAL_EXTENSIONS
@@ -3824,7 +3831,7 @@
* Since a proxy is used to represent a remote task/thread which is blocking on * Since a proxy is used to represent a remote task/thread which is blocking on
* this node. This configuration parameter reflects the maximum number of * this node. This configuration parameter reflects the maximum number of
* remote tasks/threads which can be blocked on objects on this node, see <a * remote tasks/threads which can be blocked on objects on this node, see <a
* href="https://docs.rtems.org/branches/master/c-user/multiprocessing.html#proxies">Proxies</a>. * href="https://docs.rtems.org/branches/master/c-user/multiprocessing/background.html#proxies">Proxies</a>.
* *
* This configuration option is only evaluated if @ref CONFIGURE_MP_APPLICATION * This configuration option is only evaluated if @ref CONFIGURE_MP_APPLICATION
* is defined. * is defined.