Improve the note about unexpected timestamp values #4135
Conversation
Fixes #4069 Removes the reference to timestamps being zeroed out and instead encourages developers to be aware of occasional nonsensical values.
|
Previews, as seen when this build job started (1d9b0e8): |
spec/index.bs
Outdated
| Note: The physical device may reset the timestamp counter occasionally, which can result in | ||
| unexpected values such as negative deltas between timestamps that logically should be monotonically | ||
| increasing. These instances should be rare and can safely be ignored. Applications should not be | ||
| written in such a way that unexpected timestamps cause an application failure. |
There was a problem hiding this comment.
Add cross-references from the two timestampWrites members and the writeTimestamp method saying something like "The timestamp written is in nanoseconds, but its value is implementation-defined and may not increase monotonically. See [[#timestamp]]."
There was a problem hiding this comment.
This is already in the [[#timestamp]] section. I've moved it to make that more apparent.
There was a problem hiding this comment.
What I meant is we should add links from timestampWrites/writeTimestamp to this section. Otherwise this text is not going to be easily found by developers, I think.
There was a problem hiding this comment.
Ah! Got it. Updated to point towards this section from the other relevant definitions.
Fixes #4069
Removes the reference to timestamps being zeroed out and instead encourages developers to be aware of occasional nonsensical values.