Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(ref): Clean up language for package.rust-version #14619

Merged
merged 4 commits into from
Sep 30, 2024
Merged

docs(ref): Clean up language for package.rust-version #14619

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f42831b
docs(ref): Remove duplicate MSRV comment about MSRV
epage Sep 24, 2024
fe70046
docs(ref): Remove reference to interplay of rust-version/edition
epage Sep 24, 2024
f51524c
docs(ref): Fix mistake on how many fields a rust-version must include
epage Sep 24, 2024
d74f02e
docs(ref): Group all functional comments
epage Sep 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 8 additions & 13 deletions src/doc/src/reference/manifest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,29 +163,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