Changeset 0500b9a in rtems-central


Ignore:
Timestamp:
Dec 1, 2020, 1:23:41 PM (12 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
master
Children:
dc19046
Parents:
e165b7d
git-author:
Sebastian Huber <sebastian.huber@…> (12/01/20 13:23:41)
git-committer:
Sebastian Huber <sebastian.huber@…> (12/01/20 13:37:31)
Message:

interface/interfacedoc: Format parameter names

Files:
27 edited

Legend:

Unmodified
Added
Removed
  • rtemsspec/interface.py

    re165b7d r0500b9a  
    6060
    6161
     62def _get_value_params(ctx: ItemGetValueContext) -> Any:
     63    return f"``{ctx.value[ctx.key]}``"
     64
     65
    6266class _InterfaceMapper(ItemMapper):
    6367    def __init__(self, node: "Node"):
     
    7175        self.add_get_value("interface/function/doc:/name",
    7276                           get_value_doxygen_function)
     77        self.add_get_value("interface/function/doc:/params/name",
     78                           _get_value_params)
    7379        self.add_get_value("interface/enumerator/doc:/name",
    7480                           get_value_double_colon)
     
    7985        self.add_get_value("interface/macro/doc:/name",
    8086                           get_value_doxygen_function)
     87        self.add_get_value("interface/macro/doc:/params/name",
     88                           _get_value_params)
    8189        self.add_get_value("interface/variable/doc:/name", get_value_hash)
    8290        for opt in ["feature-enable", "feature", "initializer", "integer"]:
  • rtemsspec/interfacedoc.py

    re165b7d r0500b9a  
    6565
    6666
     67def _get_param(ctx: ItemGetValueContext) -> Any:
     68    return f"``{ctx.value[ctx.key].lstrip('_')}``"
     69
     70
    6771class _Mapper(SphinxMapper):
    6872    def __init__(self, item: Item):
     
    7074        self.add_get_value("interface/function:/name", _get_value_function)
    7175        self.add_get_value("interface/macro:/name", _get_value_function)
     76        self.add_get_value("interface/function:/params/name", _get_param)
     77        self.add_get_value("interface/macro:/params/name", _get_param)
    7278
    7379
  • rtemsspec/tests/spec-interface/func.yml

    re165b7d r0500b9a  
    1818  ${enum:/name}, ${define:/name}, ${macro:/name}, ${var:/name},
    1919  ${enumerator-0:/name}, ${s:/name}, ${option:/name}, and ${option:/type}.
     20  Second parameter is ${.:/params[1]/name}.
    2021enabled-by: true
    2122index-entries: []
  • rtemsspec/tests/test_interface.py

    re165b7d r0500b9a  
    206206 * Function description.  References to VeryLongFunction(), ::Integer, #Enum,
    207207 * #DEFINE, VERY_LONG_MACRO(), #Variable, ::ENUMERATOR_0, Struct, #a, and
    208  * interface.
     208 * interface. Second parameter is ``Param1``.
    209209 *
    210210 * @param Param0 is parameter 0.
  • rtemsspec/tests/test_interfacedoc.py

    re165b7d r0500b9a  
    445445:c:type:`Integer`, :c:type:`Enum`, :c:macro:`DEFINE`,
    446446:ref:`InterfaceVERYLONGMACRO`, Variable, :c:macro:`ENUMERATOR_0`,
    447 :c:type:`Struct`, :ref:`a`, and interface.
     447:c:type:`Struct`, :ref:`a`, and interface. Second parameter is ``Param1``.
    448448"""
    449449        assert content == src.read()
  • spec/rtems/barrier/if/ident.yml

    re165b7d r0500b9a  
    1616description: |
    1717  This directive obtains the barrier identifier associated with the barrier
    18   name specified in ``${.:/params[0]/name}``.
     18  name specified in ${.:/params[0]/name}.
    1919enabled-by: true
    2020index-entries: []
  • spec/rtems/dpmem/if/ident.yml

    re165b7d r0500b9a  
    1616description: |
    1717  This directive obtains the port identifier associated with the port name
    18   specified in ``${.:/params[0]/name}``.
     18  specified in ${.:/params[0]/name}.
    1919enabled-by: true
    2020index-entries: []
  • spec/rtems/event/if/receive.yml

    re165b7d r0500b9a  
    2424
    2525  To **get the pending events** use the constant ${pending-events:/name} for
    26   the ``${.:/params[0]/name}`` parameter.  The pending events are returned to
     26  the ${.:/params[0]/name} parameter.  The pending events are returned to
    2727  the calling task but the event set of the task is left unaltered.  The
    28   ``${.:/params[1]/name}`` and ``${.:params[2]/name}`` parameters are ignored
     28  ${.:/params[1]/name} and ${.:/params[2]/name} parameters are ignored
    2929  in this case.  The directive returns immediately and does not block.
    3030
    3131  To **receive events** you have to define an input event condition and some
    32   options.  The **option set** specified in ``${.:/params[1]/name}`` defines
     32  options.  The **option set** specified in ${.:/params[1]/name} defines
    3333
    3434  * if the task will wait or poll for the events, and
     
    4242
    4343  * **Waiting** for events is the default and can be emphasized through the use
    44     of the ${../../option/if/wait:/name} option.  The ``${.:/params[2]/name}``
     44    of the ${../../option/if/wait:/name} option.  The ${.:/params[2]/name}
    4545    parameter defines how long the task is willing to wait.  Use
    4646    ${../../type/if/no-timeout:/name} to wait potentially forever, otherwise
     
    4949  * Not waiting for events (**polling**) is selected by the
    5050    ${../../option/if/no-wait:/name} option.  If this option is defined, then
    51     the ``${.:/params[2]/name}`` parameter is ignored.
     51    the ${.:/params[2]/name} parameter is ignored.
    5252
    5353  The task can receive **all** or **any** of the input events specified in
    54   ``${.:/params[0]/name}``.
     54  ${.:/params[0]/name}.
    5555
    5656  * Receiving **all** input events is the default and can be emphasized through
     
    7272  interrupt context is undefined behaviour.
    7373
    74   This directive only affects the events specified in ``${.:/params[0]/name}``.
     74  This directive only affects the events specified in ${.:/params[0]/name}.
    7575  Any pending events that do not correspond to any of the events specified in
    76   ``${.:/params[0]/name}`` will be left pending.
     76  ${.:/params[0]/name} will be left pending.
    7777
    7878  To receive all events use the event set constant ${all-events:/name} for the
    79   ``${.:/params[0]/name}`` parameter.  Do not confuse this event set constant
     79  ${.:/params[0]/name} parameter.  Do not confuse this event set constant
    8080  with the directive option ${../../option/if/event-all:/name}.
    8181
    8282  A task can **receive all of the pending events** by calling the directive
    83   with a value of ${all-events:/name} for the ``${.:/params[0]/name}``
     83  with a value of ${all-events:/name} for the ${.:/params[0]/name}
    8484  parameter and the bitwise or of the ${../../option/if/no-wait:/name} and
    85   ${../../option/if/event-any:/name} options for the ``${.:/params[1]/name}``
     85  ${../../option/if/event-any:/name} options for the ${.:/params[1]/name}
    8686  parameter.  The pending events are returned and the event set of the task is
    8787  cleared.  If no events are pending then the
     
    114114    value: ${../../status/if/successful:/name}
    115115  - description: |
    116       The ``${.:/params[3]/name}`` parameter was ${/c/if/null:/name}.
     116      The ${.:/params[3]/name} parameter was ${/c/if/null:/name}.
    117117    value: ${../../status/if/invalid-address:/name}
    118118  - description: |
  • spec/rtems/event/if/send.yml

    re165b7d r0500b9a  
    1515  variants: []
    1616description: |
    17   This directive sends the event set, ``${.:/params[1]/name}``, to the target
    18   task identified by ``${.:/params[0]/name}``.  Based upon the state of the
     17  This directive sends the event set, ${.:/params[1]/name}, to the target
     18  task identified by ${.:/params[0]/name}.  Based upon the state of the
    1919  target task, one of the following situations applies:
    2020
     
    4141  Events can be sent by tasks or an ${/glossary/isr:/term}.
    4242
    43   Specifying ${../../task/if/self-define:/name} for ``${.:/params[0]/name}`` results
     43  Specifying ${../../task/if/self-define:/name} for ${.:/params[0]/name} results
    4444  in the event set being sent to the calling task.
    4545
  • spec/rtems/message/if/ident.yml

    re165b7d r0500b9a  
    1717description: |
    1818  This directive obtains the message queue identifier associated with the
    19   message queue name specified in ``${.:/params[0]/name}``.
     19  message queue name specified in ${.:/params[0]/name}.
    2020
    21   The node to search is specified in ``${.:/params[1]/name}``.  It shall be
     21  The node to search is specified in ${.:/params[1]/name}.  It shall be
    2222
    2323  * a valid node number,
  • spec/rtems/object/if/build-name.yml

    re165b7d r0500b9a  
    1111description: |
    1212  This directive takes the four characters provided as arguments and composes a
    13   32-bit object name with ``${.:params[0]/name}`` in the most significant
    14   8-bits and ``${.:params[3]/name}`` in the least significant 8-bits.
     13  32-bit object name with ${.:/params[0]/name} in the most significant
     14  8-bits and ${.:/params[3]/name} in the least significant 8-bits.
    1515enabled-by: true
    1616index-entries: []
  • spec/rtems/object/if/get-name.yml

    re165b7d r0500b9a  
    4949return:
    5050  return: |
    51     Returns the ``${.:/params[2]/name}`` parameter value, if there is an object
     51    Returns the ${.:/params[2]/name} parameter value, if there is an object
    5252    name associated with the object identifier.
    5353  return-values:
  • spec/rtems/object/if/id-get-api.yml

    re165b7d r0500b9a  
    2222
    2323  This directive does not validate the object identifier provided in
    24   ``${.:/params[0]/name}``.
     24  ${.:/params[0]/name}.
    2525
    2626  A body is also provided.
  • spec/rtems/object/if/id-get-class.yml

    re165b7d r0500b9a  
    2222
    2323  This directive does not validate the object identifier provided in
    24   ``${.:/params[0]/name}``.
     24  ${.:/params[0]/name}.
    2525
    2626  A body is also provided.
  • spec/rtems/object/if/id-get-index.yml

    re165b7d r0500b9a  
    2222
    2323  This directive does not validate the object identifier provided in
    24   ``${.:/params[0]/name}``.
     24  ${.:/params[0]/name}.
    2525
    2626  A body is also provided.
  • spec/rtems/object/if/id-get-node.yml

    re165b7d r0500b9a  
    2222
    2323  This directive does not validate the object identifier provided in
    24   ``${.:/params[0]/name}``.
     24  ${.:/params[0]/name}.
    2525
    2626  A body is also provided.
  • spec/rtems/object/if/set-name.yml

    re165b7d r0500b9a  
    3232  naming scheme per their API.
    3333
    34   If the object specified by ``${.:/params[0]/name}`` is of a class that has a
     34  If the object specified by ${.:/params[0]/name} is of a class that has a
    3535  string name, this directive will free the existing name to the RTEMS Workspace
    3636  and allocate enough memory from the RTEMS Workspace to make a copy of the
    37   string located at ``${.:/params[1]/name}``.
     37  string located at ${.:/params[1]/name}.
    3838
    39   If the object specified by ``${.:/params[0]/name}`` is of a class that has a
     39  If the object specified by ${.:/params[0]/name} is of a class that has a
    4040  32-bit integer style name, then the first four characters in
    41   ``${.:/params[1]/name}`` will be used to construct the name.
     41  ${.:/params[1]/name} will be used to construct the name.
    4242params:
    4343- description: |
  • spec/rtems/part/if/create.yml

    re165b7d r0500b9a  
    2020description: |
    2121  This directive creates a partition of fixed size buffers from a physically
    22   contiguous memory space which starts at ``${.:/params[1]/name}`` and is
    23   ``${.:/params[2]/name}`` bytes in size.  Each allocated buffer is to be of
    24   ``${.:/params[3]/name}`` in bytes.  The assigned partition identifier is
    25   returned in ``${.:/params[5]/name}``.  This partition identifier is used to
     22  contiguous memory space which starts at ${.:/params[1]/name} and is
     23  ${.:/params[2]/name} bytes in size.  Each allocated buffer is to be of
     24  ${.:/params[3]/name} in bytes.  The assigned partition identifier is
     25  returned in ${.:/params[5]/name}.  This partition identifier is used to
    2626  access the partition with other partition related directives.
    2727
    28   The **attribute set** specified in ``${.:/params[4]/name}`` is built through
     28  The **attribute set** specified in ${.:/params[4]/name} is built through
    2929  a *bitwise or* of the attribute constants described below.  Attributes not
    3030  mentioned below are not evaluated by this directive and have no effect.
     
    5555  and release of the object allocator mutex.
    5656
    57   The partition buffer area specified by the ``${.:/params[1]/name}`` must be
     57  The partition buffer area specified by the ${.:/params[1]/name} must be
    5858  properly aligned.  It must be possible to directly store target architecture
    5959  pointers and also the user data.  For example, if the user data contains some
     
    6464  partition buffer type.
    6565
    66   The ``${.:/params[3]/name}`` parameter must be an integral multiple of the
     66  The ${.:/params[3]/name} parameter must be an integral multiple of the
    6767  pointer size on the target architecture.  Additionally,
    68   ``${.:/params[3]/name}`` must be large enough to hold two pointers on the
     68  ${.:/params[3]/name} must be large enough to hold two pointers on the
    6969  target architecture.  This is required for RTEMS to manage the buffers when
    7070  they are free.
     
    116116    value: ${../../status/if/invalid-name:/name}
    117117  - description: |
    118       The ``${.:/params[5]/name}`` parameter was ${/c/if/null:/name}.
     118      The ${.:/params[5]/name} parameter was ${/c/if/null:/name}.
    119119    value: ${../../status/if/invalid-address:/name}
    120120  - description: |
    121       The ``${.:/params[2]/name}`` parameter was 0.
     121      The ${.:/params[2]/name} parameter was 0.
    122122    value: ${../../status/if/invalid-size:/name}
    123123  - description: |
    124       The ``${.:/params[3]/name}`` parameter was 0.
     124      The ${.:/params[3]/name} parameter was 0.
    125125    value: ${../../status/if/invalid-size:/name}
    126126  - description: |
    127       The ``${.:/params[2]/name}`` parameter was less than the
    128       ``${.:/params[3]/name}`` parameter.
     127      The ${.:/params[2]/name} parameter was less than the
     128      ${.:/params[3]/name} parameter.
    129129    value: ${../../status/if/invalid-size:/name}
    130130  - description: |
    131       The ``${.:/params[3]/name}`` parameter was not an integral multiple of
     131      The ${.:/params[3]/name} parameter was not an integral multiple of
    132132      the pointer size.
    133133    value: ${../../status/if/invalid-size:/name}
    134134  - description: |
    135       The ``${.:/params[3]/name}`` parameter was less than two times the
     135      The ${.:/params[3]/name} parameter was less than two times the
    136136      pointer size.
    137137    value: ${../../status/if/invalid-size:/name}
    138138  - description: |
    139       The ``${.:/params[1]/name}`` parameter was not on a pointer size
     139      The ${.:/params[1]/name} parameter was not on a pointer size
    140140      boundary.
    141141    value: ${../../status/if/invalid-address:/name}
  • spec/rtems/part/if/get-buffer.yml

    re165b7d r0500b9a  
    1616description: |
    1717  This directive allows a buffer to be obtained from the partition specified in
    18   the ``${.:/params[0]/name}`` parameter.  The address of the allocated buffer is
    19   returned through the ``${.:/params[1]/name}`` parameter.
     18  the ${.:/params[0]/name} parameter.  The address of the allocated buffer is
     19  returned through the ${.:/params[1]/name} parameter.
    2020enabled-by: true
    2121index-entries:
     
    5959    value: ${../../status/if/invalid-id:/name}
    6060  - description: |
    61       The ``${.:/params[1]/name}`` parameter was ${/c/if/null:/name}.
     61      The ${.:/params[1]/name} parameter was ${/c/if/null:/name}.
    6262    value: ${../../status/if/invalid-address:/name}
    6363  - description: |
  • spec/rtems/part/if/ident.yml

    re165b7d r0500b9a  
    1717description: |
    1818  This directive obtains a partition identifier associated with the partition
    19   name specified in ``${.:/params[0]/name}``.
     19  name specified in ${.:/params[0]/name}.
    2020
    21   The node to search is specified in ``${.:/params[1]/name}``.  It shall be
     21  The node to search is specified in ${.:/params[1]/name}.  It shall be
    2222
    2323  * a valid node number,
  • spec/rtems/part/if/return-buffer.yml

    re165b7d r0500b9a  
    1515  variants: []
    1616description: |
    17   This directive returns the buffer specified by ``${.:/params[1]/name}`` to the
    18   partition specified by ``${.:/params[0]/name}``.
     17  This directive returns the buffer specified by ${.:/params[1]/name} to the
     18  partition specified by ${.:/params[0]/name}.
    1919enabled-by: true
    2020index-entries:
     
    5353    value: ${../../status/if/invalid-id:/name}
    5454  - description: |
    55       The buffer referenced by ``${.:/params[1]/name}`` was not in the
     55      The buffer referenced by ${.:/params[1]/name} was not in the
    5656      partition.
    5757    value: ${../../status/if/invalid-address:/name}
  • spec/rtems/ratemon/if/ident.yml

    re165b7d r0500b9a  
    1616description: |
    1717  This directive obtains the period identifier associated with the period name
    18   specified in ``${.:/params[0]/name}``.
     18  specified in ${.:/params[0]/name}.
    1919enabled-by: true
    2020index-entries: []
  • spec/rtems/region/if/ident.yml

    re165b7d r0500b9a  
    1616description: |
    1717  This directive obtains the region identifier associated with the region name
    18   specified in ``${.:/params[0]/name}``.
     18  specified in ${.:/params[0]/name}.
    1919enabled-by: true
    2020index-entries: []
  • spec/rtems/sem/if/ident.yml

    re165b7d r0500b9a  
    1717description: |
    1818  This directive obtains the semaphore identifier associated with the semaphore
    19   name specified in ``${.:/params[0]/name}``.
     19  name specified in ${.:/params[0]/name}.
    2020
    21   The node to search is specified in ``${.:/params[1]/name}``.  It shall be
     21  The node to search is specified in ${.:/params[1]/name}.  It shall be
    2222
    2323  * a valid node number,
  • spec/rtems/task/if/ident.yml

    re165b7d r0500b9a  
    1717description: |
    1818  This directive obtains the task identifier associated with the task name
    19   specified in ``${.:/params[0]/name}``.
     19  specified in ${.:/params[0]/name}.
    2020
    2121  A task may obtain its own identifier by specifying ${self-define:/name} for
    2222  the name.
    2323
    24   The node to search is specified in ``${.:/params[1]/name}``.  It shall be
     24  The node to search is specified in ${.:/params[1]/name}.  It shall be
    2525
    2626  * a valid node number,
  • spec/rtems/timer/if/ident.yml

    re165b7d r0500b9a  
    1616description: |
    1717  This directive obtains the timer identifier associated with the timer name
    18   specified in ``${.:/params[0]/name}``.
     18  specified in ${.:/params[0]/name}.
    1919enabled-by: true
    2020index-entries: []
  • spec/rtems/userext/if/ident.yml

    re165b7d r0500b9a  
    1616description: |
    1717  This directive obtains the extension set identifier associated with the
    18   extension set name specified in ``${.:/params[0]/name}``.
     18  extension set name specified in ${.:/params[0]/name}.
    1919enabled-by: true
    2020index-entries: []
Note: See TracChangeset for help on using the changeset viewer.