about summary refs log tree commit diff
diff options
context:
space:
mode:
authorRalf Jung <post@ralfj.de>2024-04-07 12:23:47 +0200
committerRalf Jung <post@ralfj.de>2024-04-07 12:23:47 +0200
commitb1d1ad9f8cbe9b6d66effaa9f5856a3b834b2e73 (patch)
treec0d00676af69cf63fa799d42f8c1876fa0c9c9e7
parent087ae978a13013800c8a484cf17c8951ab0b6b0c (diff)
downloadrust-b1d1ad9f8cbe9b6d66effaa9f5856a3b834b2e73.tar.gz
rust-b1d1ad9f8cbe9b6d66effaa9f5856a3b834b2e73.zip
sys_common::thread_local_key: make a note that this is not used on Windows
-rw-r--r--library/std/src/sys_common/thread_local_key.rs5
1 files changed, 4 insertions, 1 deletions
diff --git a/library/std/src/sys_common/thread_local_key.rs b/library/std/src/sys_common/thread_local_key.rs
index 7dcc1141099..a9cd26389cd 100644
--- a/library/std/src/sys_common/thread_local_key.rs
+++ b/library/std/src/sys_common/thread_local_key.rs
@@ -1,4 +1,4 @@
-//! OS-based thread local storage
+//! OS-based thread local storage for non-Windows systems
 //!
 //! This module provides an implementation of OS-based thread local storage,
 //! using the native OS-provided facilities (think `TlsAlloc` or
@@ -11,6 +11,9 @@
 //! the OS-TLS key. The other is a type which does implement `Drop` and hence
 //! has a safe interface.
 //!
+//! Windows doesn't use this module at all; `sys::pal::windows::thread_local_key`
+//! gets imported in its stead.
+//!
 //! # Usage
 //!
 //! This module should likely not be used directly unless other primitives are