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/linker_sets.rst | 63 +++++++++++++++++++++++++++++++++----------------- 1 file changed, 42 insertions(+), 21 deletions(-) (limited to 'c-user/linker_sets.rst') diff --git a/c-user/linker_sets.rst b/c-user/linker_sets.rst index a93f829..9b2f1ca 100644 --- a/c-user/linker_sets.rst +++ b/c-user/linker_sets.rst @@ -4,9 +4,10 @@ .. COMMENT: On-Line Applications Research Corporation (OAR). .. COMMENT: All rights reserved. -.. _linker_sets: .. index:: linkersets +.. _linker_sets: + Linker Sets *********** @@ -126,9 +127,10 @@ Directives \clearpage -.. _RTEMS_LINKER_SET_BEGIN: .. index:: RTEMS_LINKER_SET_BEGIN +.. _RTEMS_LINKER_SET_BEGIN: + RTEMS_LINKER_SET_BEGIN - Designator of the linker set begin marker ------------------------------------------------------------------ @@ -159,9 +161,10 @@ NOTE: \clearpage -.. _RTEMS_LINKER_SET_END: .. index:: RTEMS_LINKER_SET_END +.. _RTEMS_LINKER_SET_END: + RTEMS_LINKER_SET_END - Designator of the linker set end marker -------------------------------------------------------------- @@ -181,9 +184,10 @@ DESCRIPTION: \clearpage -.. _RTEMS_LINKER_SET_SIZE: .. index:: RTEMS_LINKER_SET_SIZE +.. _RTEMS_LINKER_SET_SIZE: + RTEMS_LINKER_SET_SIZE - The linker set size in characters --------------------------------------------------------- @@ -202,9 +206,10 @@ DESCRIPTION: \clearpage -.. _RTEMS_LINKER_SET_ITEM_COUNT: .. index:: RTEMS_LINKER_SET_ITEM_COUNT +.. _RTEMS_LINKER_SET_ITEM_COUNT: + RTEMS_LINKER_SET_ITEM_COUNT - The linker set item count --------------------------------------------------------- @@ -222,9 +227,10 @@ DESCRIPTION: \clearpage -.. _RTEMS_LINKER_SET_IS_EMPTY: .. index:: RTEMS_LINKER_SET_IS_EMPTY +.. _RTEMS_LINKER_SET_IS_EMPTY: + RTEMS_LINKER_SET_IS_EMPTY - Is the linker set empty? --------------------------------------------------------- @@ -243,9 +249,10 @@ DESCRIPTION: \clearpage -.. _RTEMS_LINKER_SET_FOREACH: .. index:: RTEMS_LINKER_SET_FOREACH +.. _RTEMS_LINKER_SET_FOREACH: + RTEMS_LINKER_SET_FOREACH - Iterate through the linker set items --------------------------------------------------------- @@ -279,9 +286,10 @@ DESCRIPTION: \clearpage -.. _RTEMS_LINKER_ROSET_DECLARE: .. index:: RTEMS_LINKER_ROSET_DECLARE +.. _RTEMS_LINKER_ROSET_DECLARE: + RTEMS_LINKER_ROSET_DECLARE - Declares a read-only linker set ------------------------------------------------------------ @@ -302,9 +310,10 @@ DESCRIPTION: \clearpage -.. _RTEMS_LINKER_ROSET: .. index:: RTEMS_LINKER_ROSET +.. _RTEMS_LINKER_ROSET: + RTEMS_LINKER_ROSET - Defines a read-only linker set --------------------------------------------------- @@ -325,9 +334,10 @@ DESCRIPTION: \clearpage -.. _RTEMS_LINKER_ROSET_ITEM_DECLARE: .. index:: RTEMS_LINKER_ROSET_ITEM_DECLARE +.. _RTEMS_LINKER_ROSET_ITEM_DECLARE: + RTEMS_LINKER_ROSET_ITEM_DECLARE - Declares a read-only linker set item ---------------------------------------------------------------------- @@ -350,9 +360,10 @@ DESCRIPTION: \clearpage -.. _RTEMS_LINKER_ROSET_ITEM_REFERENCE: .. index:: RTEMS_LINKER_ROSET_ITEM_REFERENCE +.. _RTEMS_LINKER_ROSET_ITEM_REFERENCE: + RTEMS_LINKER_ROSET_ITEM_REFERENCE - References a read-only linker set item -------------------------------------------------------------------------- @@ -375,9 +386,10 @@ DESCRIPTION: \clearpage -.. _RTEMS_LINKER_ROSET_ITEM: .. index:: RTEMS_LINKER_ROSET_ITEM +.. _RTEMS_LINKER_ROSET_ITEM: + RTEMS_LINKER_ROSET_ITEM - Defines a read-only linker set item ------------------------------------------------------------- @@ -400,9 +412,10 @@ DESCRIPTION: \clearpage -.. _RTEMS_LINKER_ROSET_ITEM_ORDERED: .. index:: RTEMS_LINKER_ROSET_ITEM_ORDERED +.. _RTEMS_LINKER_ROSET_ITEM_ORDERED: + RTEMS_LINKER_ROSET_ITEM_ORDERED - Defines an ordered read-only linker set item ------------------------------------------------------------------------------ @@ -457,9 +470,10 @@ NOTES: \clearpage -.. _RTEMS_LINKER_ROSET_CONTENT: .. index:: RTEMS_LINKER_ROSET_CONTENT +.. _RTEMS_LINKER_ROSET_CONTENT: + RTEMS_LINKER_ROSET_CONTENT - Marks a declaration as a read-only linker set content ---------------------------------------------------------------------------------- @@ -479,9 +493,10 @@ DESCRIPTION: \clearpage -.. _RTEMS_LINKER_RWSET_DECLARE: .. index:: RTEMS_LINKER_RWSET_DECLARE +.. _RTEMS_LINKER_RWSET_DECLARE: + RTEMS_LINKER_RWSET_DECLARE - Declares a read-write linker set ------------------------------------------------------------- @@ -502,9 +517,10 @@ DESCRIPTION: \clearpage -.. _RTEMS_LINKER_RWSET: .. index:: RTEMS_LINKER_RWSET +.. _RTEMS_LINKER_RWSET: + RTEMS_LINKER_RWSET - Defines a read-write linker set ---------------------------------------------------- @@ -525,9 +541,10 @@ DESCRIPTION: \clearpage -.. _RTEMS_LINKER_RWSET_ITEM_DECLARE: .. index:: RTEMS_LINKER_RWSET_ITEM_DECLARE +.. _RTEMS_LINKER_RWSET_ITEM_DECLARE: + RTEMS_LINKER_RWSET_ITEM_DECLARE - Declares a read-write linker set item ----------------------------------------------------------------------- @@ -550,9 +567,10 @@ DESCRIPTION: \clearpage -.. _RTEMS_LINKER_RWSET_ITEM_REFERENCE: .. index:: RTEMS_LINKER_RWSET_ITEM_REFERENCE +.. _RTEMS_LINKER_RWSET_ITEM_REFERENCE: + RTEMS_LINKER_RWSET_ITEM_REFERENCE - References a read-write linker set item --------------------------------------------------------------------------- @@ -575,9 +593,10 @@ DESCRIPTION: \clearpage -.. _RTEMS_LINKER_RWSET_ITEM: .. index:: RTEMS_LINKER_RWSET_ITEM +.. _RTEMS_LINKER_RWSET_ITEM: + RTEMS_LINKER_RWSET_ITEM - Defines a read-write linker set item -------------------------------------------------------------- @@ -600,9 +619,10 @@ DESCRIPTION: \clearpage -.. _RTEMS_LINKER_RWSET_ITEM_ORDERED: .. index:: RTEMS_LINKER_RWSET_ITEM_ORDERED +.. _RTEMS_LINKER_RWSET_ITEM_ORDERED: + RTEMS_LINKER_RWSET_ITEM_ORDERED - Defines an ordered read-write linker set item ------------------------------------------------------------------------------- @@ -657,9 +677,10 @@ NOTES: \clearpage -.. _RTEMS_LINKER_RWSET_CONTENT: .. index:: RTEMS_LINKER_RWSET_CONTENT +.. _RTEMS_LINKER_RWSET_CONTENT: + RTEMS_LINKER_RWSET_CONTENT - Marks a declaration as a read-write linker set content ----------------------------------------------------------------------------------- -- cgit v1.2.3