michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: build: dts: Fix incorrect foreach documentation

Browse source 
Replaced incorrect rst link references in the description
of traversing ancestor nodes, along with some conflicting
descriptions.

Signed-off-by: James Roy <rruuaanng@outlook.com>
This commit is contained in:
James Roy 2024-12-30 16:14:14 +08:00 • committed by Benjamin Cabé
commit 19963594b0
1 changed files with 3 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/build/dts/api/api.rst vendored
View file

@ -104,12 +104,10 @@ does not apply to macros which take cell names as arguments.
For-each macros
===============
The :c:macro:`DT_FOREACH_CHILD` macro allows iterating over the ancestor node
The :c:macro:`DT_FOREACH_ANCESTOR` macro allows iterating over the ancestor node
of a devicetree node.
There is currently only one "generic" for-each macro,
:c:macro:`DT_FOREACH_CHILD`, which allows iterating over the children of a
devicetree node.
Additionally, the :c:macro:`DT_FOREACH_CHILD` macro allows iterating over the
children of a devicetree node.
There are special-purpose for-each macros, like
:c:macro:`DT_INST_FOREACH_STATUS_OKAY`, but these require ``DT_DRV_COMPAT`` to