diff options
| -rw-r--r-- | Cargo.toml | 4 | ||||
| -rw-r--r-- | README.md | 9 | ||||
| -rw-r--r-- | book/src/by-example/app.md | 6 | ||||
| -rw-r--r-- | book/src/by-example/new.md | 10 | ||||
| -rw-r--r-- | book/src/preface.md | 4 | ||||
| -rw-r--r-- | macros/Cargo.toml | 2 |
6 files changed, 13 insertions, 22 deletions
@@ -12,7 +12,7 @@ license = "MIT OR Apache-2.0" name = "cortex-m-rtfm" readme = "README.md" repository = "https://github.com/japaric/cortex-m-rtfm" -version = "0.4.0-beta.3" +version = "0.4.0" [lib] name = "rtfm" @@ -36,7 +36,7 @@ required-features = ["timer-queue"] [dependencies] cortex-m = "0.5.8" cortex-m-rt = "0.6.7" -cortex-m-rtfm-macros = { path = "macros", version = "0.4.0-beta.3" } +cortex-m-rtfm-macros = { path = "macros", version = "0.4.0" } heapless = "0.4.1" owned-singleton = "0.1.0" @@ -2,15 +2,6 @@ A concurrency framework for building real time systems. -**IMPORTANT** This crate is currently in pre-release (beta) state . We reserve -the right to make breaking changes in the syntax or to patch memory safety holes -before the v0.4.0 release, which is planned for 2018-12-07. When v0.4.0 is -released *all the pre-releases will be yanked*. If you run into a panic message -or an unhelpful error message (e.g. misleading span), or if something doesn't -behave the way you expect please open [an issue]! - -[an issue]: https://github.com/japaric/cortex-m-rtfm/issues - ## Features - **Tasks** as the unit of concurrency [^1]. Tasks can be *event triggered* diff --git a/book/src/by-example/app.md b/book/src/by-example/app.md index ae0f4b8..26aa03f 100644 --- a/book/src/by-example/app.md +++ b/book/src/by-example/app.md @@ -9,9 +9,9 @@ This is the smallest possible RTFM application: All RTFM applications use the [`app`] attribute (`#[app(..)]`). This attribute must be applied to a `const` item that contains items. The `app` attribute has a mandatory `device` argument that takes a *path* as a value. This path must -point to a *device* crate generated using [`svd2rust`] **v0.14.x**. The `app` -attribute will expand into a suitable entry point so it's not required to use -the [`cortex_m_rt::entry`] attribute. +point to a *peripheral access crate* (PAC) generated using [`svd2rust`] +**v0.14.x**. The `app` attribute will expand into a suitable entry point so it's +not required to use the [`cortex_m_rt::entry`] attribute. [`app`]: ../../api/cortex_m_rtfm_macros/attr.app.html [`svd2rust`]: https://crates.io/crates/svd2rust diff --git a/book/src/by-example/new.md b/book/src/by-example/new.md index b6c4643..b7d18a7 100644 --- a/book/src/by-example/new.md +++ b/book/src/by-example/new.md @@ -16,9 +16,9 @@ $ cargo generate \ $ # follow the rest of the instructions ``` -2. Add a device crate that was generated using [`svd2rust`] **v0.14.x**, or a - board support crate that depends on one such device crate as a dependency. - Make sure that the `rt` feature of the crate is enabled. +2. Add a peripheral access crate (PAC) that was generated using [`svd2rust`] + **v0.14.x**, or a board support crate that depends on one such PAC as a + dependency. Make sure that the `rt` feature of the crate is enabled. [`svd2rust`]: https://crates.io/crates/svd2rust @@ -40,7 +40,7 @@ $ rm memory.x build.rs `timer-queue` feature. ``` console -$ cargo add cortex-m-rtfm --allow-prerelease --upgrade=none +$ cargo add cortex-m-rtfm ``` 4. Write your RTFM application. @@ -49,7 +49,7 @@ Here I'll use the `init` example from the `cortex-m-rtfm` crate. ``` console $ curl \ - -L https://github.com/japaric/cortex-m-rtfm/raw/v0.4.0-beta.1/examples/init.rs \ + -L https://github.com/japaric/cortex-m-rtfm/raw/v0.4.0/examples/init.rs \ > src/main.rs ``` diff --git a/book/src/preface.md b/book/src/preface.md index fe4ad62..e64a996 100644 --- a/book/src/preface.md +++ b/book/src/preface.md @@ -7,6 +7,6 @@ This book contains user level documentation for the Real Time For the Masses (RTFM) framework. The API reference can be found [here](../api/rtfm/index.html). -{{#include ../../README.md:5:55}} +{{#include ../../README.md:5:46}} -{{#include ../../README.md:61:}} +{{#include ../../README.md:52:}} diff --git a/macros/Cargo.toml b/macros/Cargo.toml index 4c4b734..b35ca1d 100644 --- a/macros/Cargo.toml +++ b/macros/Cargo.toml @@ -9,7 +9,7 @@ license = "MIT OR Apache-2.0" name = "cortex-m-rtfm-macros" readme = "../README.md" repository = "https://github.com/japaric/cortex-m-rtfm" -version = "0.4.0-beta.3" +version = "0.4.0" [lib] proc-macro = true |