From 6bbc316312b2ba372ea05c52924d99bc4fb5382a Mon Sep 17 00:00:00 2001 From: Barnaby Walters Date: Fri, 22 Dec 2023 19:05:16 +0100 Subject: [embassy-executor] improved documentation * Feature auto-documentation * Task arena sizes in a
list * Non-documented comment explaining turbowakers with see-also link Further improvements: * Are the task-arena-size-* numbers sizes in bytes? or something else? * Task arena section could benefit from advice about how to choose a suitable size --- embassy-executor/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'embassy-executor/README.md') diff --git a/embassy-executor/README.md b/embassy-executor/README.md index 80ecfc71a..aa9d59907 100644 --- a/embassy-executor/README.md +++ b/embassy-executor/README.md @@ -22,7 +22,7 @@ Tasks are allocated from the arena when spawned for the first time. If the task The arena size can be configured in two ways: - Via Cargo features: enable a Cargo feature like `task-arena-size-8192`. Only a selection of values - is available, check `Cargo.toml` for the list. + is available, see [Task Area Sizes](#task-arena-size) for reference. - Via environment variables at build time: set the variable named `EMBASSY_EXECUTOR_TASK_ARENA_SIZE`. For example `EMBASSY_EXECUTOR_TASK_ARENA_SIZE=4321 cargo build`. You can also set them in the `[env]` section of `.cargo/config.toml`. Any value can be set, unlike with Cargo features. -- cgit