aboutsummaryrefslogtreecommitdiff
path: root/asm.rs
diff options
context:
space:
mode:
Diffstat (limited to 'asm.rs')
-rw-r--r--asm.rs13
1 files changed, 11 insertions, 2 deletions
diff --git a/asm.rs b/asm.rs
index 0bbf0c7..f5b0179 100644
--- a/asm.rs
+++ b/asm.rs
@@ -14,11 +14,20 @@
//! assembly.
//!
//! For developers and contributors to `cortex-m`, this setup means that they don't have to install
-//! any binutils, assembler, or C compiler to hack on the crate. All they need is a nightly rustc
-//! and run `cargo xtask assemble` to rebuild the archives from this file.
+//! any binutils, assembler, or C compiler to hack on the crate. All they need is to run `cargo
+//! xtask assemble` to rebuild the archives from this file.
//!
//! Cool, right?
//!
+//! # Rust version management
+//!
+//! Since inline assembly is still unstable, and we want to ensure that the created blobs are
+//! up-to-date in CI, we have to pin the nightly version we use for this. The nightly toolchain is
+//! stored in `asm-toolchain`.
+//!
+//! The `cargo xtask` automation will automatically install the `asm-toolchain` as well as all
+//! Cortex-M targets needed to generate the blobs.
+//!
//! [linker plugin LTO]: https://doc.rust-lang.org/stable/rustc/linker-plugin-lto.html
#![feature(asm)]