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>
This commit is contained in:
Franz Dietrich 2024-04-04 00:01:46 +02:00 committed by GitHub
parent fa2a5b449f
commit 53ed7bf7ed
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
22 changed files with 437 additions and 342 deletions

View file

@ -11,35 +11,35 @@ improve performance in some cases.
The example below shows how to place the higher priority task, `bar`, in RAM.
``` rust,noplayground
{{#include ../../../../../rtic/examples/ramfunc.rs}}
```rust,noplayground
{{#include ../../../../../examples/lm3s6965/examples/ramfunc.rs}}
```
Running this program produces the expected output.
``` console
$ cargo run --target thumbv7m-none-eabi --example ramfunc
```console
$ cargo xtask qemu --verbose --example ramfunc
```
``` console
{{#include ../../../../../rtic/ci/expected/ramfunc.run}}
```console
{{#include ../../../../../ci/expected/lm3s6965/ramfunc.run}}
```
One can look at the output of `cargo-nm` to confirm that `bar` ended in RAM
(`0x2000_0000`), whereas `foo` ended in Flash (`0x0000_0000`).
``` console
```console
$ cargo nm --example ramfunc --release | grep ' foo::'
```
``` console
{{#include ../../../../../rtic/ci/expected/ramfunc.run.grep.foo}}
```console
{{#include ../../../../../ci/expected/lm3s6965/ramfunc.run.grep.foo}}
```
``` console
```console
$ cargo nm --example ramfunc --target thumbv7m-none-eabi --release | grep '*bar::'
```
``` console
{{#include ../../../../../rtic/ci/expected/ramfunc.run.grep.bar}}
```console
{{#include ../../../../../ci/expected/lm3s6965/ramfunc.run.grep.bar}}
```