Skip to content

Commit 408b8d5

Browse files
committed
Remove lint mitigation suggesting to use a cargo feature.
Since it is not possible to have "private" features, it can be an issue if users enable it without understanding what it is for.
1 parent 21d9134 commit 408b8d5

File tree

1 file changed

+2
-6
lines changed

1 file changed

+2
-6
lines changed

src/doc/src/reference/semver.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1206,12 +1206,8 @@ Additionally, updating `rustc` to a new version may introduce new lints.
12061206
Transitive dependencies which introduce new lints should not usually cause a failure because Cargo uses [`--cap-lints`](../../rustc/lints/levels.html#capping-lints) to suppress all lints in dependencies.
12071207

12081208
Mitigating strategies:
1209-
* Options for dealing with denying warnings:
1210-
* Understand you may need to deal with resolving new warnings whenever you update your dependencies.
1211-
* Place `deny(warnings)` behind a [feature][Cargo features], for example `#![cfg_attr(feature = "deny-warnings", deny(warnings))]`.
1212-
Set up your automated CI to check your crate with the feature enabled, possibly as an allowed failure with a notification.
1213-
Beware that features are exposed to users, so you may want to clearly document it as something that is not to be used.
1214-
* If using RUSTFLAGS to pass `-Dwarnings`, also add the `-A` flag to allow lints that are likely to cause issues, such as `-Adeprecated`.
1209+
* If you build with warnings denied, understand you may need to deal with resolving new warnings whenever you update your dependencies.
1210+
If using RUSTFLAGS to pass `-Dwarnings`, also add the `-A` flag to allow lints that are likely to cause issues, such as `-Adeprecated`.
12151211
* Introduce deprecations behind a [feature][Cargo features].
12161212
For example `#[cfg_attr(feature = "deprecated", deprecated="use bar instead")]`.
12171213
Then, when you plan to remove an item in a future SemVer breaking change, you can communicate with your users that they should enable the `deprecated` feature *before* updating to remove the use of the deprecated items.

0 commit comments

Comments
 (0)