Merge pull request #17404 from kaspar030/ztimer_clarify_now_comparisons

sys/ztimer: ztimer_now() add warning regarding comparing now() values
This commit is contained in:
Kaspar Schleiser 2021-12-15 15:44:27 +01:00 committed by GitHub
commit a8ade82a95
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -465,6 +465,9 @@ ztimer_now_t _ztimer_now_extend(ztimer_clock_t *clock);
/**
* @brief Get the current time from a clock
*
* @warning don't compare ztimer_now() values from different clocks. The
* clocks are almost certainly not synchronized.
*
* @param[in] clock ztimer clock to operate on
*
* @return Current count on @p clock