From 33849946ff6022c26722ec71248fd76aa55de4ef Mon Sep 17 00:00:00 2001 From: Chris Johns Date: Mon, 13 Nov 2017 13:25:18 +1100 Subject: 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. --- c-user/fatal_error.rst | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) (limited to 'c-user/fatal_error.rst') 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) ------------------------------------------------------------------ -- cgit v1.2.3