From 0500b9aeb53a7b72f12419de62fd5d893ab7494d Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Tue, 1 Dec 2020 14:23:41 +0100 Subject: interface/interfacedoc: Format parameter names --- rtemsspec/interface.py | 8 ++++++++ rtemsspec/interfacedoc.py | 6 ++++++ rtemsspec/tests/spec-interface/func.yml | 1 + rtemsspec/tests/test_interface.py | 2 +- rtemsspec/tests/test_interfacedoc.py | 2 +- spec/rtems/barrier/if/ident.yml | 2 +- spec/rtems/dpmem/if/ident.yml | 2 +- spec/rtems/event/if/receive.yml | 24 ++++++++++++------------ spec/rtems/event/if/send.yml | 6 +++--- spec/rtems/message/if/ident.yml | 4 ++-- spec/rtems/object/if/build-name.yml | 4 ++-- spec/rtems/object/if/get-name.yml | 2 +- spec/rtems/object/if/id-get-api.yml | 2 +- spec/rtems/object/if/id-get-class.yml | 2 +- spec/rtems/object/if/id-get-index.yml | 2 +- spec/rtems/object/if/id-get-node.yml | 2 +- spec/rtems/object/if/set-name.yml | 8 ++++---- spec/rtems/part/if/create.yml | 32 ++++++++++++++++---------------- spec/rtems/part/if/get-buffer.yml | 6 +++--- spec/rtems/part/if/ident.yml | 4 ++-- spec/rtems/part/if/return-buffer.yml | 6 +++--- spec/rtems/ratemon/if/ident.yml | 2 +- spec/rtems/region/if/ident.yml | 2 +- spec/rtems/sem/if/ident.yml | 4 ++-- spec/rtems/task/if/ident.yml | 4 ++-- spec/rtems/timer/if/ident.yml | 2 +- spec/rtems/userext/if/ident.yml | 2 +- 27 files changed, 79 insertions(+), 64 deletions(-) diff --git a/rtemsspec/interface.py b/rtemsspec/interface.py index 04536232..c9b07ff0 100644 --- a/rtemsspec/interface.py +++ b/rtemsspec/interface.py @@ -59,6 +59,10 @@ def _get_value_forward_declaration(ctx: ItemGetValueContext) -> Any: return _forward_declaration(ctx.item) +def _get_value_params(ctx: ItemGetValueContext) -> Any: + return f"``{ctx.value[ctx.key]}``" + + class _InterfaceMapper(ItemMapper): def __init__(self, node: "Node"): super().__init__(node.item) @@ -70,6 +74,8 @@ class _InterfaceMapper(ItemMapper): _get_value_forward_declaration) self.add_get_value("interface/function/doc:/name", get_value_doxygen_function) + self.add_get_value("interface/function/doc:/params/name", + _get_value_params) self.add_get_value("interface/enumerator/doc:/name", get_value_double_colon) self.add_get_value("interface/typedef/doc:/name", @@ -78,6 +84,8 @@ class _InterfaceMapper(ItemMapper): self.add_get_value("interface/enum/doc:/name", get_value_hash) self.add_get_value("interface/macro/doc:/name", get_value_doxygen_function) + self.add_get_value("interface/macro/doc:/params/name", + _get_value_params) self.add_get_value("interface/variable/doc:/name", get_value_hash) for opt in ["feature-enable", "feature", "initializer", "integer"]: name = f"interface/appl-config-option/{opt}/doc:/name" diff --git a/rtemsspec/interfacedoc.py b/rtemsspec/interfacedoc.py index 6109a711..5e7e3106 100644 --- a/rtemsspec/interfacedoc.py +++ b/rtemsspec/interfacedoc.py @@ -64,11 +64,17 @@ def _get_value_function(ctx: ItemGetValueContext) -> Any: return _get_reference(ctx.value[ctx.key]) +def _get_param(ctx: ItemGetValueContext) -> Any: + return f"``{ctx.value[ctx.key].lstrip('_')}``" + + class _Mapper(SphinxMapper): def __init__(self, item: Item): super().__init__(item) self.add_get_value("interface/function:/name", _get_value_function) self.add_get_value("interface/macro:/name", _get_value_function) + self.add_get_value("interface/function:/params/name", _get_param) + self.add_get_value("interface/macro:/params/name", _get_param) def _generate_introduction(target: str, group: Item, diff --git a/rtemsspec/tests/spec-interface/func.yml b/rtemsspec/tests/spec-interface/func.yml index c5177826..e5dc909b 100644 --- a/rtemsspec/tests/spec-interface/func.yml +++ b/rtemsspec/tests/spec-interface/func.yml @@ -17,6 +17,7 @@ description: | Function description. References to ${func2:/name}, ${td:/name}, ${enum:/name}, ${define:/name}, ${macro:/name}, ${var:/name}, ${enumerator-0:/name}, ${s:/name}, ${option:/name}, and ${option:/type}. + Second parameter is ${.:/params[1]/name}. enabled-by: true index-entries: [] interface-type: function diff --git a/rtemsspec/tests/test_interface.py b/rtemsspec/tests/test_interface.py index 924ab324..2ac2f3e9 100644 --- a/rtemsspec/tests/test_interface.py +++ b/rtemsspec/tests/test_interface.py @@ -205,7 +205,7 @@ typedef enum EnumB { * * Function description. References to VeryLongFunction(), ::Integer, #Enum, * #DEFINE, VERY_LONG_MACRO(), #Variable, ::ENUMERATOR_0, Struct, #a, and - * interface. + * interface. Second parameter is ``Param1``. * * @param Param0 is parameter 0. * diff --git a/rtemsspec/tests/test_interfacedoc.py b/rtemsspec/tests/test_interfacedoc.py index e7073027..c1c8f371 100644 --- a/rtemsspec/tests/test_interfacedoc.py +++ b/rtemsspec/tests/test_interfacedoc.py @@ -444,6 +444,6 @@ Function brief description. Function description. References to :ref:`InterfaceVeryLongFunction`, :c:type:`Integer`, :c:type:`Enum`, :c:macro:`DEFINE`, :ref:`InterfaceVERYLONGMACRO`, Variable, :c:macro:`ENUMERATOR_0`, -:c:type:`Struct`, :ref:`a`, and interface. +:c:type:`Struct`, :ref:`a`, and interface. Second parameter is ``Param1``. """ assert content == src.read() diff --git a/spec/rtems/barrier/if/ident.yml b/spec/rtems/barrier/if/ident.yml index 7276829e..d99a65d2 100644 --- a/spec/rtems/barrier/if/ident.yml +++ b/spec/rtems/barrier/if/ident.yml @@ -15,7 +15,7 @@ definition: variants: [] description: | This directive obtains the barrier identifier associated with the barrier - name specified in ``${.:/params[0]/name}``. + name specified in ${.:/params[0]/name}. enabled-by: true index-entries: [] interface-type: function diff --git a/spec/rtems/dpmem/if/ident.yml b/spec/rtems/dpmem/if/ident.yml index 24649d62..7946c28e 100644 --- a/spec/rtems/dpmem/if/ident.yml +++ b/spec/rtems/dpmem/if/ident.yml @@ -15,7 +15,7 @@ definition: variants: [] description: | This directive obtains the port identifier associated with the port name - specified in ``${.:/params[0]/name}``. + specified in ${.:/params[0]/name}. enabled-by: true index-entries: [] interface-type: function diff --git a/spec/rtems/event/if/receive.yml b/spec/rtems/event/if/receive.yml index 2d6d6834..8e502972 100644 --- a/spec/rtems/event/if/receive.yml +++ b/spec/rtems/event/if/receive.yml @@ -23,13 +23,13 @@ description: | * receive events. To **get the pending events** use the constant ${pending-events:/name} for - the ``${.:/params[0]/name}`` parameter. The pending events are returned to + the ${.:/params[0]/name} parameter. The pending events are returned to the calling task but the event set of the task is left unaltered. The - ``${.:/params[1]/name}`` and ``${.:params[2]/name}`` parameters are ignored + ${.:/params[1]/name} and ${.:/params[2]/name} parameters are ignored in this case. The directive returns immediately and does not block. To **receive events** you have to define an input event condition and some - options. The **option set** specified in ``${.:/params[1]/name}`` defines + options. The **option set** specified in ${.:/params[1]/name} defines * if the task will wait or poll for the events, and @@ -41,17 +41,17 @@ description: | The task can **wait** or **poll** for the events. * **Waiting** for events is the default and can be emphasized through the use - of the ${../../option/if/wait:/name} option. The ``${.:/params[2]/name}`` + of the ${../../option/if/wait:/name} option. The ${.:/params[2]/name} parameter defines how long the task is willing to wait. Use ${../../type/if/no-timeout:/name} to wait potentially forever, otherwise set a timeout interval in clock ticks. * Not waiting for events (**polling**) is selected by the ${../../option/if/no-wait:/name} option. If this option is defined, then - the ``${.:/params[2]/name}`` parameter is ignored. + the ${.:/params[2]/name} parameter is ignored. The task can receive **all** or **any** of the input events specified in - ``${.:/params[0]/name}``. + ${.:/params[0]/name}. * Receiving **all** input events is the default and can be emphasized through the use of the ${../../option/if/event-all:/name} option. @@ -71,18 +71,18 @@ notes: | This directive shall be called by a task. Calling this directive from interrupt context is undefined behaviour. - This directive only affects the events specified in ``${.:/params[0]/name}``. + This directive only affects the events specified in ${.:/params[0]/name}. Any pending events that do not correspond to any of the events specified in - ``${.:/params[0]/name}`` will be left pending. + ${.:/params[0]/name} will be left pending. To receive all events use the event set constant ${all-events:/name} for the - ``${.:/params[0]/name}`` parameter. Do not confuse this event set constant + ${.:/params[0]/name} parameter. Do not confuse this event set constant with the directive option ${../../option/if/event-all:/name}. A task can **receive all of the pending events** by calling the directive - with a value of ${all-events:/name} for the ``${.:/params[0]/name}`` + with a value of ${all-events:/name} for the ${.:/params[0]/name} parameter and the bitwise or of the ${../../option/if/no-wait:/name} and - ${../../option/if/event-any:/name} options for the ``${.:/params[1]/name}`` + ${../../option/if/event-any:/name} options for the ${.:/params[1]/name} parameter. The pending events are returned and the event set of the task is cleared. If no events are pending then the ${../../status/if/unsatisfied:/name} status code will be returned. @@ -113,7 +113,7 @@ return: The requested operation was successful. value: ${../../status/if/successful:/name} - description: | - The ``${.:/params[3]/name}`` parameter was ${/c/if/null:/name}. + The ${.:/params[3]/name} parameter was ${/c/if/null:/name}. value: ${../../status/if/invalid-address:/name} - description: | The events of interest were not immediately available. diff --git a/spec/rtems/event/if/send.yml b/spec/rtems/event/if/send.yml index 8a852b5c..a2ff4d4f 100644 --- a/spec/rtems/event/if/send.yml +++ b/spec/rtems/event/if/send.yml @@ -14,8 +14,8 @@ definition: return: ${../../status/if/code:/name} variants: [] description: | - This directive sends the event set, ``${.:/params[1]/name}``, to the target - task identified by ``${.:/params[0]/name}``. Based upon the state of the + This directive sends the event set, ${.:/params[1]/name}, to the target + task identified by ${.:/params[0]/name}. Based upon the state of the target task, one of the following situations applies: * The target task is blocked waiting for events, then @@ -40,7 +40,7 @@ name: rtems_event_send notes: | Events can be sent by tasks or an ${/glossary/isr:/term}. - Specifying ${../../task/if/self-define:/name} for ``${.:/params[0]/name}`` results + Specifying ${../../task/if/self-define:/name} for ${.:/params[0]/name} results in the event set being sent to the calling task. The event set to send shall be built by a *bitwise or* of the desired events. diff --git a/spec/rtems/message/if/ident.yml b/spec/rtems/message/if/ident.yml index cc3adceb..3680adc3 100644 --- a/spec/rtems/message/if/ident.yml +++ b/spec/rtems/message/if/ident.yml @@ -16,9 +16,9 @@ definition: variants: [] description: | This directive obtains the message queue identifier associated with the - message queue name specified in ``${.:/params[0]/name}``. + message queue name specified in ${.:/params[0]/name}. - The node to search is specified in ``${.:/params[1]/name}``. It shall be + The node to search is specified in ${.:/params[1]/name}. It shall be * a valid node number, diff --git a/spec/rtems/object/if/build-name.yml b/spec/rtems/object/if/build-name.yml index 7a28b24a..920b2d18 100644 --- a/spec/rtems/object/if/build-name.yml +++ b/spec/rtems/object/if/build-name.yml @@ -10,8 +10,8 @@ definition: variants: [] description: | This directive takes the four characters provided as arguments and composes a - 32-bit object name with ``${.:params[0]/name}`` in the most significant - 8-bits and ``${.:params[3]/name}`` in the least significant 8-bits. + 32-bit object name with ${.:/params[0]/name} in the most significant + 8-bits and ${.:/params[3]/name} in the least significant 8-bits. enabled-by: true index-entries: [] interface-type: macro diff --git a/spec/rtems/object/if/get-name.yml b/spec/rtems/object/if/get-name.yml index b9002399..6d3c9ca8 100644 --- a/spec/rtems/object/if/get-name.yml +++ b/spec/rtems/object/if/get-name.yml @@ -48,7 +48,7 @@ params: name: name return: return: | - Returns the ``${.:/params[2]/name}`` parameter value, if there is an object + Returns the ${.:/params[2]/name} parameter value, if there is an object name associated with the object identifier. return-values: - description: | diff --git a/spec/rtems/object/if/id-get-api.yml b/spec/rtems/object/if/id-get-api.yml index 6c545803..4068cd71 100644 --- a/spec/rtems/object/if/id-get-api.yml +++ b/spec/rtems/object/if/id-get-api.yml @@ -21,7 +21,7 @@ notes: | This directive is strictly local and does not impact task scheduling. This directive does not validate the object identifier provided in - ``${.:/params[0]/name}``. + ${.:/params[0]/name}. A body is also provided. params: diff --git a/spec/rtems/object/if/id-get-class.yml b/spec/rtems/object/if/id-get-class.yml index 3b091ac8..172b1d1b 100644 --- a/spec/rtems/object/if/id-get-class.yml +++ b/spec/rtems/object/if/id-get-class.yml @@ -21,7 +21,7 @@ notes: | This directive is strictly local and does not impact task scheduling. This directive does not validate the object identifier provided in - ``${.:/params[0]/name}``. + ${.:/params[0]/name}. A body is also provided. params: diff --git a/spec/rtems/object/if/id-get-index.yml b/spec/rtems/object/if/id-get-index.yml index 7de2d018..7b85033b 100644 --- a/spec/rtems/object/if/id-get-index.yml +++ b/spec/rtems/object/if/id-get-index.yml @@ -21,7 +21,7 @@ notes: | This directive is strictly local and does not impact task scheduling. This directive does not validate the object identifier provided in - ``${.:/params[0]/name}``. + ${.:/params[0]/name}. A body is also provided. params: diff --git a/spec/rtems/object/if/id-get-node.yml b/spec/rtems/object/if/id-get-node.yml index 4cd0d318..98f752eb 100644 --- a/spec/rtems/object/if/id-get-node.yml +++ b/spec/rtems/object/if/id-get-node.yml @@ -21,7 +21,7 @@ notes: | This directive is strictly local and does not impact task scheduling. This directive does not validate the object identifier provided in - ``${.:/params[0]/name}``. + ${.:/params[0]/name}. A body is also provided. params: diff --git a/spec/rtems/object/if/set-name.yml b/spec/rtems/object/if/set-name.yml index 677358c7..6802d385 100644 --- a/spec/rtems/object/if/set-name.yml +++ b/spec/rtems/object/if/set-name.yml @@ -31,14 +31,14 @@ notes: | This directive can be used to set the name of objects which do not have a naming scheme per their API. - If the object specified by ``${.:/params[0]/name}`` is of a class that has a + If the object specified by ${.:/params[0]/name} is of a class that has a string name, this directive will free the existing name to the RTEMS Workspace and allocate enough memory from the RTEMS Workspace to make a copy of the - string located at ``${.:/params[1]/name}``. + string located at ${.:/params[1]/name}. - If the object specified by ``${.:/params[0]/name}`` is of a class that has a + If the object specified by ${.:/params[0]/name} is of a class that has a 32-bit integer style name, then the first four characters in - ``${.:/params[1]/name}`` will be used to construct the name. + ${.:/params[1]/name} will be used to construct the name. params: - description: | is the object identifier of the object to set the name. diff --git a/spec/rtems/part/if/create.yml b/spec/rtems/part/if/create.yml index 119b288b..dbe3cf64 100644 --- a/spec/rtems/part/if/create.yml +++ b/spec/rtems/part/if/create.yml @@ -19,13 +19,13 @@ definition: variants: [] description: | This directive creates a partition of fixed size buffers from a physically - contiguous memory space which starts at ``${.:/params[1]/name}`` and is - ``${.:/params[2]/name}`` bytes in size. Each allocated buffer is to be of - ``${.:/params[3]/name}`` in bytes. The assigned partition identifier is - returned in ``${.:/params[5]/name}``. This partition identifier is used to + contiguous memory space which starts at ${.:/params[1]/name} and is + ${.:/params[2]/name} bytes in size. Each allocated buffer is to be of + ${.:/params[3]/name} in bytes. The assigned partition identifier is + returned in ${.:/params[5]/name}. This partition identifier is used to access the partition with other partition related directives. - The **attribute set** specified in ``${.:/params[4]/name}`` is built through + The **attribute set** specified in ${.:/params[4]/name} is built through a *bitwise or* of the attribute constants described below. Attributes not mentioned below are not evaluated by this directive and have no effect. @@ -54,7 +54,7 @@ notes: | This directive may cause the calling task to be preempted due to an obtain and release of the object allocator mutex. - The partition buffer area specified by the ``${.:/params[1]/name}`` must be + The partition buffer area specified by the ${.:/params[1]/name} must be properly aligned. It must be possible to directly store target architecture pointers and also the user data. For example, if the user data contains some long double or vector data types, the partition buffer area and the buffer @@ -63,9 +63,9 @@ notes: | factor. Use ${alignment:/name} to specify the minimum alignment of a partition buffer type. - The ``${.:/params[3]/name}`` parameter must be an integral multiple of the + The ${.:/params[3]/name} parameter must be an integral multiple of the pointer size on the target architecture. Additionally, - ``${.:/params[3]/name}`` must be large enough to hold two pointers on the + ${.:/params[3]/name} must be large enough to hold two pointers on the target architecture. This is required for RTEMS to manage the buffers when they are free. @@ -115,28 +115,28 @@ return: The partition name was invalid. value: ${../../status/if/invalid-name:/name} - description: | - The ``${.:/params[5]/name}`` parameter was ${/c/if/null:/name}. + The ${.:/params[5]/name} parameter was ${/c/if/null:/name}. value: ${../../status/if/invalid-address:/name} - description: | - The ``${.:/params[2]/name}`` parameter was 0. + The ${.:/params[2]/name} parameter was 0. value: ${../../status/if/invalid-size:/name} - description: | - The ``${.:/params[3]/name}`` parameter was 0. + The ${.:/params[3]/name} parameter was 0. value: ${../../status/if/invalid-size:/name} - description: | - The ``${.:/params[2]/name}`` parameter was less than the - ``${.:/params[3]/name}`` parameter. + The ${.:/params[2]/name} parameter was less than the + ${.:/params[3]/name} parameter. value: ${../../status/if/invalid-size:/name} - description: | - The ``${.:/params[3]/name}`` parameter was not an integral multiple of + The ${.:/params[3]/name} parameter was not an integral multiple of the pointer size. value: ${../../status/if/invalid-size:/name} - description: | - The ``${.:/params[3]/name}`` parameter was less than two times the + The ${.:/params[3]/name} parameter was less than two times the pointer size. value: ${../../status/if/invalid-size:/name} - description: | - The ``${.:/params[1]/name}`` parameter was not on a pointer size + The ${.:/params[1]/name} parameter was not on a pointer size boundary. value: ${../../status/if/invalid-address:/name} - description: | diff --git a/spec/rtems/part/if/get-buffer.yml b/spec/rtems/part/if/get-buffer.yml index b1ac58d3..adced27f 100644 --- a/spec/rtems/part/if/get-buffer.yml +++ b/spec/rtems/part/if/get-buffer.yml @@ -15,8 +15,8 @@ definition: variants: [] description: | This directive allows a buffer to be obtained from the partition specified in - the ``${.:/params[0]/name}`` parameter. The address of the allocated buffer is - returned through the ``${.:/params[1]/name}`` parameter. + the ${.:/params[0]/name} parameter. The address of the allocated buffer is + returned through the ${.:/params[1]/name} parameter. enabled-by: true index-entries: - get buffer from partition @@ -58,7 +58,7 @@ return: There was no partition with the specified identifier. value: ${../../status/if/invalid-id:/name} - description: | - The ``${.:/params[1]/name}`` parameter was ${/c/if/null:/name}. + The ${.:/params[1]/name} parameter was ${/c/if/null:/name}. value: ${../../status/if/invalid-address:/name} - description: | There was no free buffer available to allocate and return. diff --git a/spec/rtems/part/if/ident.yml b/spec/rtems/part/if/ident.yml index 6cb81349..9ac8d174 100644 --- a/spec/rtems/part/if/ident.yml +++ b/spec/rtems/part/if/ident.yml @@ -16,9 +16,9 @@ definition: variants: [] description: | This directive obtains a partition identifier associated with the partition - name specified in ``${.:/params[0]/name}``. + name specified in ${.:/params[0]/name}. - The node to search is specified in ``${.:/params[1]/name}``. It shall be + The node to search is specified in ${.:/params[1]/name}. It shall be * a valid node number, diff --git a/spec/rtems/part/if/return-buffer.yml b/spec/rtems/part/if/return-buffer.yml index 08f1f5db..7f312031 100644 --- a/spec/rtems/part/if/return-buffer.yml +++ b/spec/rtems/part/if/return-buffer.yml @@ -14,8 +14,8 @@ definition: return: ${../../status/if/code:/name} variants: [] description: | - This directive returns the buffer specified by ``${.:/params[1]/name}`` to the - partition specified by ``${.:/params[0]/name}``. + This directive returns the buffer specified by ${.:/params[1]/name} to the + partition specified by ${.:/params[0]/name}. enabled-by: true index-entries: - return buffer to partition @@ -52,7 +52,7 @@ return: There was no partition with the specified identifier. value: ${../../status/if/invalid-id:/name} - description: | - The buffer referenced by ``${.:/params[1]/name}`` was not in the + The buffer referenced by ${.:/params[1]/name} was not in the partition. value: ${../../status/if/invalid-address:/name} type: interface diff --git a/spec/rtems/ratemon/if/ident.yml b/spec/rtems/ratemon/if/ident.yml index 0e04634c..5350f1bf 100644 --- a/spec/rtems/ratemon/if/ident.yml +++ b/spec/rtems/ratemon/if/ident.yml @@ -15,7 +15,7 @@ definition: variants: [] description: | This directive obtains the period identifier associated with the period name - specified in ``${.:/params[0]/name}``. + specified in ${.:/params[0]/name}. enabled-by: true index-entries: [] interface-type: function diff --git a/spec/rtems/region/if/ident.yml b/spec/rtems/region/if/ident.yml index 612f200f..f67af7d2 100644 --- a/spec/rtems/region/if/ident.yml +++ b/spec/rtems/region/if/ident.yml @@ -15,7 +15,7 @@ definition: variants: [] description: | This directive obtains the region identifier associated with the region name - specified in ``${.:/params[0]/name}``. + specified in ${.:/params[0]/name}. enabled-by: true index-entries: [] interface-type: function diff --git a/spec/rtems/sem/if/ident.yml b/spec/rtems/sem/if/ident.yml index 16188bbb..30466cae 100644 --- a/spec/rtems/sem/if/ident.yml +++ b/spec/rtems/sem/if/ident.yml @@ -16,9 +16,9 @@ definition: variants: [] description: | This directive obtains the semaphore identifier associated with the semaphore - name specified in ``${.:/params[0]/name}``. + name specified in ${.:/params[0]/name}. - The node to search is specified in ``${.:/params[1]/name}``. It shall be + The node to search is specified in ${.:/params[1]/name}. It shall be * a valid node number, diff --git a/spec/rtems/task/if/ident.yml b/spec/rtems/task/if/ident.yml index 905e2f23..12523dbc 100644 --- a/spec/rtems/task/if/ident.yml +++ b/spec/rtems/task/if/ident.yml @@ -16,12 +16,12 @@ definition: variants: [] description: | This directive obtains the task identifier associated with the task name - specified in ``${.:/params[0]/name}``. + specified in ${.:/params[0]/name}. A task may obtain its own identifier by specifying ${self-define:/name} for the name. - The node to search is specified in ``${.:/params[1]/name}``. It shall be + The node to search is specified in ${.:/params[1]/name}. It shall be * a valid node number, diff --git a/spec/rtems/timer/if/ident.yml b/spec/rtems/timer/if/ident.yml index 28d670bb..c119ab6c 100644 --- a/spec/rtems/timer/if/ident.yml +++ b/spec/rtems/timer/if/ident.yml @@ -15,7 +15,7 @@ definition: variants: [] description: | This directive obtains the timer identifier associated with the timer name - specified in ``${.:/params[0]/name}``. + specified in ${.:/params[0]/name}. enabled-by: true index-entries: [] interface-type: function diff --git a/spec/rtems/userext/if/ident.yml b/spec/rtems/userext/if/ident.yml index 0c8504fc..731dfbfd 100644 --- a/spec/rtems/userext/if/ident.yml +++ b/spec/rtems/userext/if/ident.yml @@ -15,7 +15,7 @@ definition: variants: [] description: | This directive obtains the extension set identifier associated with the - extension set name specified in ``${.:/params[0]/name}``. + extension set name specified in ${.:/params[0]/name}. enabled-by: true index-entries: [] interface-type: function -- cgit v1.2.3