From 6c5640131fca82624f72b2bd33b5b5f46156626e Mon Sep 17 00:00:00 2001
From: Chris Johns <chrisj@rtems.org>
Date: Sun, 12 Nov 2017 14:34:48 +1100
Subject: c-user: Fix index locations.

Update #3229.
---
 c-user/chains.rst | 118 ++++++++++++++++++++++++++++++++----------------------
 1 file changed, 71 insertions(+), 47 deletions(-)

(limited to 'c-user/chains.rst')

diff --git a/c-user/chains.rst b/c-user/chains.rst
index 382bc46..73e7980 100644
--- a/c-user/chains.rst
+++ b/c-user/chains.rst
@@ -172,9 +172,10 @@ Add nodes with the following code:
 The chain is initialized and the nodes allocated and appended to the
 chain. This is an example of a pool of buffers.
 
+.. index:: chain iterate
+
 Iterating a Chain
 -----------------
-.. index:: chain iterate
 
 Iterating a chain is a common function. The example shows how to iterate the
 buffer pool chain created in the last section to find buffers starting with a
@@ -219,11 +220,12 @@ The section details the Chains directives.
 
 .. _rtems_chain_initialize:
 
-Initialize Chain With Nodes
----------------------------
 .. index:: chain initialize
 .. index:: rtems_chain_initialize
 
+Initialize Chain With Nodes
+---------------------------
+
 CALLING SEQUENCE:
     .. code-block:: c
 
@@ -256,11 +258,12 @@ NOTES:
 
 .. _rtems_chain_initialize_empty:
 
-Initialize Empty
-----------------
 .. index:: chain initialize empty
 .. index:: rtems_chain_initialize_empty
 
+Initialize Empty
+----------------
+
 CALLING SEQUENCE:
     .. code-block:: c
 
@@ -284,11 +287,12 @@ NOTES:
 
 .. _rtems_chain_is_null_node:
 
-Is Null Node ?
---------------
 .. index:: chain is node null
 .. index:: rtems_chain_is_null_node
 
+Is Null Node ?
+--------------
+
 CALLING SEQUENCE:
     .. code-block:: c
 
@@ -309,11 +313,12 @@ DESCRIPTION:
 
 .. _rtems_chain_head:
 
-Head
-----
 .. index:: chain get head
 .. index:: rtems_chain_head
 
+Head
+----
+
 CALLING SEQUENCE:
     .. code-block:: c
 
@@ -333,11 +338,12 @@ DESCRIPTION:
 
 .. _rtems_chain_tail:
 
-Tail
-----
 .. index:: chain get tail
 .. index:: rtems_chain_tail
 
+Tail
+----
+
 CALLING SEQUENCE:
     .. code-block:: c
 
@@ -357,11 +363,12 @@ DESCRIPTION:
 
 .. _rtems_chain_are_nodes_equal:
 
-Are Two Nodes Equal ?
----------------------
 .. index:: chare are nodes equal
 .. index:: rtems_chain_are_nodes_equal
 
+Are Two Nodes Equal ?
+---------------------
+
 CALLING SEQUENCE:
     .. code-block:: c
 
@@ -384,11 +391,12 @@ DESCRIPTION:
 
 .. _rtems_chain_is_empty:
 
-Is the Chain Empty
-------------------
 .. index:: chain is chain empty
 .. index:: rtems_chain_is_empty
 
+Is the Chain Empty
+------------------
+
 CALLING SEQUENCE:
     .. code-block:: c
 
@@ -410,11 +418,12 @@ DESCRIPTION:
 
 .. _rtems_chain_is_first:
 
-Is this the First Node on the Chain ?
--------------------------------------
 .. index:: chain is node the first
 .. index:: rtems_chain_is_first
 
+Is this the First Node on the Chain ?
+-------------------------------------
+
 CALLING SEQUENCE:
     .. code-block:: c
 
@@ -436,11 +445,12 @@ DESCRIPTION:
 
 .. _rtems_chain_is_last:
 
-Is this the Last Node on the Chain ?
-------------------------------------
 .. index:: chain is node the last
 .. index:: rtems_chain_is_last
 
+Is this the Last Node on the Chain ?
+------------------------------------
+
 CALLING SEQUENCE:
     .. code-block:: c
 
@@ -462,11 +472,12 @@ DESCRIPTION:
 
 .. _rtems_chain_has_only_one_node:
 
-Does this Chain have only One Node ?
-------------------------------------
 .. index:: chain only one node
 .. index:: rtems_chain_has_only_one_node
 
+Does this Chain have only One Node ?
+------------------------------------
+
 CALLING SEQUENCE:
     .. code-block:: c
 
