itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-10-01 11:30:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(ref): Group all functional comments

Browse Source
This commit is contained in:
Ed Page 2024-09-24 15:22:11 -05:00
parent f51524c0b7
commit d74f02e642
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/doc/src/reference/manifest.md
View File

@ -163,9 +163,14 @@ will have `edition` explicitly specified to a newer value.
### The `rust-version` field ### The `rust-version` field
The `rust-version` field is an optional key that tells cargo what version of the 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 Rust language and compiler your package can be compiled with.
selected version of the Rust compiler is older than the stated version, cargo If the currently selected version of the Rust compiler is older than the stated
will exit with an error, telling the user what version is required. 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 ```toml
[package] [package]
@ -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 cannot include semver operators or pre-release identifiers. Compiler pre-release
identifiers such as -nightly will be ignored while checking the Rust version. 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). 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). When used on packages that get published, we recommend [verifying the `rust-version`](../guide/continuous-integration.md#verifying-rust-version).