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

Warn about path change for #[doc(include)] #63335

Closed
hdevalence opened this issue Aug 6, 2019 · 1 comment
Closed

Warn about path change for #[doc(include)] #63335

hdevalence opened this issue Aug 6, 2019 · 1 comment
Labels
A-diagnostics Area: Messages for errors, warnings, and lints C-enhancement Category: An issue proposing an enhancement or a PR with one. F-external_doc `#![feature(external_doc)]` T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@hdevalence
Copy link

Recently (#60938) the path root for #[doc(include)] files was changed. This change makes a lot of sense, and it's not difficult to update, but there is now a situation where code using the old path roots won't compile on new nightlies and vice versa.

Because the error message is just that the file is missing, there's a lot of confusion (e.g., dalek-cryptography/bulletproofs#290, dalek-cryptography/bulletproofs#282, dalek-cryptography/bulletproofs#292, dalek-cryptography/curve25519-dalek#269, dalek-cryptography/curve25519-dalek#275) about build failures.

Would it be possible to add a warning to the "file missing" error for #[doc(include)] noting that the path changed recently? This won't help the case of compiling new-doc-paths-on-old-nightlies but might give a hint about what's going on when there's a build failure with old-doc-paths-on-new-nightlies.

@jonas-schievink jonas-schievink added C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-diagnostics Area: Messages for errors, warnings, and lints labels Aug 6, 2019
@jyn514
Copy link
Member

jyn514 commented Dec 15, 2020

This changed over 15 months ago and I plan to deprecate doc(include) on the next beta bump (in favor of #78835), so I don't think it makes sense to add at this point. I'm sorry that this change was not communicated clearly at the time.

@jyn514 jyn514 closed this as completed Dec 15, 2020
@jyn514 jyn514 added the F-external_doc `#![feature(external_doc)]` label Dec 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-diagnostics Area: Messages for errors, warnings, and lints C-enhancement Category: An issue proposing an enhancement or a PR with one. F-external_doc `#![feature(external_doc)]` T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

3 participants