about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorwebmobster <webmobster@users.noreply.github.com>2015-06-03 13:47:07 +0100
committerEdward Clarke <ec10g11@soton.ac.uk>2015-06-03 18:55:52 +0100
commit24808fa076a2cf86c32e138d95c68e3ee4c7a0fc (patch)
tree01a7bbafaf360ca3738536bd30be4e73db946024 /src/libstd
parenta5979be9fefe671fa81ec70720234602f8112bec (diff)
downloadrust-24808fa076a2cf86c32e138d95c68e3ee4c7a0fc.tar.gz
rust-24808fa076a2cf86c32e138d95c68e3ee4c7a0fc.zip
Add priority policy to RWLock API Documentation
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/sync/rwlock.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/libstd/sync/rwlock.rs b/src/libstd/sync/rwlock.rs
index e7c3d744c17..857d8889b7c 100644
--- a/src/libstd/sync/rwlock.rs
+++ b/src/libstd/sync/rwlock.rs
@@ -24,6 +24,10 @@ use sys_common::rwlock as sys;
 /// of the underlying data (exclusive access) and the read portion of this lock
 /// typically allows for read-only access (shared access).
 ///
+/// The priority policy of the lock is dependent on the underlying operating
+/// system's implementation, and this type does not guarantee that any
+/// particular policy will be used.
+///
 /// The type parameter `T` represents the data that this lock protects. It is
 /// required that `T` satisfies `Send` to be shared across threads and `Sync` to
 /// allow concurrent access through readers. The RAII guards returned from the