aboutsummaryrefslogtreecommitdiff
path: root/src/lib.rs
diff options
context:
space:
mode:
authorGravatar Jorge Aparicio <jorge@japaric.io> 2018-08-27 15:01:09 +0200
committerGravatar Jorge Aparicio <jorge@japaric.io> 2018-08-27 15:01:09 +0200
commitca61baec53c707f6a7814b97045f522d01b338c3 (patch)
treec5b78fab5e5d86e76ecd779dab882615c5340771 /src/lib.rs
parent478418c0eb38b9311e574d18d12cac69d3044e63 (diff)
downloadcortex-m-ca61baec53c707f6a7814b97045f522d01b338c3.tar.gz
cortex-m-ca61baec53c707f6a7814b97045f522d01b338c3.tar.zst
cortex-m-ca61baec53c707f6a7814b97045f522d01b338c3.zip
v0.5.5
Diffstat (limited to 'src/lib.rs')
-rw-r--r--src/lib.rs9
1 files changed, 1 insertions, 8 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 540bc4d..d00fabd 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -7,25 +7,18 @@
//! - Interrupt manipulation mechanisms
//! - Safe wrappers around Cortex-M specific instructions like `bkpt`
//!
-//! # Requirements
-//!
-//! To use this crate on the stable or beta channel `arm-none-eabi-gcc` needs to be installed and
-//! available in your `$PATH`.
-//!
//! # Optional features
//!
//! ## `inline-asm`
//!
//! When this feature is enabled the implementation of all the functions inside the `asm` and
//! `register` modules use inline assembly (`asm!`) instead of external assembly (FFI into separate
-//! assembly files compiled using `arm-none-eabi-gcc`). The advantages the enabling `inline-asm`
+//! assembly files pre-compiled using `arm-none-eabi-gcc`). The advantages of enabling `inline-asm`
//! are:
//!
//! - Reduced overhead. FFI eliminates the possibility of inlining so all operations include a
//! function call overhead when `inline-asm` is not enabled.
//!
-//! - `arm-none-eabi-gcc` is not required for building this crate.
-//!
//! - Some of the `register` API only becomes available only when `inline-asm` is enabled. Check the
//! API docs for details.
//!