summaryrefslogtreecommitdiffstats
path: root/c-user/fatal_error.rst
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2017-11-13 13:25:18 +1100
committerChris Johns <chrisj@rtems.org>2017-11-13 13:25:18 +1100
commit33849946ff6022c26722ec71248fd76aa55de4ef (patch)
treef082f683008e92f0894d8ac36bc4c83d4860bd37 /c-user/fatal_error.rst
parentac0eaff94117757046867bc92797d6c2dae78cd4 (diff)
downloadrtems-docs-33849946ff6022c26722ec71248fd76aa55de4ef.tar.bz2
Clean up sphinx warnings.
- Fix minor formatting issues. - Fix reference the gloassary TLS using ':term:'. - Make sure nothing is between an anchor and the heading where ':ref:' references the anchor. This meant moving all the recently added '.. index::' entries. Update #3232. Update #3229.
Diffstat (limited to 'c-user/fatal_error.rst')
-rw-r--r--c-user/fatal_error.rst24
1 files changed, 16 insertions, 8 deletions
diff --git a/c-user/fatal_error.rst b/c-user/fatal_error.rst
index 6cee174..8aa7c52 100644
--- a/c-user/fatal_error.rst
+++ b/c-user/fatal_error.rst
@@ -4,9 +4,10 @@
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.
-.. _fatal_error_manager:
.. index:: fatal errors
+.. _fatal_error_manager:
+
Fatal Error Manager
*******************
@@ -386,9 +387,10 @@ INTERNAL_ERROR_LIBIO_STDERR_FD_OPEN_FAILED (37)
Operations
==========
-.. _Terminate:
.. index:: _Terminate
+.. _Terminate:
+
Announcing a Fatal Error
------------------------
@@ -441,11 +443,12 @@ sequence, related constants, usage, and status codes.
\clearpage
-.. _rtems_fatal:
.. index:: announce fatal error
.. index:: fatal error, announce
.. index:: rtems_fatal
+.. _rtems_fatal:
+
FATAL - Invoke the fatal error
------------------------------
@@ -471,10 +474,11 @@ NOTE:
\clearpage
-.. _rtems_shutdown_executive:
.. index:: shutdown RTEMS
.. index:: rtems_shutdown_executive
+.. _rtems_shutdown_executive:
+
SHUTDOWN_EXECUTIVE - Shutdown RTEMS
-----------------------------------
@@ -503,10 +507,11 @@ NOTES:
\clearpage
-.. _rtems_exception_frame_print:
.. index:: exception frame
.. index:: rtems_exception_frame_print
+.. _rtems_exception_frame_print:
+
EXCEPTION_FRAME_PRINT - Prints the exception frame
--------------------------------------------------
@@ -527,10 +532,11 @@ DESCRIPTION:
\clearpage
-.. _rtems_fatal_source_text:
.. index:: fatal error
.. index:: rtems_fatal_source_text
+.. _rtems_fatal_source_text:
+
FATAL_SOURCE_TEXT - Returns a text for a fatal source
-----------------------------------------------------
@@ -552,10 +558,11 @@ DESCRIPTION:
\clearpage
-.. _rtems_internal_error_text:
.. index:: fatal error
.. index:: rtems_internal_error_text
+.. _rtems_internal_error_text:
+
INTERNAL_ERROR_TEXT - Returns a text for an internal error code
---------------------------------------------------------------
@@ -577,11 +584,12 @@ DESCRIPTION:
\clearpage
-.. _rtems_fatal_error_occurred:
.. index:: announce fatal error
.. index:: fatal error, announce
.. index:: rtems_fatal_error_occurred
+.. _rtems_fatal_error_occurred:
+
FATAL_ERROR_OCCURRED - Invoke the fatal error handler (deprecated)
------------------------------------------------------------------