summaryrefslogtreecommitdiffstats
path: root/c-user/fatal_error.rst
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2017-11-12 14:34:48 +1100
committerChris Johns <chrisj@rtems.org>2017-11-12 14:34:48 +1100
commit6c5640131fca82624f72b2bd33b5b5f46156626e (patch)
treeeca99c4c65ff8a3767a26a49f7aeca0af7eedfa0 /c-user/fatal_error.rst
parent42d50d760e6c829d5673299bb8c631b9fa5c1342 (diff)
downloadrtems-docs-6c5640131fca82624f72b2bd33b5b5f46156626e.tar.bz2
c-user: Fix index locations.
Update #3229.
Diffstat (limited to 'c-user/fatal_error.rst')
-rw-r--r--c-user/fatal_error.rst39
1 files changed, 19 insertions, 20 deletions
diff --git a/c-user/fatal_error.rst b/c-user/fatal_error.rst
index c716c89..6cee174 100644
--- a/c-user/fatal_error.rst
+++ b/c-user/fatal_error.rst
@@ -5,12 +5,11 @@
.. COMMENT: All rights reserved.
.. _fatal_error_manager:
+.. index:: fatal errors
Fatal Error Manager
*******************
-.. index:: fatal errors
-
Introduction
============
@@ -34,13 +33,13 @@ provided by the fatal error manager are:
Background
==========
-Overview
---------
-
.. index:: fatal error detection
.. index:: fatal error processing
.. index:: fatal error user extension
+Overview
+--------
+
The fatal error manager is called upon detection of an irrecoverable error
condition by either RTEMS or the application software. Fatal errors are also
used in case it is difficult or impossible to return an error condition by
@@ -388,10 +387,10 @@ Operations
==========
.. _Terminate:
+.. index:: _Terminate
Announcing a Fatal Error
------------------------
-.. index:: _Terminate
The :c:func:`_Terminate()` internal error handler is invoked when the
application or the executive itself determines that a fatal error has occurred
@@ -443,13 +442,13 @@ sequence, related constants, usage, and status codes.
\clearpage
.. _rtems_fatal:
-
-FATAL - Invoke the fatal error
-------------------------------
.. index:: announce fatal error
.. index:: fatal error, announce
.. index:: rtems_fatal
+FATAL - Invoke the fatal error
+------------------------------
+
CALLING SEQUENCE:
.. code-block:: c
@@ -473,12 +472,12 @@ NOTE:
\clearpage
.. _rtems_shutdown_executive:
+.. index:: shutdown RTEMS
+.. index:: rtems_shutdown_executive
SHUTDOWN_EXECUTIVE - Shutdown RTEMS
-----------------------------------
-.. index:: shutdown RTEMS
-.. index:: rtems_shutdown_executive
CALLING SEQUENCE:
.. code-block:: c
@@ -505,11 +504,11 @@ NOTES:
\clearpage
.. _rtems_exception_frame_print:
+.. index:: exception frame
+.. index:: rtems_exception_frame_print
EXCEPTION_FRAME_PRINT - Prints the exception frame
--------------------------------------------------
-.. index:: exception frame
-.. index:: rtems_exception_frame_print
CALLING SEQUENCE:
.. code-block:: c
@@ -529,11 +528,11 @@ DESCRIPTION:
\clearpage
.. _rtems_fatal_source_text:
+.. index:: fatal error
+.. index:: rtems_fatal_source_text
FATAL_SOURCE_TEXT - Returns a text for a fatal source
-----------------------------------------------------
-.. index:: fatal error
-.. index:: rtems_fatal_source_text
CALLING SEQUENCE:
.. code-block:: c
@@ -554,11 +553,11 @@ DESCRIPTION:
\clearpage
.. _rtems_internal_error_text:
+.. index:: fatal error
+.. index:: rtems_internal_error_text
INTERNAL_ERROR_TEXT - Returns a text for an internal error code
---------------------------------------------------------------
-.. index:: fatal error
-.. index:: rtems_internal_error_text
CALLING SEQUENCE:
.. code-block:: c
@@ -579,13 +578,13 @@ DESCRIPTION:
\clearpage
.. _rtems_fatal_error_occurred:
-
-FATAL_ERROR_OCCURRED - Invoke the fatal error handler (deprecated)
-------------------------------------------------------------------
.. index:: announce fatal error
.. index:: fatal error, announce
.. index:: rtems_fatal_error_occurred
+FATAL_ERROR_OCCURRED - Invoke the fatal error handler (deprecated)
+------------------------------------------------------------------
+
CALLING SEQUENCE:
.. code-block:: c