File tree 2 files changed +31
-0
lines changed
2 files changed +31
-0
lines changed Original file line number Diff line number Diff line change @@ -52,6 +52,7 @@ version and an `-alpha` version side by side in a HAL.
52
52
53
53
- [ How-to: add a new trait] ( docs/how-to-add-a-new-trait.md )
54
54
- [ Version policy] ( docs/version-policy.md )
55
+ - [ MSRV] ( docs/msrv.md )
55
56
56
57
## Implementations and drivers
57
58
@@ -73,6 +74,8 @@ on crates.io.
73
74
This crate is guaranteed to compile on stable Rust 1.46 and up. It * might*
74
75
compile with older versions but that may change in any new patch release.
75
76
77
+ See [ here] ( docs/msrv.md ) for details on how the MSRV may be upgraded.
78
+
76
79
## License
77
80
78
81
Licensed under either of
Original file line number Diff line number Diff line change
1
+ # Minimum Supported Rust Version (MSRV)
2
+
3
+ This crate is guaranteed to compile on all stable Rust versions going back to
4
+ the version stated as MSRV in the README. It * might* compile with even older versions but
5
+ that may change in any new patch release.
6
+
7
+ ## How the MSRV will be upgraded
8
+
9
+ For ` embedded-hal ` , we do not consider upgrading the MSRV a strictly breaking change as defined by
10
+ [ SemVer] ( https://semver.org ) .
11
+
12
+ We follow these rules when upgrading it:
13
+
14
+ - We will not update the MSRV on any patch release: \_ .\_ .* Z* .
15
+ - We may upgrade the MSRV on any * major* or * minor* release: * X* .* Y* .\_ .
16
+ - MSRV upgrades will be clearly stated in the changelog.
17
+
18
+ This applies both to ` 0._._ ` releases as well as ` >=1._._ ` releases.
19
+
20
+ For example:
21
+
22
+ For a given ` x.y.z ` release, we may upgrade the MSRV on ` x ` and ` y ` releases but not on ` z ` releases.
23
+
24
+ If your MSRV upgrade policy differs from this, you are advised to specify the
25
+ ` embedded-hal ` dependency in your ` Cargo.toml ` accordingly.
26
+
27
+ See the [ Rust Embedded Working Group MSRV RFC] ( https://github.com/rust-embedded/wg/blob/master/rfcs/0523-msrv-2020.md )
28
+ for more background information and reasoning.
You can’t perform that action at this time.
0 commit comments