Skip to content

Commit c8148ae

Browse files
committed
Clarify the usage of "board_build.f_cpu" option
Resolve #230
1 parent 3567dbd commit c8148ae

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

projectconf/section_env_platform.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,8 +157,12 @@ format of this option is ``C-like long integer`` value with ``L`` suffix. The
157157
1 Hertz is equal to ``1L``, then 16 MHz (Mega Hertz) is equal to ``16000000L``.
158158

159159
The full list of ``board_build.f_cpu`` for the popular embedded platforms you can
160-
find in *Boards* section of :ref:`platforms`. See "Frequency" column. You can
161-
overclock a board by specifying a ``board_build.f_cpu`` value other than the default.
160+
find in *Boards* section of :ref:`platforms`. See "Frequency" column.
161+
162+
.. note::
163+
This option doesn't make any changes to real clock settings on hardware. You should
164+
specify a ``board_build.f_cpu`` value if you have changed a target's clock frequency
165+
so that the underlying software will be configured accordingly to match the change.
162166

163167
.. _projectconf_board_build.ldscript:
164168

0 commit comments

Comments
 (0)