1
Fork 0

Fix some wording in cargo-specifics.md

This commit is contained in:
Eric Huss 2024-06-05 13:34:21 -07:00
parent 88e81bca9f
commit 964e88555b

View file

@ -3,7 +3,7 @@
<!-- <!--
This page is currently (as of May 2024) the canonical place for describing the interaction This page is currently (as of May 2024) the canonical place for describing the interaction
between Cargo and --check-cfg. It is placed in the rustc book rather than the Cargo book between Cargo and --check-cfg. It is placed in the rustc book rather than the Cargo book
since check-cfg is primarely a Rust/rustc feature and is therefor consider by T-cargo to since check-cfg is primarily a Rust/rustc feature and is therefore considered by T-cargo to
be an implementation detail, at least --check-cfg and the unexpected_cfgs are owned by be an implementation detail, at least --check-cfg and the unexpected_cfgs are owned by
rustc, not Cargo. rustc, not Cargo.
--> -->
@ -17,7 +17,7 @@ to the [Cargo book](../../cargo/index.html).
*See the [`[features]` section in the Cargo book][cargo-features] for more details.* *See the [`[features]` section in the Cargo book][cargo-features] for more details.*
With the `[features]` table Cargo provides a mechanism to express conditional compilation and With the `[features]` table, Cargo provides a mechanism to express conditional compilation and
optional dependencies. Cargo *automatically* declares corresponding cfgs for every feature as optional dependencies. Cargo *automatically* declares corresponding cfgs for every feature as
expected. expected.
@ -32,12 +32,12 @@ my_feature = []
## `check-cfg` in `[lints.rust]` table ## `check-cfg` in `[lints.rust]` table
<!-- Note that T-Cargo considers `[lints.rust.unexpected_cfgs.check-cfg]` to be an <!-- Note that T-Cargo considers `lints.rust.unexpected_cfgs.check-cfg` to be an
implementation detail and is therefor not documented in Cargo, we therefor do that ourself --> implementation detail and is therefore documented here and not in Cargo. -->
*See the [`[lints]` section in the Cargo book][cargo-lints-table] for more details.* *See the [`[lints]` section in the Cargo book][cargo-lints-table] for more details.*
When using a statically known custom config (ie. not dependant on a build-script), Cargo provides When using a statically known custom config (i.e., not dependent on a build-script), Cargo provides
the custom lint config `check-cfg` under `[lints.rust.unexpected_cfgs]`. the custom lint config `check-cfg` under `[lints.rust.unexpected_cfgs]`.
It can be used to set custom static [`--check-cfg`](../check-cfg.md) args, it is mainly useful when It can be used to set custom static [`--check-cfg`](../check-cfg.md) args, it is mainly useful when