diff options
| author | Barnaby Walters <[email protected]> | 2023-12-22 19:05:16 +0100 |
|---|---|---|
| committer | Barnaby Walters <[email protected]> | 2023-12-22 19:05:16 +0100 |
| commit | 6bbc316312b2ba372ea05c52924d99bc4fb5382a (patch) | |
| tree | f653e192f72b0762c9bd185a9f9ba0194bac3c88 /embassy-executor/README.md | |
| parent | 87c03037e320ce30c0cd34fe97e0365e1b11aa9a (diff) | |
[embassy-executor] improved documentation
* Feature auto-documentation
* Task arena sizes in a <details> 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
Diffstat (limited to 'embassy-executor/README.md')
| -rw-r--r-- | embassy-executor/README.md | 2 |
1 files changed, 1 insertions, 1 deletions
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 | |||
| 22 | The arena size can be configured in two ways: | 22 | The arena size can be configured in two ways: |
| 23 | 23 | ||
| 24 | - Via Cargo features: enable a Cargo feature like `task-arena-size-8192`. Only a selection of values | 24 | - Via Cargo features: enable a Cargo feature like `task-arena-size-8192`. Only a selection of values |
| 25 | is available, check `Cargo.toml` for the list. | 25 | is available, see [Task Area Sizes](#task-arena-size) for reference. |
| 26 | - Via environment variables at build time: set the variable named `EMBASSY_EXECUTOR_TASK_ARENA_SIZE`. For example | 26 | - Via environment variables at build time: set the variable named `EMBASSY_EXECUTOR_TASK_ARENA_SIZE`. For example |
| 27 | `EMBASSY_EXECUTOR_TASK_ARENA_SIZE=4321 cargo build`. You can also set them in the `[env]` section of `.cargo/config.toml`. | 27 | `EMBASSY_EXECUTOR_TASK_ARENA_SIZE=4321 cargo build`. You can also set them in the `[env]` section of `.cargo/config.toml`. |
| 28 | Any value can be set, unlike with Cargo features. | 28 | Any value can be set, unlike with Cargo features. |
