Skip to content

bootstrap: document how to reproduce broken intra-doc links locally #109190

Open
@peter-lyons-kehl

Description

@peter-lyons-kehl

Neither x test tidy --bless, nor x test tidy --doc, report incorrect links from /// rustdocs. Example:

  1. Incorrect/unregistered markdown link shortcut, and/or broken intradoc code link:
    https://github.com/rust-lang/rust/actions/runs/4429807104/jobs/7770725259#step:26:2652
     |     /// Like [from_iter], but coallocation-aware.
     |               ^^^^^^^^^ no item named `from_iter` in scope
     |
     = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
     = note: `-D rustdoc::broken-intra-doc-links` implied by `-D warnings`
  1. URLs not made into links:
    https://github.com/rust-lang/rust/actions/runs/4429807104/jobs/7770725259#step:26:2704
49 | /// Workaround https://github.com/rust-lang/rust/issues/108751
   |                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://github.com/rust-lang/rust/issues/108751>`

Please, either

  • make (local) tidy report the above, or
  • add steps (to the documentation) on how to check the above locally.

Side notes

Thank you in advance.

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsA-intra-doc-linksArea: Intra-doc links, the ability to link to items in docs by nameT-bootstrapRelevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions