diff options
| author | Henrik Tjäder <henrik@grepit.se> | 2021-12-14 22:46:15 +0100 |
|---|---|---|
| committer | Henrik Tjäder <henrik@grepit.se> | 2021-12-19 01:33:14 +0100 |
| commit | 4357d8be1511d28ed16f76439c9af60e78504b28 (patch) | |
| tree | cf1a74b2d312ae2573b33195a2b7d270a43900f6 /book/en/src/by-example/app.md | |
| parent | 37facfb5bf9aca11c43868cb8880b12b9f6b336a (diff) | |
Docs: By-example
Diffstat (limited to 'book/en/src/by-example/app.md')
| -rw-r--r-- | book/en/src/by-example/app.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/book/en/src/by-example/app.md b/book/en/src/by-example/app.md index 09f3371..2c6aca7 100644 --- a/book/en/src/by-example/app.md +++ b/book/en/src/by-example/app.md @@ -3,14 +3,14 @@ ## Requirements on the `app` attribute All RTIC applications use the [`app`] attribute (`#[app(..)]`). This attribute -must be applied to a `mod`-item containing the RTIC application. The `app` -attribute has a mandatory `device` -argument that takes a *path* as a value. This must be a full path pointing to a +only applies to a `mod`-item containing the RTIC application. The `app` +attribute has a mandatory `device` argument that takes a *path* as a value. +This must be a full path pointing to a *peripheral access crate* (PAC) generated using [`svd2rust`] **v0.14.x** or newer. -The `app` attribute will expand into a suitable entry point so it's not required -to use the [`cortex_m_rt::entry`] attribute. +The `app` attribute will expand into a suitable entry point and thus replaces +the use of the [`cortex_m_rt::entry`] attribute. [`app`]: ../../../api/cortex_m_rtic_macros/attr.app.html [`svd2rust`]: https://crates.io/crates/svd2rust @@ -18,9 +18,9 @@ to use the [`cortex_m_rt::entry`] attribute. ## An RTIC application example -To give a flavor of RTIC, the following example contains commonly used features. In the following sections we will go through each feature in detail. +To give a flavour of RTIC, the following example contains commonly used features. +In the following sections we will go through each feature in detail. ``` rust {{#include ../../../../examples/common.rs}} ``` - |