Skip to content

Commit b6ef967

Browse files
committed
Note that MSRV is 1.57
This uses the `rust-version` feature added in Rust 1.56 Signed-off-by: Joe Richey <joerichey@google.com>
1 parent c88f926 commit b6ef967

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ readme = "README.md"
2424
repository = "https://github.com/rust-osdev/x86_64"
2525
version = "0.14.8"
2626
edition = "2018"
27+
rust-version = "1.57" # Needed to support panic! in const fns
2728

2829
[dependencies]
2930
bit_field = "0.10.1"

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ Support for x86_64 specific instructions (e.g. TLB flush), registers (e.g. contr
1010
* `nightly`: Enables features only available on nightly Rust; enabled by default.
1111
* `instructions`: Enabled by default, turns on x86\_64 specific instructions, and dependent features. Only available for x86\_64 targets.
1212

13-
## Building with stable rust
13+
## Minimum Supported Rust Version (MSRV)
1414

15-
This needs to have the [compile-time requirements](https://github.com/alexcrichton/cc-rs#compile-time-requirements) of the `cc` crate installed on your system.
16-
It was currently only tested on Linux and MacOS.
15+
If no features are enabled (`--no-default-features`), Rust 1.57.0 is required.
16+
17+
If only the `instructions` feature is enabled (`--no-default-features --features instructions`), Rust 1.59.0 is required.
18+
19+
If the `nightly` feature or any of its sub-features is enabled, a recent nightly is required.

0 commit comments

Comments
 (0)