about summary refs log tree commit diff
diff options
context:
space:
mode:
authorMatthias Krüger <matthias.krueger@famsik.de>2024-04-07 14:50:00 +0200
committerGitHub <noreply@github.com>2024-04-07 14:50:00 +0200
commite5bdd7ebc184523673ccebcd73c36c0b8905c57c (patch)
treea5daa2c7b636a30bc78b045c529b1a063e433649
parentf64e97100ca0e02087483fc9088cd8e528335cf7 (diff)
parentb1d1ad9f8cbe9b6d66effaa9f5856a3b834b2e73 (diff)
downloadrust-e5bdd7ebc184523673ccebcd73c36c0b8905c57c.tar.gz
rust-e5bdd7ebc184523673ccebcd73c36c0b8905c57c.zip
Rollup merge of #123589 - RalfJung:nowin, r=ChrisDenton
sys_common::thread_local_key: make a note that this is not used on Windows

This just confused me for a while. I don't have the time to clean it up but I can at least leave a note for the next wary traveler.
-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