Improved documentation of relative timeouts in timer ISR context #59833
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
fgrandel
requested review from
andyross,
nashif,
dcpleung,
carlescufi,
galak and
MaureenHelm
as code owners
fgrandel
force-pushed
the
doc/sys-clock-timeouts
branch
from
b30f009
to
cddb5a6
Compare
andyross
previously approved these changes
Jun 29, 2023
There was a problem hiding this comment.
This is all correct, and I'm fine with it. FWIW: the reason this wasn't rigorously documented is that there was some argument about the right way to do it and that applications shouldn't rely on the behavior (vs. providing their own kludgier aliasing protection). But it's been long enough now that I think this scheme has won.
kartben
previously approved these changes
Jun 29, 2023
carlocaione
reviewed
Jun 29, 2023
Scheduling relative timeouts from within timer callbacks (=sys clock ISR context) differs from scheduling relative timeouts from an application context. This change documents and explains the rationale of this distinction. Signed-off-by: Florian Grandel <[email protected]>
Without enough context, the "clock" term is underspecified in Zephyr. This change renames "Clock API" to "System Clock API" as both the functions as well as the remaining documentation calls the clock being documented here this way. This tries to ensure that people landing on this API from context free search will be less confused. Signed-off-by: Florian Grandel <[email protected]>
fgrandel
force-pushed
the
doc/sys-clock-timeouts
branch
from
cddb5a6
to
5cffd3a
Compare
carlocaione
approved these changes
Jun 30, 2023
kartben
approved these changes
Jun 30, 2023
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.
This small change set introduces two related changes to documentation: