aboutsummaryrefslogtreecommitdiff
path: root/embassy-executor
diff options
context:
space:
mode:
authorJonas Spinner <[email protected]>2025-01-06 19:28:07 +0100
committerGitHub <[email protected]>2025-01-06 19:28:07 +0100
commit38033a2e148cc5394965edf3e9215ed17c61cdf2 (patch)
tree84e23f3dec59ec6dd9c0563adcd153f0a778b588 /embassy-executor
parent7dfb6f7113ef65340f30707b5d358153316c2ba7 (diff)
fix typo in executor README.md
Diffstat (limited to 'embassy-executor')
-rw-r--r--embassy-executor/README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/embassy-executor/README.md b/embassy-executor/README.md
index aa9d59907..074c73555 100644
--- a/embassy-executor/README.md
+++ b/embassy-executor/README.md
@@ -17,7 +17,7 @@ When the `nightly` Cargo feature is not enabled, `embassy-executor` allocates ta
17 17
18If the task arena gets full, the program will panic at runtime. To guarantee this doesn't happen, you must set the size to the sum of sizes of all tasks. 18If the task arena gets full, the program will panic at runtime. To guarantee this doesn't happen, you must set the size to the sum of sizes of all tasks.
19 19
20Tasks are allocated from the arena when spawned for the first time. If the task exists, the allocation is not released to the arena, but can be reused to spawn the task again. For multiple-instance tasks (like `#[embassy_executor::task(pool_size = 4)]`), the first spawn will allocate memory for all instances. This is done for performance and to increase predictability (for example, spawning at least 1 instance of every task at boot guarantees an immediate panic if the arena is too small, while allocating instances on-demand could delay the panic to only when the program is under load). 20Tasks are allocated from the arena when spawned for the first time. If the task exits, the allocation is not released to the arena, but can be reused to spawn the task again. For multiple-instance tasks (like `#[embassy_executor::task(pool_size = 4)]`), the first spawn will allocate memory for all instances. This is done for performance and to increase predictability (for example, spawning at least 1 instance of every task at boot guarantees an immediate panic if the arena is too small, while allocating instances on-demand could delay the panic to only when the program is under load).
21 21
22The arena size can be configured in two ways: 22The arena size can be configured in two ways:
23 23