aboutsummaryrefslogtreecommitdiff
path: root/embassy-executor/src/raw
diff options
context:
space:
mode:
Diffstat (limited to 'embassy-executor/src/raw')
-rw-r--r--embassy-executor/src/raw/mod.rs4
1 files changed, 2 insertions, 2 deletions
diff --git a/embassy-executor/src/raw/mod.rs b/embassy-executor/src/raw/mod.rs
index e9137f8fa..b16a1c7c3 100644
--- a/embassy-executor/src/raw/mod.rs
+++ b/embassy-executor/src/raw/mod.rs
@@ -5,7 +5,7 @@
5//! ## WARNING: here be dragons! 5//! ## WARNING: here be dragons!
6//! 6//!
7//! Using this module requires respecting subtle safety contracts. If you can, prefer using the safe 7//! Using this module requires respecting subtle safety contracts. If you can, prefer using the safe
8//! [executor wrappers](crate::Executor) and the [`embassy_executor::task`](embassy_macros::task) macro, which are fully safe. 8//! [executor wrappers](crate::Executor) and the [`embassy_executor::task`](embassy_executor_macros::task) macro, which are fully safe.
9 9
10#[cfg_attr(target_has_atomic = "ptr", path = "run_queue_atomics.rs")] 10#[cfg_attr(target_has_atomic = "ptr", path = "run_queue_atomics.rs")]
11#[cfg_attr(not(target_has_atomic = "ptr"), path = "run_queue_critical_section.rs")] 11#[cfg_attr(not(target_has_atomic = "ptr"), path = "run_queue_critical_section.rs")]
@@ -97,7 +97,7 @@ impl TaskRef {
97/// A `TaskStorage` must live forever, it may not be deallocated even after the task has finished 97/// A `TaskStorage` must live forever, it may not be deallocated even after the task has finished
98/// running. Hence the relevant methods require `&'static self`. It may be reused, however. 98/// running. Hence the relevant methods require `&'static self`. It may be reused, however.
99/// 99///
100/// Internally, the [embassy_executor::task](embassy_macros::task) macro allocates an array of `TaskStorage`s 100/// Internally, the [embassy_executor::task](embassy_executor_macros::task) macro allocates an array of `TaskStorage`s
101/// in a `static`. The most common reason to use the raw `Task` is to have control of where 101/// in a `static`. The most common reason to use the raw `Task` is to have control of where
102/// the memory for the task is allocated: on the stack, or on the heap with e.g. `Box::leak`, etc. 102/// the memory for the task is allocated: on the stack, or on the heap with e.g. `Box::leak`, etc.
103 103