From e2e5b49215cabd82f99bdc0c6e1b6f69ff233d19 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Wed, 14 Nov 2012 09:51:41 +0100 Subject: score: Add rtems_fatal() --- doc/user/fatal.t | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) (limited to 'doc/user/fatal.t') diff --git a/doc/user/fatal.t b/doc/user/fatal.t index fd5a7ea0c0..aa9c2bf0a6 100644 --- a/doc/user/fatal.t +++ b/doc/user/fatal.t @@ -15,6 +15,7 @@ manager is: @itemize @bullet @item @code{@value{DIRPREFIX}fatal_error_occurred} - Invoke the fatal error handler +@item @code{@value{DIRPREFIX}fatal} - Invoke the fatal error handler with error source @end itemize @section Background @@ -168,6 +169,36 @@ NOT RETURN to the caller. The user-defined extension for this directive may wish to initiate a global shutdown. +@c +@c +@c +@page +@subsection FATAL - Invoke the fatal error handler with error source + +@cindex announce fatal error +@cindex fatal error, announce + +@subheading CALLING SEQUENCE: + +@ifset is-C +@findex rtems_fatal +@example +void rtems_fatal( + rtems_fatal_source source, + rtems_fatal_code error +); +@end example +@end ifset + +@subheading DIRECTIVE STATUS CODES + +NONE + +@subheading DESCRIPTION: + +This directive invokes the internal error handler with is internal set to +false. See also @code{@value{DIRPREFIX}fatal_error_occurred}. + @c @c @c -- cgit v1.2.3