sys_common::thread_local_key: make a note that this is not used on Windows

This commit is contained in:
Ralf Jung 2024-04-07 12:23:47 +02:00
parent 087ae978a1
commit b1d1ad9f8c

View file

@ -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