From d09d61ffe48e0fc267aa0238f847d4a5523f6919 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Fri, 21 Jun 2024 18:30:01 +0200 Subject: [PATCH] doxygen: Clarify system termination --- cpukit/doxygen/appl-config.h | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/cpukit/doxygen/appl-config.h b/cpukit/doxygen/appl-config.h index 663e33e4fc..f3b9b52a4f 100644 --- a/cpukit/doxygen/appl-config.h +++ b/cpukit/doxygen/appl-config.h @@ -1792,8 +1792,8 @@ * * then the event records are dumped in Base64 encoding in a fatal error * extension (see Announcing - * a Fatal Error). + * href="https://docs.rtems.org/branches/master/c-user/fatal-error/background.html#terminate">System + * Termination Procedure). * * @par Default Configuration * 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 * in a fatal error extension (see Announcing - * a Fatal Error). + * href="https://docs.rtems.org/branches/master/c-user/fatal-error/background.html#terminate">System + * Termination Procedure). * * @par Default Configuration * If this configuration option is undefined, then the described feature is not @@ -2801,9 +2801,16 @@ * structures of type ::rtems_extensions_table. * * @par Notes + * @parblock * The value of this configuration option is placed before the entries of * #BSP_INITIAL_EXTENSION and after the entries of all other initial user * extensions. + * + * It is recommended that applications provide a fatal extension to customize + * the System + * Termination Procedure. + * @endparblock */ #define CONFIGURE_INITIAL_EXTENSIONS @@ -3824,7 +3831,7 @@ * 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 * remote tasks/threads which can be blocked on objects on this node, see Proxies. + * href="https://docs.rtems.org/branches/master/c-user/multiprocessing/background.html#proxies">Proxies. * * This configuration option is only evaluated if @ref CONFIGURE_MP_APPLICATION * is defined.