Skip to content

Commit

Permalink
docs(ref): Group all functional comments
Browse files Browse the repository at this point in the history
  • Loading branch information
epage committed Sep 30, 2024
1 parent f51524c commit d74f02e
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions src/doc/src/reference/manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,9 +163,14 @@ 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 `rust-version` may be ignored using the `--ignore-rust-version` option.

```toml
[package]
Expand All @@ -177,11 +182,6 @@ 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` 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).

When used on packages that get published, we recommend [verifying the `rust-version`](../guide/continuous-integration.md#verifying-rust-version).
Expand Down

0 comments on commit d74f02e

Please sign in to comment.