Skip to content

Commit e569dfe

Browse files
rruuaanngnashif
authored andcommitted
doc: build: dts: Fix incorrect rst tag
Replaced incorrect ':c:func:' tag for devicetree macro with ':c:macro' tag. Signed-off-by: James Roy <[email protected]>
1 parent 0852af2 commit e569dfe

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

doc/build/dts/api/api.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ devicetree data in C rvalue form using, for example, the
3333
:ref:`devicetree-property-access` API.
3434

3535
The root node ``/`` has node identifier ``DT_ROOT``. You can create node
36-
identifiers for other devicetree nodes using :c:func:`DT_PATH`,
37-
:c:func:`DT_NODELABEL`, :c:func:`DT_ALIAS`, and :c:func:`DT_INST`.
36+
identifiers for other devicetree nodes using :c:macro:`DT_PATH`,
37+
:c:macro:`DT_NODELABEL`, :c:macro:`DT_ALIAS`, and :c:macro:`DT_INST`.
3838

39-
There are also :c:func:`DT_PARENT` and :c:func:`DT_CHILD` macros which can be
39+
There are also :c:macro:`DT_PARENT` and :c:macro:`DT_CHILD` macros which can be
4040
used to create node identifiers for a given node's parent node or a particular
4141
child node, respectively.
4242

@@ -105,11 +105,11 @@ For-each macros
105105
===============
106106

107107
There is currently only one "generic" for-each macro,
108-
:c:func:`DT_FOREACH_CHILD`, which allows iterating over the children of a
108+
:c:macro:`DT_FOREACH_CHILD`, which allows iterating over the children of a
109109
devicetree node.
110110

111111
There are special-purpose for-each macros, like
112-
:c:func:`DT_INST_FOREACH_STATUS_OKAY`, but these require ``DT_DRV_COMPAT`` to
112+
:c:macro:`DT_INST_FOREACH_STATUS_OKAY`, but these require ``DT_DRV_COMPAT`` to
113113
be defined before use.
114114

115115
.. doxygengroup:: devicetree-generic-foreach
@@ -120,7 +120,7 @@ Existence checks
120120
This section documents miscellaneous macros that can be used to test if a node
121121
exists, how many nodes of a certain type exist, whether a node has certain
122122
properties, etc. Some macros used for special purposes (such as
123-
:c:func:`DT_IRQ_HAS_IDX` and all macros which require ``DT_DRV_COMPAT``) are
123+
:c:macro:`DT_IRQ_HAS_IDX` and all macros which require ``DT_DRV_COMPAT``) are
124124
documented elsewhere on this page.
125125

126126
.. doxygengroup:: devicetree-generic-exist
@@ -159,7 +159,7 @@ chosen is an implementation detail, but cyclic dependencies are detected and
159159
cause errors, so it's safe to assume there are none when using these macros.
160160

161161
There are instance number-based conveniences as well; see
162-
:c:func:`DT_INST_DEP_ORD` and subsequent documentation.
162+
:c:macro:`DT_INST_DEP_ORD` and subsequent documentation.
163163

164164
.. doxygengroup:: devicetree-dep-ord
165165

@@ -201,7 +201,7 @@ with compatible ``vnd,serial``:
201201
202202
.. warning::
203203

204-
Be careful making assumptions about instance numbers. See :c:func:`DT_INST`
204+
Be careful making assumptions about instance numbers. See :c:macro:`DT_INST`
205205
for the API guarantees.
206206

207207
As shown above, the ``DT_INST_*`` APIs are conveniences for addressing nodes by
@@ -210,8 +210,8 @@ instance number. They are almost all defined in terms of one of the
210210
removing ``INST_`` from the macro name. For example, ``DT_INST_PROP(inst,
211211
prop)`` is equivalent to ``DT_PROP(DT_DRV_INST(inst), prop)``. Similarly,
212212
``DT_INST_REG_ADDR(inst)`` is equivalent to ``DT_REG_ADDR(DT_DRV_INST(inst))``,
213-
and so on. There are some exceptions: :c:func:`DT_ANY_INST_ON_BUS_STATUS_OKAY`
214-
and :c:func:`DT_INST_FOREACH_STATUS_OKAY` are special-purpose helpers without
213+
and so on. There are some exceptions: :c:macro:`DT_ANY_INST_ON_BUS_STATUS_OKAY`
214+
and :c:macro:`DT_INST_FOREACH_STATUS_OKAY` are special-purpose helpers without
215215
straightforward generic equivalents.
216216

217217
Since ``DT_DRV_INST()`` requires ``DT_DRV_COMPAT`` to be defined, it's an error
@@ -355,7 +355,7 @@ Chosen nodes
355355
************
356356

357357
The special ``/chosen`` node contains properties whose values describe
358-
system-wide settings. The :c:func:`DT_CHOSEN()` macro can be used to get a node
358+
system-wide settings. The :c:macro:`DT_CHOSEN()` macro can be used to get a node
359359
identifier for a chosen node.
360360

361361
.. doxygengroup:: devicetree-generic-chosen

0 commit comments

Comments
 (0)