Skip to content

Commit

Permalink
Merge #436
Browse files Browse the repository at this point in the history
436: Use standard wording for the MSRV note r=ryankurte a=ra-kete

Part of [wg/#445](rust-embedded/wg#445).

svd2rust already has its MSRV documented and tested, but @adamgreig suggested updating it to use the standard wording. Since this is a special case in that the MSRV applies to the generated code, not svd2rust itself, the standard wording doesn't fully apply, so I changed it in a (hopefully) sensible way.

An open question is: Should we also document the MSRV of svd2rust itself? Looking at how the CI works, currently it's implicitly guaranteed to be the same version als the MSRV for the generated code, so we could just extend the note in the README to also include svd2rust itself.

Co-authored-by: Jan Teske <jteske@posteo.net>
  • Loading branch information
bors[bot] and teskje authored Apr 19, 2020
2 parents 67a0df0 + aafa156 commit 41104ca
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ This project is developed and maintained by the [Tools team][team].

# [API](https://docs.rs/svd2rust)

## Requirements
## Minimum Supported Rust Version (MSRV)

The **generated code** is intended to compile on all stable versions of Rust greater or equal to **1.37.0**, as well as the latest beta and the latest nightly.
The **generated code** is guaranteed to compile on stable Rust 1.37.0 and up.

If you encounter compilation errors on any stable version newer than 1.37.0, please open an issue.

Expand Down

0 comments on commit 41104ca

Please sign in to comment.