Deny broken intra-doc links in linkchecker by jyn514 · Pull Request #77971 · rust-lang/rust

jyn514 · 2020-10-15T13:27:01Z

Since rustdoc isn't warning about these links, check for them manually.

This also fixes the broken links that popped up from the lint.

rust-highfive · 2020-10-15T13:27:05Z

r? @Mark-Simulacrum

(rust_highfive has picked a reviewer for you, use r? to override)

jyn514 · 2020-10-15T13:27:40Z

This caught quite a lot of broken links:

Details

std/option/enum.Option.html:216: broken intra-doc link - [<code>Some(t)</code>]
std/iter/trait.DoubleEndedIterator.html:87: broken intra-doc link - [<code>Ok(())</code>]
std/iter/trait.DoubleEndedIterator.html:88: broken intra-doc link - [<code>Err(k)</code>]
std/iter/trait.DoubleEndedIterator.html:91: broken intra-doc link - [<code>Ok(())</code>]
std/ffi/struct.CStr.html:205: broken intra-doc link - [<code>&amp;str</code>]
std/ffi/struct.CStr.html:206: broken intra-doc link - [<code>&amp;str</code>]
std/ffi/struct.CString.html:355: broken intra-doc link - [<code>&amp;str</code>]
std/ffi/struct.CString.html:356: broken intra-doc link - [<code>&amp;str</code>]
std/ops/struct.RangeInclusive.html:253: broken intra-doc link - [<code>begin</code>, <code>end</code>]
std/slice/trait.SliceIndex.html:76: broken intra-doc link - [<code>begin</code>, <code>end</code>]
std/alloc/trait.AllocRef.html:68: broken intra-doc link - [<code>NonNull&lt;[u8]&gt;</code>]
std/alloc/trait.AllocRef.html:71: broken intra-doc link - [<code>NonNull&lt;[u8]&gt;</code>]
std/alloc/trait.AllocRef.html:96: broken intra-doc link - [<code>NonNull&lt;[u8]&gt;</code>]
std/alloc/trait.AllocRef.html:105: broken intra-doc link - [<code>NonNull&lt;[u8]&gt;</code>]
std/alloc/trait.AllocRef.html:148: broken intra-doc link - [<code>NonNull&lt;[u8]&gt;</code>]
std/alloc/trait.AllocRef.html:157: broken intra-doc link - [<code>NonNull&lt;[u8]&gt;</code>]
std/convert/trait.AsRef.html:30: broken intra-doc link - [<code>&amp;str</code>]
std/convert/trait.AsRef.html:31: broken intra-doc link - [<code>&amp;str</code>]
unstable-book/print.html:4209: broken intra-doc link - [<code>Default::default()</code>]
unstable-book/library-features/default-free-fn.html:170: broken intra-doc link - [<code>Default::default()</code>]
reference/print.html:298: broken intra-doc link - [<code>b</code> <code>B</code>]
reference/print.html:299: broken intra-doc link - [<code>a</code>-<code>z</code>]
reference/print.html:300: broken intra-doc link - [<code>b</code> <code>B</code>]
reference/print.html:440: broken intra-doc link - [<code>a</code>-<code>z</code> <code>A</code>-<code>Z</code>] [<code>a</code>-<code>z</code> <code>A</code>-<code>Z</code> <code>0</code>-<code>9</code> <code>_</code>]
reference/print.html:441: broken intra-doc link - [<code>a</code>-<code>z</code> <code>A</code>-<code>Z</code> <code>0</code>-<code>9</code> <code>_</code>]
reference/print.html:467: broken intra-doc link - [<code>/</code> <code>!</code>]
reference/print.html:470: broken intra-doc link - [<code>*</code> <code>!</code>]
reference/print.html:885: broken intra-doc link - [<code>0</code>-<code>1</code>]
reference/print.html:886: broken intra-doc link - [<code>0</code>-<code>7</code>]
reference/print.html:887: broken intra-doc link - [<code>0</code>-<code>9</code>]
reference/print.html:888: broken intra-doc link - [<code>0</code>-<code>9</code> <code>a</code>-<code>f</code> <code>A</code>-<code>F</code>]
reference/comments.html:172: broken intra-doc link - [<code>/</code> <code>!</code>]
reference/comments.html:175: broken intra-doc link - [<code>*</code> <code>!</code>]
reference/identifiers.html:172: broken intra-doc link - [<code>a</code>-<code>z</code> <code>A</code>-<code>Z</code>] [<code>a</code>-<code>z</code> <code>A</code>-<code>Z</code> <code>0</code>-<code>9</code> <code>_</code>]
reference/identifiers.html:173: broken intra-doc link - [<code>a</code>-<code>z</code> <code>A</code>-<code>Z</code> <code>0</code>-<code>9</code> <code>_</code>]
reference/tokens.html:459: broken intra-doc link - [<code>0</code>-<code>1</code>]
reference/tokens.html:460: broken intra-doc link - [<code>0</code>-<code>7</code>]
reference/tokens.html:461: broken intra-doc link - [<code>0</code>-<code>9</code>]
reference/tokens.html:462: broken intra-doc link - [<code>0</code>-<code>9</code> <code>a</code>-<code>f</code> <code>A</code>-<code>F</code>]
reference/notation.html:181: broken intra-doc link - [<code>b</code> <code>B</code>]
reference/notation.html:182: broken intra-doc link - [<code>a</code>-<code>z</code>]
reference/notation.html:183: broken intra-doc link - [<code>b</code> <code>B</code>]
embedded-book/print.html:4208: broken intra-doc link - [<code>std::process::Command</code>]
embedded-book/interoperability/c-with-rust.html:233: broken intra-doc link - [<code>std::process::Command</code>]
alloc/slice/trait.SliceIndex.html:34: broken intra-doc link - [<code>begin</code>, <code>end</code>]
alloc/alloc/trait.AllocRef.html:68: broken intra-doc link - [<code>NonNull&lt;[u8]&gt;</code>]
alloc/alloc/trait.AllocRef.html:71: broken intra-doc link - [<code>NonNull&lt;[u8]&gt;</code>]
alloc/alloc/trait.AllocRef.html:96: broken intra-doc link - [<code>NonNull&lt;[u8]&gt;</code>]
alloc/alloc/trait.AllocRef.html:105: broken intra-doc link - [<code>NonNull&lt;[u8]&gt;</code>]
alloc/alloc/trait.AllocRef.html:148: broken intra-doc link - [<code>NonNull&lt;[u8]&gt;</code>]
alloc/alloc/trait.AllocRef.html:157: broken intra-doc link - [<code>NonNull&lt;[u8]&gt;</code>]
error-index.html:10959: broken intra-doc link - [<code>llvm_asm</code>]
error-index.html:10969: broken intra-doc link - [<code>llvm_asm</code>]
error-index.html:10982: broken intra-doc link - [<code>llvm_asm</code>]
error-index.html:10995: broken intra-doc link - [<code>llvm_asm</code>]
error-index.html:11008: broken intra-doc link - [<code>llvm_asm</code>]
core/option/enum.Option.html:216: broken intra-doc link - [<code>Some(t)</code>]
core/iter/trait.DoubleEndedIterator.html:87: broken intra-doc link - [<code>Ok(())</code>]
core/iter/trait.DoubleEndedIterator.html:88: broken intra-doc link - [<code>Err(k)</code>]
core/iter/trait.DoubleEndedIterator.html:91: broken intra-doc link - [<code>Ok(())</code>]
core/ops/struct.RangeInclusive.html:250: broken intra-doc link - [<code>begin</code>, <code>end</code>]
core/slice/trait.SliceIndex.html:76: broken intra-doc link - [<code>begin</code>, <code>end</code>]
core/alloc/trait.AllocRef.html:68: broken intra-doc link - [<code>NonNull&lt;[u8]&gt;</code>]
core/alloc/trait.AllocRef.html:71: broken intra-doc link - [<code>NonNull&lt;[u8]&gt;</code>]
core/alloc/trait.AllocRef.html:96: broken intra-doc link - [<code>NonNull&lt;[u8]&gt;</code>]
core/alloc/trait.AllocRef.html:105: broken intra-doc link - [<code>NonNull&lt;[u8]&gt;</code>]
core/alloc/trait.AllocRef.html:148: broken intra-doc link - [<code>NonNull&lt;[u8]&gt;</code>]
core/alloc/trait.AllocRef.html:157: broken intra-doc link - [<code>NonNull&lt;[u8]&gt;</code>]
core/convert/trait.AsRef.html:30: broken intra-doc link - [<code>&amp;str</code>]
core/convert/trait.AsRef.html:31: broken intra-doc link - [<code>&amp;str</code>]
cargo/print.html:3528: broken intra-doc link - [<code>cargo rustdoc</code>]
cargo/reference/environment-variables.html:194: broken intra-doc link - [<code>cargo rustdoc</code>]
thread 'main' panicked at 'found some broken links', src/tools/linkchecker/main.rs:73:9

jyn514 · 2020-10-15T14:15:06Z

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.

Fix broken link in reference docs Found in rust-lang/rust#77971.

jyn514 · 2020-10-15T14:58:45Z

This is now blocked on a cargo update, rust-embedded/book#271 merged, and an embedded-book update. Otherwise it's ready for review though.

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>

GuillaumeGomez · 2020-10-15T15:53:46Z

Are you sure you want to run this check on html?

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.

That sounds really risky. :-/

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 · 2020-10-16T00:47:30Z

Ok, this should be ready to go now. I updated two submodules that had broken links (the commit message has a /compare url).

GuillaumeGomez · 2020-10-16T08:05:16Z

This looks good to me. Let's wait for @Mark-Simulacrum's review too.

Mark-Simulacrum · 2020-10-16T12:48:23Z

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 :)

Mark-Simulacrum · 2020-10-16T12:48:51Z

Oh, one note I wanted to make -- it look like this is now fixing links, could you update PR description?

jyn514 · 2020-10-16T12:53:12Z

Updated!

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 :)

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

jyn514 · 2020-10-16T14:05:07Z

@bors r=@Mark-Simulacrum

bors · 2020-10-16T14:05:13Z

📌 Commit b221819 has been approved by mark-simulacrum

…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.

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`

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

rust-highfive assigned Mark-Simulacrum Oct 15, 2020

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 15, 2020

jyn514 removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 15, 2020

This was referenced Oct 15, 2020
Intra-doc links do not work in markdown files #77974
Open
Fix broken link in reference docs rust-lang/cargo#8784
Merged

jyn514 force-pushed the broken-intra-doc-links branch from e3147d1 to 110fd0aCompare October 15, 2020 14:20

jyn514 mentioned this pull request Oct 15, 2020
Fix broken link to std::process::Command rust-embedded/book#271
Merged

bors added a commit to rust-lang/cargo that referenced this pull request Oct 15, 2020
Auto merge of#8784- jyn514:broken-docs, r=ehuss
79b397d
Fix broken link in reference docs Found in rust-lang/rust#77971.

jyn514 force-pushed the broken-intra-doc-links branch from 110fd0a to dd161d9Compare October 15, 2020 14:57

jyn514 changed the title ~~[WIP] deny broken intra-doc links in linkchecker~~Deny broken intra-doc links in linkcheckerOct 15, 2020

jyn514 mentioned this pull request Oct 15, 2020
Add warnings for 'intra-doc links' that weren't resolved by rustdoc deadlinks/cargo-deadlinks#60
Closed

GuillaumeGomez reviewed Oct 15, 2020
View reviewed changes

Comment threadcompiler/rustc_error_codes/src/error_codes/E0660.md Outdated

GuillaumeGomez reviewed Oct 15, 2020
View reviewed changes

Comment threadcompiler/rustc_error_codes/src/error_codes/E0661.md Outdated

GuillaumeGomez reviewed Oct 15, 2020
View reviewed changes

Comment threadcompiler/rustc_error_codes/src/error_codes/E0662.md Outdated

GuillaumeGomez reviewed Oct 15, 2020
View reviewed changes

jyn514 added 2 commits October 15, 2020 20:22

Deny broken intra-doc links in linkchecker
65835d1
Since rustdoc isn't warning about these links, check for them manually.

Update submodules for link fixes
b221819
- [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 b221819Compare October 16, 2020 00:30

jyn514 added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 16, 2020

jyn514 mentioned this pull request Oct 16, 2020
Nested brackets cause reference links to be dropped pulldown-cmark/pulldown-cmark#496
Closed

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 16, 2020

Dylan-DPC-zz mentioned this pull request Oct 16, 2020
Rollup of 10 pull requests #78019
Closed

JohnTitor mentioned this pull request Oct 16, 2020
Rollup of 10 pull requests #78024
Closed

JohnTitor mentioned this pull request Oct 16, 2020
Rollup of 10 pull requests #78028
Merged

bors merged commit 050eb4d into rust-lang:masterOct 16, 2020

rustbot added this to the 1.49.0 milestone Oct 16, 2020

ollie27 mentioned this pull request Oct 17, 2020
Update Option Documentation #78037
Closed

jyn514 mentioned this pull request Oct 17, 2020
Tracking intra-rustdoc links deadlinks/cargo-deadlinks#35
Closed

jyn514 deleted the broken-intra-doc-links branch November 7, 2020 18:19

jyn514 mentioned this pull request Nov 13, 2020
Update RELEASES.md for 1.48.0 #78364
Merged

Enselic mentioned this pull request Aug 6, 2023
linkchecker: Remove unneeded FIXME about intra-doc links #114539
Merged

Uh oh!

Uh oh!

Conversation

jyn514 commented Oct 15, 2020• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rust-highfive commented Oct 15, 2020

Uh oh!

jyn514 commented Oct 15, 2020

Uh oh!

jyn514 commented Oct 15, 2020

Uh oh!

jyn514 commented Oct 15, 2020• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GuillaumeGomezOct 15, 2020

Choose a reason for hiding this comment

Uh oh!

jyn514Oct 15, 2020

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomezOct 15, 2020

Choose a reason for hiding this comment

Uh oh!

jyn514Oct 15, 2020

Choose a reason for hiding this comment

Uh oh!

jyn514 commented Oct 16, 2020

Uh oh!

GuillaumeGomez commented Oct 16, 2020

Uh oh!

Mark-Simulacrum commented Oct 16, 2020

Uh oh!

Mark-Simulacrum commented Oct 16, 2020

Uh oh!

jyn514 commented Oct 16, 2020

Uh oh!

jyn514 commented Oct 16, 2020

Uh oh!

bors commented Oct 16, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

jyn514 commented Oct 15, 2020•
edited
Loading

jyn514 commented Oct 15, 2020•
edited
Loading