Skip to content

Commit 647fe7a

Browse files
mbolivar-nordicjhedberg
authored andcommitted
doc: dts/macros.rst: "clocks" macro fixes
The "fixed-clock" value referenced in the documentation is actually a compatible value, not a property name. Fix that. Harden the "expected to have a clock-frequency property" language to use "must" instead of "expected". The scripts error out if a node with fixed-clock compatible is missing a clock-frequency property; it's not a soft expectation. Be explicit about clock-frequency units. Signed-off-by: Martí Bolívar <[email protected]>
1 parent f972fb0 commit 647fe7a

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/guides/dts/macros.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -587,9 +587,9 @@ example ``DT_<node>_CLOCK_CONTROLLER_0`` instead of
587587

588588
This inconsistency might be fixed in the future.
589589

590-
In addition, if the clock controller node has a ``fixed-clock`` property, it is
591-
expected to also have a ``clock-frequency`` property giving the frequency, and
592-
an additional macro is generated:
590+
If a ``clocks`` controller node has a ``"fixed-clock"`` compatible, it
591+
must also have a ``clock-frequency`` property giving its frequency in Hertz.
592+
In this case, an additional macro is generated:
593593

594594
.. code-block:: none
595595

0 commit comments

Comments
 (0)