-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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
ci: upgrade to new nightly #4268
Conversation
As of the latest nightly, this is a warning by default and we deny doc warnings on CI. Refs: https://doc.rust-lang.org/rustdoc/lints.html#broken_intra_doc_links
#![cfg_attr(docsrs, feature(doc_cfg_hide))] | ||
#![cfg_attr(docsrs, doc(cfg_hide(docsrs)))] | ||
#![cfg_attr(docsrs, doc(cfg_hide(loom)))] | ||
#![cfg_attr(docsrs, doc(cfg_hide(not(loom))))] |
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.
Have you verified that the documentation still looks alright after removing these?
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.
Yes
nightly-2021-11-23, on taiki-e/doc_cfg branch:
cd tokio
RUSTDOCFLAGS='--cfg docsrs' cargo +nightly-2021-11-23 doc --all-features --open
nightly-2021-10-25, on taiki-e/doc_cfg branch:
cd tokio
RUSTDOCFLAGS='--cfg docsrs' cargo +nightly-2021-10-25 doc --all-features --open
EDIT: The first image I posted had the date reversed.
@@ -99,7 +99,6 @@ macro_rules! cfg_io_driver_impl { | |||
feature = "process", | |||
all(unix, feature = "signal"), | |||
))] | |||
#[cfg_attr(docsrs, doc(cfg(all())))] |
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.
Same here.
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.
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.
Assuming that the docs still look good, this LGTM.
Motivation
The behavior introduced in rust-lang/rust#89596 (auto doc_cfg) is now split to another feature flag (rust-lang/rust#90502).
We can remove some changes done in #4193.