Merge #30

30: Fix docs, add MSRV policy, bump version r=dvc94ch a=Disasm



Co-authored-by: Vadim Kaushan <admin@disasm.info>

riscv-rt/.travis.yml

@@ -3,6 +3,7 @@ language: rust
 rust:
 - nightly
 - stable
+- 1.31.0 # MSRV
 
 env:
 - TARGET=x86_64-unknown-linux-gnu
@@ -15,6 +16,8 @@ matrix:
   exclude:
     - rust: stable
       env: TARGET=riscv64imac-unknown-none-elf
+    - rust: 1.31.0 # MSRV
+      env: TARGET=riscv64imac-unknown-none-elf
 
 
 before_install: set -e

riscv-rt/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "riscv-rt"
-version = "0.4.0"
+version = "0.5.0"
 repository = "https://github.com/rust-embedded/riscv-rt"
 authors = ["The RISC-V Team <risc-v@teams.rust-embedded.org>"]
 categories = ["embedded", "no-std"]

riscv-rt/macros/Cargo.toml

@@ -28,4 +28,4 @@ version = "0.5.5"
 default-features = false
 
 [dev-dependencies]
-riscv-rt = { path = "..", version = "0.4.0" }
+riscv-rt = { path = "..", version = "0.5.0" }

riscv-rt/macros/src/lib.rs

@@ -29,9 +29,8 @@ use proc_macro::TokenStream;
 /// private modules between the item and the root of the crate); if the item is in the root of the
 /// crate you'll be fine. This reachability restriction doesn't apply to Rust 1.31 and newer releases.
 ///
-/// The specified function will be called by the reset handler *after* RAM has been initialized. In
-/// the case of the `thumbv7em-none-eabihf` target the FPU will also be enabled before the function
-/// is called.
+/// The specified function will be called by the reset handler *after* RAM has been initialized.
+/// If present, the FPU will also be enabled before the function is called.
 ///
 /// The type of the specified function must be `[unsafe] fn() -> !` (never ending function)
 ///

riscv-rt/src/lib.rs

@@ -1,5 +1,12 @@
 //! Minimal startup / runtime for RISC-V CPU's
 //!
+//! # Minimum Supported Rust Version (MSRV)
+//!
+//! This crate is guaranteed to compile on stable Rust 1.31 and up. It *might*
+//! compile with older versions but that may change in any new patch release.
+//! Note that `riscv64imac-unknown-none-elf` and `riscv64gc-unknown-none-elf` targets
+//! are not supported on stable yet.
+//!
 //! # Features
 //!
 //! This crate provides