diff options
| author | Franz Dietrich <dietrich@teilgedanken.de> | 2024-04-04 00:01:46 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-04-03 22:01:46 +0000 |
| commit | 53ed7bf7edb21180cb18c0bf6a7dbe6168331879 (patch) | |
| tree | e7b86edf26aa3bfcf6af4dd825d67a627e8c1252 /book/en/src/by-example/tips | |
| parent | fa2a5b449f1746b4b3bb3da08dab532ee24ba286 (diff) | |
fix included examples and markdown(book) (#912)
* fix included examples and markdown(book)
fixes: #911
* fix footnote pre_init
* more example link updates
* Restore pool example name
* Example: pool: Upgrade to heapless v0.8
* Example: pool: thumbv6 unsupported: wild cfg-if
Experiment with multi-backend example contained in the example
* Example: lm3s6965: Updated cargo.lock
* Book: Use cargo xtask for by-example
* Docs: Contributing: cargo xtask
---------
Co-authored-by: Henrik Tjäder <henrik@tjaders.com>
Diffstat (limited to 'book/en/src/by-example/tips')
| -rw-r--r-- | book/en/src/by-example/tips/destructureing.md | 13 | ||||
| -rw-r--r-- | book/en/src/by-example/tips/indirection.md | 12 | ||||
| -rw-r--r-- | book/en/src/by-example/tips/static_lifetimes.md | 12 |
3 files changed, 19 insertions, 18 deletions
diff --git a/book/en/src/by-example/tips/destructureing.md b/book/en/src/by-example/tips/destructureing.md index 752311d..feaa74b 100644 --- a/book/en/src/by-example/tips/destructureing.md +++ b/book/en/src/by-example/tips/destructureing.md @@ -3,13 +3,14 @@ Destructuring task resources might help readability if a task takes multiple resources. Here are two examples on how to split up the resource struct: -``` rust,noplayground -{{#include ../../../../../rtic/examples/destructure.rs}} +```rust,noplayground +{{#include ../../../../../examples/lm3s6965/examples/destructure.rs}} ``` -``` console -$ cargo run --target thumbv7m-none-eabi --example destructure +```console +$ cargo xtask qemu --verbose --example destructure ``` -``` console -{{#include ../../../../../rtic/ci/expected/destructure.run}} + +```console +{{#include ../../../../../ci/expected/lm3s6965/destructure.run}} ``` diff --git a/book/en/src/by-example/tips/indirection.md b/book/en/src/by-example/tips/indirection.md index aa68190..71a198d 100644 --- a/book/en/src/by-example/tips/indirection.md +++ b/book/en/src/by-example/tips/indirection.md @@ -13,14 +13,14 @@ As this example of approach goes completely outside of RTIC resource model with Here's an example where `heapless::Pool` is used to "box" buffers of 128 bytes. -``` rust,noplayground -{{#include ../../../../../rtic/examples/pool.rs}} +```rust,noplayground +{{#include ../../../../../examples/lm3s6965/examples/pool.rs}} ``` -``` console -$ cargo run --target thumbv7m-none-eabi --example pool +```console +$ cargo xtask qemu --verbose --example pool ``` -``` console -{{#include ../../../../../rtic/ci/expected/pool.run}} +```console +{{#include ../../../../../ci/expected/lm3s6965/pool.run}} ``` diff --git a/book/en/src/by-example/tips/static_lifetimes.md b/book/en/src/by-example/tips/static_lifetimes.md index f4e4829..7f4e38f 100644 --- a/book/en/src/by-example/tips/static_lifetimes.md +++ b/book/en/src/by-example/tips/static_lifetimes.md @@ -8,16 +8,16 @@ In the following example two different tasks share a [`heapless::spsc::Queue`] f [`heapless::spsc::Queue`]: https://docs.rs/heapless/0.7.5/heapless/spsc/struct.Queue.html -``` rust,noplayground -{{#include ../../../../../rtic/examples/static.rs}} +```rust,noplayground +{{#include ../../../../../examples/lm3s6965/examples/static.rs}} ``` Running this program produces the expected output. -``` console -$ cargo run --target thumbv7m-none-eabi --example static +```console +$ cargo xtask qemu --verbose --example static ``` -``` console -{{#include ../../../../../rtic/ci/expected/static.run}} +```console +{{#include ../../../../../ci/expected/lm3s6965/static.run}} ``` |