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

rustdoc: provide option to turn intra-link resolution errors into proper errors #50082

Closed
QuietMisdreavus opened this issue Apr 19, 2018 · 5 comments
Assignees
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@QuietMisdreavus
Copy link
Member

When rendering docs for the standard library just now, i noticed some warnings come out of rustdoc. It would be prudent to make these force rustdoc to fail, so they would cause CI to fail. We did something similar during the Markdown transition with a temporary flag, --deny-rendering-differences, so i imagine it would work out the same.

@QuietMisdreavus QuietMisdreavus added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Apr 19, 2018
@QuietMisdreavus QuietMisdreavus self-assigned this Apr 19, 2018
@GuillaumeGomez
Copy link
Member

Or to just add a deny-warning option (because more warnings will come!).

@QuietMisdreavus
Copy link
Member Author

In my head, adding a blanket "deny everything rustdoc emits on its own" comes dangerously close to rustdoc having to manage its own lint system, complete with collecting all their names, adding allow/warn/deny/forbid levels and flags, adding some crate attributes like #![doc(deny(intra_link_resolution))], and the like. Such a thing is valuable, but at that point we'd be better off folding it into #46844.

@GuillaumeGomez
Copy link
Member

We have already a huge part merged into rustdoc (we needed it for ui tests). So I think at this point that we could just add the missing parts (which shouldn't be too numerous...).

@QuietMisdreavus
Copy link
Member Author

With the warning having been converted to a full lint, could this issue be considered solved? Do we have command-line flags for allow/warn/deny/forbid yet?

@GuillaumeGomez
Copy link
Member

No we don't. I'll add it as well.

bors added a commit that referenced this issue Jul 5, 2018
…isdreavus

Add command line lint manipulation in rustdoc

Fixes #50082.

r? @QuietMisdreavus
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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

2 participants