Skip to content

Commit

Permalink
Auto merge of #14619 - epage:msrv-docs, r=weihanglo
Browse files Browse the repository at this point in the history
docs(ref): Clean up language for `package.rust-version`

### What does this PR try to resolve?

Some small tweaks I noticed as I was working on putting in more MSRV policy guidance.

### How should we test and review this PR?

### Additional information
  • Loading branch information
bors committed Sep 30, 2024
2 parents dc041a0 + d74f02e commit 2fd7321
Showing 1 changed file with 8 additions and 13 deletions.
21 changes: 8 additions & 13 deletions src/doc/src/reference/manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,29 +164,24 @@ will have `edition` explicitly specified to a newer value.
### The `rust-version` field

The `rust-version` field is an optional key that tells cargo what version of the
Rust language and compiler your package can be compiled with. If the currently
selected version of the Rust compiler is older than the stated version, cargo
will exit with an error, telling the user what version is required.
Rust language and compiler your package can be compiled with.
If the currently selected version of the Rust compiler is older than the stated
version, cargo will exit with an error, telling the user what version is
required.
This affects all targets/crates in the package, including test suites,
benchmarks, binaries, examples, etc.

The first version of Cargo that supports this field was released with Rust 1.56.0.
In older releases, the field will be ignored, and Cargo will display a warning.
The `rust-version` may be ignored using the `--ignore-rust-version` option.

```toml
[package]
# ...
rust-version = "1.56"
```

The Rust version must be a bare version number with two or three components; it
The Rust version must be a bare version number with at least one component; it
cannot include semver operators or pre-release identifiers. Compiler pre-release
identifiers such as -nightly will be ignored while checking the Rust version.
The `rust-version` must be equal to or newer than the version that first
introduced the configured `edition`.

The `rust-version` may be ignored using the `--ignore-rust-version` option.

Setting the `rust-version` key in `[package]` will affect all targets/crates in
the package, including test suites, benchmarks, binaries, examples, etc.

To find the minimum `rust-version` compatible with your project, you can use third-party tools like [`cargo-msrv`](https://crates.io/crates/cargo-msrv).

Expand Down

0 comments on commit 2fd7321

Please sign in to comment.