search

platformio / platformio-docs

PlatformIO Documentation
https://docs.platformio.org
Apache License 2.0
240 stars 325 forks source link

Documentation bug - board_build.f_cpu #230

Closed NormanDunbar closed 2 years ago

NormanDunbar commented 2 years ago

In the docs for board_build.f_cpu at Platform options — PlatformIO latest documentation the wording gives the impression that this will “overclock” the CPU:

You can overclock a board by specifying a board_build.f_cpu value other than the default.

I would suggest changing this wording as that setting should only be used when the board has a different clock frequency to the default. Perhaps to:

If you have changed a board’s clock frequency, then you should specify a board_build.f_cpu value to match the change.

your Leonardo board’s details are at Arduino Leonardo — PlatformIO latest documentation, where again, it does rather give the impression that the ini file setting will overclock the board!

There's a discussion on the Community Forums at https://community.platformio.org/t/documentation-bug/25595 should you be interested in other opinions.

Cheers, Norm.

valeros commented 2 years ago

Hi @NormanDunbar ! Thanks for bringing it up. I've reformatted the description for that option, so hopefully, it's clearer now. The updated version will be available once the main PlatformIO repository synchronizes its docs submodule.

NormanDunbar commented 2 years ago

Hi @valeros,

thank you very much.

Regards, Norman.