mirror/rtic
1
0
Fork 0
mirror of https://github.com/rtic-rs/rtic.git synced 2024-12-25 19:39:32 +01:00
Code Issues Projects Releases Packages Wiki Activity

minor markdownlints

Browse source
This commit is contained in:
Daniel Carosone 2020-10-02 20:43:52 +10:00
parent 91c2d4850e
commit 3d6a0ea64f
4 changed files with 3 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
book/en/src/by-example/resources.md
View file

@ -1,4 +1,4 @@
## Resources # Resources
The framework provides an abstraction to share data between any of the contexts The framework provides an abstraction to share data between any of the contexts
we saw in the previous section (task handlers, `init` and `idle`): resources. we saw in the previous section (task handlers, `init` and `idle`): resources.

1
book/en/src/by-example/tips.md
View file

@ -116,6 +116,7 @@ Here's an example where `heapless::Pool` is used to "box" buffers of 128 bytes.
``` rust ``` rust
{{#include ../../../../examples/pool.rs}} {{#include ../../../../examples/pool.rs}}
``` ```
``` console ``` console
$ cargo run --example pool $ cargo run --example pool
{{#include ../../../../ci/expected/pool.run}} {{#include ../../../../ci/expected/pool.run}}

3
book/en/src/migration.md
View file

@ -8,7 +8,6 @@ the version v0.5.0 of the framework.
First, the version of the `cortex-m-rtic` dependency needs to be updated to First, the version of the `cortex-m-rtic` dependency needs to be updated to
`"0.5.0"`. The `timer-queue` feature needs to be removed. `"0.5.0"`. The `timer-queue` feature needs to be removed.
``` toml ``` toml
[dependencies.cortex-m-rtic] [dependencies.cortex-m-rtic]
# change this # change this
@ -194,7 +193,7 @@ Also, the `Duration` and `Instant` types and the `U32Ext` trait have been moved
into the `rtic::cyccnt` module. This module is only available on ARMv7-M+ into the `rtic::cyccnt` module. This module is only available on ARMv7-M+
devices. The removal of the `timer-queue` also brings back the `DWT` peripheral devices. The removal of the `timer-queue` also brings back the `DWT` peripheral
inside the core peripherals struct, this will need to be enabled by the application inside the core peripherals struct, this will need to be enabled by the application
inside `init`. inside `init`.
Change this: Change this:

4
book/en/src/migration_rtic.md
View file

@ -8,14 +8,11 @@ change.
[RFC #33]: https://github.com/rtic-rs/rfcs/pull/33 [RFC #33]: https://github.com/rtic-rs/rfcs/pull/33
## `Cargo.toml` ## `Cargo.toml`
First, the `cortex-m-rtfm` dependency needs to be updated to First, the `cortex-m-rtfm` dependency needs to be updated to
`cortex-m-rtic`. `cortex-m-rtic`.
``` toml ``` toml
[dependencies] [dependencies]
# change this # change this
@ -51,4 +48,3 @@ const APP: () = {
}; };
``` ```