Skip to content

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

Closed

Description

@QuietMisdreavus

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.

Activity

  1. added
    T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
    on Apr 19, 2018
  2. GuillaumeGomez commented on Apr 19, 2018

    @GuillaumeGomez
    Member

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

  3. QuietMisdreavus commented on Apr 20, 2018

    @QuietMisdreavus
    ContributorAuthor

    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.

  4. GuillaumeGomez commented on Apr 21, 2018

    @GuillaumeGomez
    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...).

  5. QuietMisdreavus commented on Jun 23, 2018

    @QuietMisdreavus
    ContributorAuthor

    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?

  6. GuillaumeGomez commented on Jun 23, 2018

    @GuillaumeGomez
    Member

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

  7. added a commit that references this issue on Jul 5, 2018
    00f4972
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

T-rustdocRelevant to the rustdoc 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