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/object_services.rst | 54 ++++++++++++++++++++++++++++++---------------- 1 file changed, 36 insertions(+), 18 deletions(-) (limited to 'c-user/object_services.rst') diff --git a/c-user/object_services.rst b/c-user/object_services.rst index dd924da..dbe61d3 100644 --- a/c-user/object_services.rst +++ b/c-user/object_services.rst @@ -180,10 +180,11 @@ Directives \clearpage -.. _rtems_build_name: .. index:: build object name .. index:: rtems_build_name +.. _rtems_build_name: + BUILD_NAME - Build object name from characters ---------------------------------------------- @@ -212,11 +213,12 @@ NOTES: \clearpage -.. _rtems_object_get_classic_name: .. index:: get name from id .. index:: obtain name from id .. index:: rtems_object_get_classic_name +.. _rtems_object_get_classic_name: + OBJECT_GET_CLASSIC_NAME - Lookup name from id --------------------------------------------- @@ -250,11 +252,12 @@ NOTES: \clearpage -.. _rtems_object_get_name: .. index:: get object name as string .. index:: obtain object name as string .. index:: rtems_object_get_name +.. _rtems_object_get_name: + OBJECT_GET_NAME - Obtain object name as string ---------------------------------------------- @@ -283,10 +286,11 @@ NOTES: \clearpage -.. _rtems_object_set_name: .. index:: set object name .. index:: rtems_object_set_name +.. _rtems_object_set_name: + OBJECT_SET_NAME - Set object name --------------------------------- @@ -330,10 +334,11 @@ NOTES: \clearpage -.. _rtems_object_id_get_api: .. index:: obtain API from id .. index:: rtems_object_id_get_api +.. _rtems_object_id_get_api: + OBJECT_ID_GET_API - Obtain API from Id -------------------------------------- @@ -359,10 +364,11 @@ NOTES: \clearpage -.. _rtems_object_id_get_class: .. index:: obtain class from object id .. index:: rtems_object_id_get_class +.. _rtems_object_id_get_class: + OBJECT_ID_GET_CLASS - Obtain Class from Id ------------------------------------------ @@ -388,10 +394,11 @@ NOTES: \clearpage -.. _rtems_object_id_get_node: .. index:: obtain node from object id .. index:: rtems_object_id_get_node +.. _rtems_object_id_get_node: + OBJECT_ID_GET_NODE - Obtain Node from Id ---------------------------------------- @@ -417,10 +424,11 @@ NOTES: \clearpage -.. _rtems_object_id_get_index: .. index:: obtain index from object id .. index:: rtems_object_id_get_index +.. _rtems_object_id_get_index: + OBJECT_ID_GET_INDEX - Obtain Index from Id ------------------------------------------ @@ -446,10 +454,11 @@ NOTES: \clearpage -.. _rtems_build_id: .. index:: build object id from components .. index:: rtems_build_id +.. _rtems_build_id: + BUILD_ID - Build Object Id From Components ------------------------------------------ @@ -480,10 +489,11 @@ NOTES: \clearpage -.. _rtems_object_id_api_minimum: .. index:: obtain minimum API value .. index:: rtems_object_id_api_minimum +.. _rtems_object_id_api_minimum: + OBJECT_ID_API_MINIMUM - Obtain Minimum API Value ------------------------------------------------ @@ -505,10 +515,11 @@ NOTES: \clearpage -.. _rtems_object_id_api_maximum: .. index:: obtain maximum API value .. index:: rtems_object_id_api_maximum +.. _rtems_object_id_api_maximum: + OBJECT_ID_API_MAXIMUM - Obtain Maximum API Value ------------------------------------------------ @@ -530,10 +541,11 @@ NOTES: \clearpage -.. _rtems_object_api_minimum_class: .. index:: obtain minimum class value .. index:: rtems_object_api_minimum_class +.. _rtems_object_api_minimum_class: + OBJECT_API_MINIMUM_CLASS - Obtain Minimum Class Value ----------------------------------------------------- @@ -561,10 +573,11 @@ NOTES: \clearpage -.. _rtems_object_api_maximum_class: .. index:: obtain maximum class value .. index:: rtems_object_api_maximum_class +.. _rtems_object_api_maximum_class: + OBJECT_API_MAXIMUM_CLASS - Obtain Maximum Class Value ----------------------------------------------------- @@ -592,10 +605,11 @@ NOTES: \clearpage -.. _rtems_object_id_api_minimum_class: .. index:: obtain minimum class value for an API .. index:: rtems_object_id_api_minimum_class +.. _rtems_object_id_api_minimum_class: + OBJECT_ID_API_MINIMUM_CLASS - Obtain Minimum Class Value for an API ------------------------------------------------------------------- @@ -623,10 +637,11 @@ NOTES: \clearpage -.. _rtems_object_id_api_maximum_class: .. index:: obtain maximum class value for an API .. index:: rtems_object_id_api_maximum_class +.. _rtems_object_id_api_maximum_class: + OBJECT_ID_API_MAXIMUM_CLASS - Obtain Maximum Class Value for an API ------------------------------------------------------------------- @@ -654,10 +669,11 @@ NOTES: \clearpage -.. _rtems_object_get_api_name: .. index:: obtain API name .. index:: rtems_object_get_api_name +.. _rtems_object_get_api_name: + OBJECT_GET_API_NAME - Obtain API Name ------------------------------------- @@ -686,10 +702,11 @@ NOTES: \clearpage -.. _rtems_object_get_api_class_name: .. index:: obtain class name .. index:: rtems_object_get_api_class_name +.. _rtems_object_get_api_class_name: + OBJECT_GET_API_CLASS_NAME - Obtain Class Name --------------------------------------------- @@ -722,10 +739,11 @@ NOTES: \clearpage -.. _rtems_object_get_class_information: .. index:: obtain class information .. index:: rtems_object_get_class_information +.. _rtems_object_get_class_information: + OBJECT_GET_CLASS_INFORMATION - Obtain Class Information ------------------------------------------------------- -- cgit v1.2.3