about summary refs log tree commit diff
path: root/src/libstd/sync
diff options
context:
space:
mode:
authorTomasz Miąsko <tomasz.miasko@gmail.com>2016-08-19 14:00:20 +0200
committerTomasz Miąsko <tomasz.miasko@gmail.com>2016-08-19 14:11:51 +0200
commit8dae1b662588ed18017a50c2cbc5c6b2880ae27c (patch)
tree64591ba6d433fd83c54845fd8c080be385730261 /src/libstd/sync
parent8ec47261e193b1f983b898a0d985b85e7fcb0668 (diff)
downloadrust-8dae1b662588ed18017a50c2cbc5c6b2880ae27c.tar.gz
rust-8dae1b662588ed18017a50c2cbc5c6b2880ae27c.zip
Document that Condvar makes the best effort to use monotonic clock.
Diffstat (limited to 'src/libstd/sync')
-rw-r--r--src/libstd/sync/condvar.rs8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/libstd/sync/condvar.rs b/src/libstd/sync/condvar.rs
index ca1a9905ebe..5ee42a09e12 100644
--- a/src/libstd/sync/condvar.rs
+++ b/src/libstd/sync/condvar.rs
@@ -144,6 +144,10 @@ impl Condvar {
     /// differences that may not cause the maximum amount of time
     /// waited to be precisely `ms`.
     ///
+    /// Note that the best effort is made to ensure that the time waited is
+    /// measured with a monotonic clock, and not affected by the changes made to
+    /// the system time.
+    ///
     /// The returned boolean is `false` only if the timeout is known
     /// to have elapsed.
     ///
@@ -168,6 +172,10 @@ impl Condvar {
     /// preemption or platform differences that may not cause the maximum
     /// amount of time waited to be precisely `dur`.
     ///
+    /// Note that the best effort is made to ensure that the time waited is
+    /// measured with a monotonic clock, and not affected by the changes made to
+    /// the system time.
+    ///
     /// The returned `WaitTimeoutResult` value indicates if the timeout is
     /// known to have elapsed.
     ///