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.

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: fix docsrs builds with the fs feature enabled #6585

Merged
merged 2 commits into from
Jun 5, 2024

Conversation

udoprog
Copy link
Contributor

@udoprog udoprog commented May 24, 2024

If you enable --cfg docsrs with the fs feature but without the net feature, tokio docs doesn't docbuild.

The docs::os module need to be defined if the fs feature is enabled since it's used here.

I genuinely have no idea if this interferes with #6166 or any of those related issues. Some tests would be nice, but I'm not sure if we want to set them up. Testing feature combinations for the sole benefit of dependent docsrs builds seems awkward. We might just prefer having these always being exported with #[allow(unused)] to avoid future regressions.

@udoprog udoprog added the T-docs Topic: documentation label May 24, 2024
@Darksonn Darksonn added A-tokio Area: The main tokio crate M-fs Module: tokio/fs labels Jun 4, 2024
@Darksonn Darksonn enabled auto-merge (squash) June 4, 2024 22:32
@Darksonn Darksonn merged commit 16fccaf into tokio-rs:master Jun 5, 2024
77 checks passed
@udoprog udoprog deleted the fix-docsrs-fs branch June 5, 2024 08:25
This was referenced Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-tokio Area: The main tokio crate M-fs Module: tokio/fs T-docs Topic: documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants