sys/ztimer: mention ztimer_auto_adjust in relevant places #21003
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mguetschow
requested review from
leandrolanzieri,
aabadie,
MichelRottleuthner and
jia200x
as code owners
github-actions
bot
added
Area: doc
mguetschow
force-pushed
the
ztimer-overhead-adjust
branch
from
780fd72
to
34b0ae6
Compare
mguetschow
added
CI: ready for build
mguetschow
force-pushed
the
ztimer-overhead-adjust
branch
from
34b0ae6
to
a2ef45f
Compare
maribu
approved these changes
Nov 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contribution description
Since #17633, there is an alternative to configuring the ztimer overhead compensation in the board.h file. Mention this in the relevant places in the documentation and the test application.
While we are at it, also fixing a typo in the test application.
Testing procedure
Check generated doc and changes to README.
Issues/PRs references
Stumbled upon this while going through https://doc.riot-os.org/porting-boards.html#board-timer-configurations for #20980. Interesting enough that this configuration values are currently only set for a handful of boards 👀