diff options
| author |  bors[bot] <bors[bot]@users.noreply.github.com>
| 2018-11-11 16:13:18 +0000 |
|---|---|---|
| committer | bors[bot] <bors[bot]@users.noreply.github.com>
| 2018-11-11 16:13:18 +0000 |
| commit | 3f2031c2889e7f6a581e476b8cf918f1cfa14de0 (patch) | |
| tree | 281a5fa591bd5679c5c07af65eeebc9c7c7f1b89 | |
| parent | 296f3b3117a572be49b9b7cc189e62f93c8aac55 (diff) | |
| parent | 74976ae36b86f1d99531c8cdb60761f57f844e0e (diff) | |
| download | cortex-m-3f2031c2889e7f6a581e476b8cf918f1cfa14de0.tar.gz cortex-m-3f2031c2889e7f6a581e476b8cf918f1cfa14de0.tar.zst cortex-m-3f2031c2889e7f6a581e476b8cf918f1cfa14de0.zip | |
Merge #152
152: doc related changes r=adamgreig a=japaric
see individual commit messages for details
Co-authored-by: Jorge Aparicio <jorge@japaric.io>
| -rw-r--r-- | cortex-m-rt/Cargo.toml | 5 | ||||
| -rw-r--r-- | cortex-m-rt/src/lib.rs | 12 |
2 files changed, 9 insertions, 8 deletions
diff --git a/cortex-m-rt/Cargo.toml b/cortex-m-rt/Cargo.toml index 43da43b..d9b1bc3 100644 --- a/cortex-m-rt/Cargo.toml +++ b/cortex-m-rt/Cargo.toml @@ -2,7 +2,7 @@ authors = ["Jorge Aparicio <jorge@japaric.io>", "Hideki Sekine <sekineh@me.com>"] categories = ["embedded", "no-std"] description = "Minimal runtime / startup for Cortex-M microcontrollers" -documentation = "https://rust-embedded.github.io/cortex-m-rt/" +documentation = "https://docs.rs/cortex-m-rt/" keywords = ["arm", "cortex-m", "runtime", "startup"] license = "MIT OR Apache-2.0" name = "cortex-m-rt" @@ -33,3 +33,6 @@ required-features = ["device"] [features] device = [] + +[package.metadata.docs.rs] +features = ["device"]
\ No newline at end of file diff --git a/cortex-m-rt/src/lib.rs b/cortex-m-rt/src/lib.rs index 4d9bf3f..f418e7f 100644 --- a/cortex-m-rt/src/lib.rs +++ b/cortex-m-rt/src/lib.rs @@ -16,19 +16,17 @@ //! //! This crate also provides the following attributes: //! -//! - [`#[entry]`] to declare the entry point of the program -//! - [`#[exception]`] to override an exception handler. If not overridden all exception handlers +//! - `#[entry]` to declare the entry point of the program +//! - `#[exception]` to override an exception handler. If not overridden all exception handlers //! default to an infinite loop. -//! - [`#[pre_init]`] to run code *before* `static` variables are initialized -//! -//! [`#[entry]`]: ../cortex_m_rt_macros/fn.entry.html -//! [`#[exception]`]: ../cortex_m_rt_macros/fn.exception.html -//! [`#[pre_init]`]: ../cortex_m_rt_macros/fn.pre_init.html +//! - `#[pre_init]` to run code *before* `static` variables are initialized //! //! This crate also implements a related attribute called `#[interrupt]`, which allows you //! to define interrupt handlers. However, since which interrupts are available depends on the //! microcontroller in use, this attribute should be re-exported and used from a device crate. //! +//! The documentation for these attributes can be found in the [Reexports](#reexports) section. +//! //! # Requirements //! //! ## `memory.x` |