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

document MSRV and SemVer policy

Browse source
This commit is contained in:
Jorge Aparicio 2019-02-12 11:08:39 +01:00
parent 557a51ede1
commit 1ba03b9f00
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
src/lib.rs
View file

@ -14,6 +14,20 @@
//! //!
//! [`#[app]`]: ../cortex_m_rtfm_macros/attr.app.html //! [`#[app]`]: ../cortex_m_rtfm_macros/attr.app.html
//! //!
//! # Minimum Supported Rust Version (MSRV)
//!
//! This crate is guaranteed to compile on stable Rust 1.31 (2018 edition) and up. It *might*
//! compile on older versions but that may change in any new patch release.
//!
//! # 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
//! that fix soundness issues -- those are considered bug fixes and can be landed in a new patch
//! release.
//!
//! [SemVer]: https://semver.org/spec/v2.0.0.html
//!
//! # Cargo features //! # Cargo features
//! //!
//! - `timer-queue`. This opt-in feature enables the `schedule` API which can be used to schedule //! - `timer-queue`. This opt-in feature enables the `schedule` API which can be used to schedule