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

Check Rustdoc warnings for the compiler in PR CI #106624

Closed
Noratrieb opened this issue Jan 9, 2023 · 7 comments · Fixed by #106670
Closed

Check Rustdoc warnings for the compiler in PR CI #106624

Noratrieb opened this issue Jan 9, 2023 · 7 comments · Fixed by #106670
Assignees
Labels
A-testsuite Area: The testsuite used to check the correctness of rustc C-enhancement Category: An issue proposing an enhancement or a PR with one. E-medium Call for participation: Medium difficulty. Experience needed to fix: Intermediate. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. T-infra Relevant to the infrastructure team, which will review and decide on the PR/issue.

Comments

@Noratrieb
Copy link
Member

Noratrieb commented Jan 9, 2023

Docs (and specially intra-doc-links) are easy to get wrong and rarely tested locally, causing many rollups to fail. We should check them in CI as well to catch mistakes early.

@Noratrieb Noratrieb added C-enhancement Category: An issue proposing an enhancement or a PR with one. T-infra Relevant to the infrastructure team, which will review and decide on the PR/issue. labels Jan 9, 2023
@Noratrieb Noratrieb changed the title Check docs CI Check docs in CI Jan 9, 2023
@albertlarsan68
Copy link
Member

@rustbot claim

@the8472
Copy link
Member

the8472 commented Jan 9, 2023

But ./x test linkchecker already runs in PR CI

@jyn514
Copy link
Member

jyn514 commented Jan 10, 2023

cc #106117

maybe linkchecker is missing some cases?

@Noratrieb
Copy link
Member Author

The most recent case I've seen was this: #100036 (comment)
where broken docs broke a try build while PR CI was green (that wasn't an intra doc link though but still docs)

@jyn514
Copy link
Member

jyn514 commented Jan 10, 2023

Ah ok, this is specifically about rustdoc warnings, not broken links. That's definitely doable to do, we can shove x doc --stage 0 compiler into mingw-check :) it doesn't need to build the compiler at all, only check it.

@jyn514 jyn514 added A-testsuite Area: The testsuite used to check the correctness of rustc E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. E-medium Call for participation: Medium difficulty. Experience needed to fix: Intermediate. labels Jan 10, 2023
@jyn514 jyn514 changed the title Check docs in CI Check Rustdoc warnings for the compiler in PR CI Jan 10, 2023
@lukas-code
Copy link
Member

But ./x test linkchecker already runs in PR CI

Apparently ./x test linkchecker doesn't actually build the compiler docs (or tool docs) when the build.compiler-docs flag isn't set in config.toml. I don't know if this is a bug or a feature, but we could just set the flag for CI here:

ENV RUST_CONFIGURE_ARGS \
--build=x86_64-unknown-linux-gnu \
--llvm-root=/usr/lib/llvm-13 \
--enable-llvm-link-shared \
--set rust.thin-lto-import-instr-limit=10

1 similar comment
@lukas-code

This comment was marked as duplicate.

@bors bors closed this as completed in 233169f Jan 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-testsuite Area: The testsuite used to check the correctness of rustc C-enhancement Category: An issue proposing an enhancement or a PR with one. E-medium Call for participation: Medium difficulty. Experience needed to fix: Intermediate. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. T-infra Relevant to the infrastructure team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants