Skip to content

Check Rustdoc warnings for the compiler in PR CI #106624

Closed

Description

@Noratrieb

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.

Activity

  1. added
    C-enhancementCategory: An issue proposing an enhancement or a PR with one.
    T-infraRelevant to the infrastructure team, which will review and decide on the PR/issue.
    on Jan 9, 2023
  2. changed the title [-]Check docs CI[/-] [+]Check docs in CI[/+] on Jan 9, 2023
  3. albertlarsan68 commented on Jan 9, 2023

    @albertlarsan68
    Member

    @rustbot claim

  4. the8472 commented on Jan 9, 2023

    @the8472
    Member

    But ./x test linkchecker already runs in PR CI

  5. jyn514 commented on Jan 10, 2023

    @jyn514
    Member

    cc #106117

    maybe linkchecker is missing some cases?

  6. Noratrieb commented on Jan 10, 2023

    @Noratrieb
    MemberAuthor

    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)

  7. jyn514 commented on Jan 10, 2023

    @jyn514
    Member

    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.

  8. added
    A-testsuiteArea: The testsuite used to check the correctness of rustc
    E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.
    E-mediumCall for participation: Medium difficulty. Experience needed to fix: Intermediate.
    on Jan 10, 2023
  9. changed the title [-]Check docs in CI[/-] [+]Check Rustdoc warnings for the compiler in PR CI[/+] on Jan 10, 2023
  10. lukas-code commented on Jan 11, 2023

    @lukas-code
    Contributor

    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

  11. lukas-code commented on Jan 11, 2023

    @lukas-code
  12. added a commit that references this issue on Jan 14, 2023
    233169f
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

A-testsuiteArea: The testsuite used to check the correctness of rustcC-enhancementCategory: An issue proposing an enhancement or a PR with one.E-mediumCall for participation: Medium difficulty. Experience needed to fix: Intermediate.E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.T-infraRelevant to the infrastructure team, which will review and decide on the PR/issue.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions