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/key_concepts.rst | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) (limited to 'c-user/key_concepts.rst') diff --git a/c-user/key_concepts.rst b/c-user/key_concepts.rst index c88132e..ff28430 100644 --- a/c-user/key_concepts.rst +++ b/c-user/key_concepts.rst @@ -270,9 +270,10 @@ relationships define a directed acyclic graph (DAG). The run-time of the mutex obtain, release and timeout operations depend on the complexity of this resource dependency graph. -.. _PriorityInversion: .. index:: priority inversion +.. _PriorityInversion: + Priority Inversion ------------------ @@ -286,10 +287,11 @@ priority tasks. Because the low priority task is not executing, it cannot complete its interaction with the resource and release that resource. The high priority task is effectively prevented from executing by lower priority tasks. -.. _PriorityCeiling: .. index:: priority ceiling protocol .. index:: immediate ceiling priority protocol +.. _PriorityCeiling: + Immediate Ceiling Priority Protocol (ICPP) ------------------------------------------ @@ -312,9 +314,10 @@ may occur while a thread owns a particular mutex, the priority inheritance protocol is more forgiving in that it does not require this apriori information. -.. _PriorityInheritance: .. index:: priority inheritance protocol +.. _PriorityInheritance: + Priority Inheritance Protocol ----------------------------- @@ -323,9 +326,10 @@ threads that currently wait for ownership of this mutex :cite:`Sha:1990:PI`. Since RTEMS 5.1, priority updates due to the priority inheritance protocol take place immediately and are propagated recursively. -.. _MrsP: .. index:: Multiprocessor Resource Sharing Protocol (MrsP) +.. _MrsP: + Multiprocessor Resource Sharing Protocol (MrsP) ----------------------------------------------- @@ -344,9 +348,10 @@ protocol is available since RTEMS 4.11. It was re-implemented in RTEMS 5.1 to overcome some shortcomings of the original implementation :cite:`Catellani:2015:MrsP`. -.. _OMIP: .. index:: O(m) Independence-Preserving Protocol (OMIP) +.. _OMIP: + O(m) Independence-Preserving Protocol (OMIP) ---------------------------------------------------- -- cgit v1.2.3