mirror/rtic
1
0
Fork 0
mirror of https://github.com/rtic-rs/rtic.git synced 2024-11-29 15:04:32 +01:00
Code Issues Projects Releases Packages Wiki Activity

doc tweaks

Browse source
This commit is contained in:
Jorge Aparicio 2019-08-21 12:33:04 +02:00
parent 45f9faae9c
commit 996bdf8f0c
3 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
book/en/src/by-example/app.md
View file

@ -10,8 +10,8 @@ All RTFM applications use the [`app`] attribute (`#[app(..)]`). This attribute
must be applied to a `const` item that contains items. The `app` attribute has 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 a mandatory `device` argument that takes a *path* as a value. This path must
point to a *peripheral access crate* (PAC) generated using [`svd2rust`] 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 **v0.14.x** or newer. The `app` attribute will expand into a suitable entry
not required to use the [`cortex_m_rt::entry`] attribute. point so it's not required to use the [`cortex_m_rt::entry`] attribute.
[`app`]: ../../api/cortex_m_rtfm_macros/attr.app.html [`app`]: ../../api/cortex_m_rtfm_macros/attr.app.html
[`svd2rust`]: https://crates.io/crates/svd2rust [`svd2rust`]: https://crates.io/crates/svd2rust

4
macros/src/lib.rs
View file

@ -22,11 +22,11 @@ mod tests;
/// The `app` attribute has one mandatory argument: /// The `app` attribute has one mandatory argument:
/// ///
/// - `device = <path>`. The path must point to a device crate generated using [`svd2rust`] /// - `device = <path>`. The path must point to a device crate generated using [`svd2rust`]
/// **v0.14.x**. /// **v0.14.x** or newer.
/// ///
/// [`svd2rust`]: https://crates.io/crates/svd2rust /// [`svd2rust`]: https://crates.io/crates/svd2rust
/// ///
/// and several optional arguments: /// and a few optional arguments:
/// ///
/// - `peripherals = <bool>`. Indicates whether the runtime takes the device peripherals and makes /// - `peripherals = <bool>`. Indicates whether the runtime takes the device peripherals and makes
/// them available to the `init` context. /// them available to the `init` context.

5
src/lib.rs
View file

@ -31,7 +31,10 @@
//! //!
//! # Cargo features //! # Cargo features
//! //!
//! - `heterogeneous`. This opt-in feature enables the *experimental* heterogeneous multi-core support. //! - `heterogeneous`. This opt-in feature enables the *experimental* heterogeneous multi-core
//! support. This feature depends on unstable feature and requires the use of the nightly channel.
//!
//! - `homogeneous`. This opt-in feature enables the *experimental* homogeneous multi-core support.
#![deny(missing_docs)] #![deny(missing_docs)]
#![deny(rust_2018_compatibility)] #![deny(rust_2018_compatibility)]