-
Notifications
You must be signed in to change notification settings - Fork 619
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.
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
Enable feature(doc_auto_cfg) #1395
Conversation
This removes duplicated manual feature gates for documentation and leaves it to `cargo doc` to derive the same information from the actual feature gates. I didn't find any gaps in the auto-generated features and what we had before, but now things like `rustls::cipher_suite::TLS_ECDHE_*` are correctly marked tls12-only.
Codecov Report
@@ Coverage Diff @@
## main #1395 +/- ##
=======================================
Coverage 96.32% 96.32%
=======================================
Files 64 64
Lines 14734 14734
=======================================
Hits 14193 14193
Misses 541 541
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
(i think we should do this in the webpki crate too) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This isn't from your diff, but I noticed while validating the change locally that we have a rustdoc warning:
warning: unresolved link to `ConfigBuilder::with_custom_certificate_verifier`
--> rustls/src/builder.rs:71:10
|
71 | /// - [`ConfigBuilder::with_custom_certificate_verifier`] - requires dangerous_configuration feature flag
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the struct `ConfigBuilder` has no field or associated item named `with_custom_certificate_verifier`
|
= note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
Would you be open to fixing that in this branch? (also might be worth a CI tweak to fail closed on warnings.)
Ah, so we do have The interesting question is whether there's a notation in cargo doc that means "link to this if it's compiled in"? |
Oooh, that makes sense. |
Have raised rust-lang/rust#114626 to discuss that |
This removes duplicated manual feature gates for documentation and leaves it to
cargo doc
to derive the same information from the actual feature gates.I didn't find any gaps in the auto-generated features and what we had before, but now things like
rustls::cipher_suite::TLS_ECDHE_*
are correctly marked tls12-only.fixes #1393