Skip to content

Commit

Permalink
Update doc comments for spawn hook.
Browse files Browse the repository at this point in the history
  • Loading branch information
m-ou-se committed Nov 19, 2024
1 parent b96f023 commit 691796b
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions library/std/src/thread/spawnhook.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,12 @@ use crate::iter;
use crate::sync::Arc;
use crate::thread::Thread;

// A thread local linked list of spawn hooks.
crate::thread_local! {
/// A thread local linked list of spawn hooks.
///
/// It is a linked list of Arcs, such that it can very cheaply be inhereted by spawned threads.
///
/// (That technically makes it a set of linked lists with shared tails, so a linked tree.)
static SPAWN_HOOKS: Cell<SpawnHooks> = const { Cell::new(SpawnHooks { first: None }) };
}

Expand Down Expand Up @@ -42,7 +46,7 @@ struct SpawnHook {
///
/// Hooks can only be added, not removed.
///
/// The hooks will run in order, starting with the most recently added.
/// The hooks will run in reverse order, starting with the most recently added.
///
/// # Usage
///
Expand Down

0 comments on commit 691796b

Please sign in to comment.