From 53306b1a7b470851fe3c1271133790f41d5f1d54 Mon Sep 17 00:00:00 2001 From: Per Lindgren Date: Sat, 25 Dec 2021 17:59:19 +0100 Subject: [PATCH 1/2] Docfix: remove pre-release note --- src/lib.rs | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index ba251ef3ca..074e71ec0a 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,7 +1,4 @@ -//! Real-Time Interrupt-driven Concurrency (RTIC) framework for ARM Cortex-M microcontrollers -//! -//! **HEADS UP** This is an **beta** pre-release; there may be breaking changes in the API and -//! semantics before a proper release is made. +//! Real-Time Interrupt-driven Concurrency (RTIC) framework for ARM Cortex-M microcontrollers. //! //! **IMPORTANT**: This crate is published as [`cortex-m-rtic`] on crates.io but the name of the //! library is `rtic`. From 28cf223bfd8a2a207adf341ce3dd0f97ba9699d0 Mon Sep 17 00:00:00 2001 From: Per Lindgren Date: Sat, 25 Dec 2021 18:15:41 +0100 Subject: [PATCH 2/2] Docfix: MSRV and Semantic Versioning --- src/lib.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index 074e71ec0a..25f93999dd 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -14,13 +14,13 @@ //! //! # Minimum Supported Rust Version (MSRV) //! -//! This crate is guaranteed to compile on stable Rust 1.36 (2018 edition) and up. It *might* -//! compile on older versions but that may change in any new patch release. +//! This crate is compiled and tested with the latest toolchain (rolling) as of the release date. +//! If you run into compilation errors, try the latest stable release of the rust toolchain. //! //! # Semantic Versioning //! //! Like the Rust project, this crate adheres to [SemVer]: breaking changes in the API and semantics -//! require a *semver bump* (a new minor version release), with the exception of breaking changes +//! require a *semver bump* (since 1.0.0 a new major version release), with the exception of breaking changes //! that fix soundness issues -- those are considered bug fixes and can be landed in a new patch //! release. //!