@@ -488,11 +499,12 @@ DESCRIPTION:
 
 .. _rtems_chain_node_count_unprotected:
 
-Returns the node count of the chain (unprotected)
--------------------------------------------------
 .. index:: chain only one node
 .. index:: rtems_chain_node_count_unprotected
 
+Returns the node count of the chain (unprotected)
+-------------------------------------------------
+
 CALLING SEQUENCE:
     .. code-block:: c
 
@@ -512,11 +524,12 @@ DESCRIPTION:
 
 .. _rtems_chain_is_head:
 
-Is this Node the Chain Head ?
------------------------------
 .. index:: chain is node the head
 .. index:: rtems_chain_is_head
 
+Is this Node the Chain Head ?
+-----------------------------
+
 CALLING SEQUENCE:
     .. code-block:: c
 
@@ -539,11 +552,12 @@ DESCRIPTION:
 
 .. _rtems_chain_is_tail:
 
-Is this Node the Chain Tail ?
------------------------------
 .. index:: chain is node the tail
 .. index:: rtems_chain_is_tail
 
+Is this Node the Chain Tail ?
+-----------------------------
+
 CALLING SEQUENCE:
     .. code-block:: c
 
@@ -566,11 +580,12 @@ DESCRIPTION:
 
 .. _rtems_chain_extract:
 
-Extract a Node
---------------
 .. index:: chain extract a node
 .. index:: rtems_chain_extract
 
+Extract a Node
+--------------
+
 CALLING SEQUENCE:
     .. code-block:: c
 
@@ -596,11 +611,12 @@ NOTES:
 
 .. _rtems_chain_extract_unprotected:
 
-Extract a Node (unprotected)
-----------------------------
 .. index:: chain extract a node unprotected
 .. index:: rtems_chain_extract_unprotected
 
+Extract a Node (unprotected)
+----------------------------
+
 CALLING SEQUENCE:
     .. code-block:: c
 
@@ -623,11 +639,12 @@ NOTES:
 
 .. _rtems_chain_get:
 
-Get the First Node
-------------------
 .. index:: chain get first node
 .. index:: rtems_chain_get
 
+Get the First Node
+------------------
+
 CALLING SEQUENCE:
     .. code-block:: c
 
@@ -655,11 +672,12 @@ NOTES:
 
 .. _rtems_chain_get_unprotected:
 
-Get the First Node (unprotected)
---------------------------------
 .. index:: chain get first node
 .. index:: rtems_chain_get_unprotected
 
+Get the First Node (unprotected)
+--------------------------------
+
 CALLING SEQUENCE:
     .. code-block:: c
 
@@ -683,11 +701,12 @@ NOTES:
 
 .. _rtems_chain_insert:
 
-Insert a Node
--------------
 .. index:: chain insert a node
 .. index:: rtems_chain_insert
 
+Insert a Node
+-------------
+
 CALLING SEQUENCE:
     .. code-block:: c
 
@@ -715,11 +734,12 @@ NOTES:
 
 .. _rtems_chain_insert_unprotected:
 
-Insert a Node (unprotected)
----------------------------
 .. index:: chain insert a node unprotected
 .. index:: rtems_chain_insert_unprotected
 
+Insert a Node (unprotected)
+---------------------------
+
 CALLING SEQUENCE:
     .. code-block:: c
 
@@ -744,11 +764,12 @@ NOTES:
 
 .. _rtems_chain_append:
 
-Append a Node
--------------
 .. index:: chain append a node
 .. index:: rtems_chain_append
 
+Append a Node
+-------------
+
 CALLING SEQUENCE:
     .. code-block:: c
 
@@ -775,11 +796,12 @@ NOTES:
 
 .. _rtems_chain_append_unprotected:
 
-Append a Node (unprotected)
----------------------------
 .. index:: chain append a node unprotected
 .. index:: rtems_chain_append_unprotected
 
+Append a Node (unprotected)
+---------------------------
+
 CALLING SEQUENCE:
     .. code-block:: c
 
@@ -803,11 +825,12 @@ NOTES:
 
 .. _rtems_chain_prepend:
 
-Prepend a Node
---------------
 .. index:: prepend node
 .. index:: rtems_chain_prepend
 
+Prepend a Node
+--------------
+
 CALLING SEQUENCE:
     .. code-block:: c
 
@@ -834,11 +857,12 @@ NOTES:
 
 .. _rtems_chain_prepend_unprotected:
 
-Prepend a Node (unprotected)
-----------------------------
 .. index:: prepend node unprotected
 .. index:: rtems_chain_prepend_unprotected
 
+Prepend a Node (unprotected)
+----------------------------
+
 CALLING SEQUENCE:
     .. code-block:: c
 
-- 
cgit v1.2.3