Deny broken intra-doc links in linkchecker #77971
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jyn514
added
A-testsuite
|
(rust_highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
jyn514
removed
the
S-waiting-on-review
|
This caught quite a lot of broken links: |
This was referenced Oct 15, 2020
|
The ones in the reference seem to be intentional, they're ~EBNF and marking literals as code blocks. I'll ignore them in the linkchecker. |
jyn514
force-pushed
the
broken-intra-doc-links
branch
from
e3147d1
to
110fd0a
Compare
bors
added a commit
to rust-lang/cargo
that referenced
this pull request
Oct 15, 2020
Fix broken link in reference docs Found in rust-lang/rust#77971.
jyn514
force-pushed
the
broken-intra-doc-links
branch
from
110fd0a
to
dd161d9
Compare
jyn514
changed the title
|
This is now blocked on a cargo update, rust-embedded/book#271 merged, and an |
bors bot
added a commit
to rust-embedded/book
that referenced
this pull request
Oct 15, 2020
271: Fix broken link to std::process::Command r=therealprof a=jyn514 Intra-doc links do not yet work in markdown files; see rust-lang/rust#77974. Part of rust-lang/rust#77971. Co-authored-by: Joshua Nelson <jyn514@gmail.com>
| @@ -50,6 +53,44 @@ const LINKCHECK_EXCEPTIONS: &[(&str, &[&str])] = &[ | |||
| ("alloc/collections/btree_set/struct.BTreeSet.html", &["#insert-and-complex-keys"]), | |||
| ]; | |||
|
|
|||
| #[rustfmt::skip] | |||
| const INTRA_DOC_LINK_EXCEPTIONS: &[(&str, &[&str])] = &[ | |||
There was a problem hiding this comment.
Are you sure you want to run this check on html?
There was a problem hiding this comment.
Yes, there's no way for the linkchecker to tell if a link will be resolved by rustdoc or not. It has to look at the HTML to see whether the markdown was transformed into a link or left as-is.
There was a problem hiding this comment.
That sounds really risky. :-/
There was a problem hiding this comment.
I don't know what you mean by risky. What would be a better way? This inherently wants to look at the generated HTML, not the original, because you could have concat!( and #[doc = ...] and all sorts of other things that linkchecker doesn't and shouldn't know about.
Since rustdoc isn't warning about these links, check for them manually.
- [rust-embedded](rust-embedded/book@79ab777...ca8169e) - [cargo](rust-lang/cargo@12db56c...79b397d)
jyn514
force-pushed
the
broken-intra-doc-links
branch
from
dd161d9
to
b221819
Compare
|
Ok, this should be ready to go now. I updated two submodules that had broken links (the commit message has a |
jyn514
added
S-waiting-on-review
|
This looks good to me. Let's wait for @Mark-Simulacrum's review too. |
|
I guess this seems fine, r=me. It does feel like the sort of thing that would be better to fix in rustdoc, but I'm sure you're aware of that :) |
|
Oh, one note I wanted to make -- it look like this is now fixing links, could you update PR description? |
|
Updated!
Yeah ... I'd like to have #77200 and #77199 but the rest of the rustdoc team disagrees with me (#77276 (comment), various conversations on discord). In the meantime this should catch most of the broken links. This is still a good change even if those issues were fixed though IMO - it protects against bugs in rustdoc (and hopefully makes them easier to find). |
|
📌 Commit b221819 has been approved by |
bors
added
S-waiting-on-bors
Dylan-DPC-zz
pushed a commit
to Dylan-DPC-zz/rust
that referenced
this pull request
Oct 16, 2020
…rk-simulacrum Deny broken intra-doc links in linkchecker Since rustdoc isn't warning about these links, check for them manually. This also fixes the broken links that popped up from the lint.
JohnTitor
added a commit
to JohnTitor/rust
that referenced
this pull request
Oct 16, 2020
…rk-simulacrum Deny broken intra-doc links in linkchecker Since rustdoc isn't warning about these links, check for them manually. This also fixes the broken links that popped up from the lint.
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Oct 16, 2020
Rollup of 10 pull requests Successful merges: - rust-lang#75209 (Suggest imports of unresolved macros) - rust-lang#77547 (stabilize union with 'ManuallyDrop' fields and 'impl Drop for Union') - rust-lang#77827 (Don't link to nightly primitives on stable channel) - rust-lang#77855 (resolve: further improvements to "try using the enum's variant" diagnostic) - rust-lang#77900 (Use fdatasync for File::sync_data on more OSes) - rust-lang#77925 (Suggest minimal subset features in `incomplete_features` lint) - rust-lang#77971 (Deny broken intra-doc links in linkchecker) - rust-lang#77991 (Bump backtrace-rs) - rust-lang#77992 (instrument-coverage: try our best to not ICE) - rust-lang#78013 (Fix sidebar scroll on mobile devices) Failed merges: r? `@ghost`
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Aug 6, 2023
linkchecker: Remove unneeded FIXME about intra-doc links It was added by rust-lang#77971 but the adder [proposed](rust-lang#77971 (comment)) that the added code is a good fallback to have in case rustdoc gets buggy, and I agree. So remove the FIXME. This PR is part of rust-lang#44366 which is E-help-wanted. r? `@jyn514` since you added the FIXME `@rustbot` label T-dev-tools
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since rustdoc isn't warning about these links, check for them manually.
This also fixes the broken links that popped up from the lint.