doc: kernel: clarify actual behavior of k_uptime_get_32() #18771
Conversation
This file contains hidden or 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
The current implementation does not return the low 32 bits of k_uptime_get() as suggested by its documentation; it returns the number of milliseconds represented by the low 32-bits of the underlying system clock. The truncation before translation results in discontinuities at every point where the system clock increments bit 33. Update the documentation to note that this variant has little value for long-running applications. Signed-off-by: Peter Bigot <[email protected]>
pabigot
force-pushed
the
nordic/20190829a
branch
from
e0c2a25 to
5a74735
Compare
dbkinder
approved these changes
Aug 29, 2019
Member
|
Moving to next release since the review was not finalized for v2.0.0 |
Contributor
Author
|
Disregard, functional fix in #18744 preferred. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
The current implementation does not return the low 32 bits of
k_uptime_get() as suggested by its documentation; it returns the number
of milliseconds represented by the low 32-bits of the underlying system
clock. The truncation before translation results in discontinuities at
every point where the system clock increments bit 33.
Update the documentation to note that this variant has little value for
long-running applications.
Signed-off-by: Peter Bigot [email protected]