Fix two broken links in the docs - #945
Merged
Merged
Conversation
doc/tips.md links to ./doc/gimple.md, but tips.md is itself inside doc/, so the link resolves to doc/doc/gimple.md and 404s. The file sits next to it. Readme.md links to ./doc/debugging-gcc-lto.md. That file was added in 79316d4 and removed again in 79a6e4e, which replaced it with the broader doc/debugging.md; the Readme entry was not updated. The GCC LTO material is still there, as the first section of that file. CONTRIBUTING.md already refers to it as [Debugging](doc/debugging.md), so the Readme entry now matches that name.
Contributor
|
Thanks for your contribution! |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Two markdown links in the docs point at paths that do not exist. These are the only two broken relative links in the repository.
doc/tips.mdtips.mdalready lives indoc/, so./doc/gimple.mdresolves todoc/doc/gimple.md. The file it wants is right next to it.Readme.mddoc/debugging-gcc-lto.mdwas added in 79316d4 ("Split Readme even further") and removed again in 79a6e4e ("Add documentation for stdarch tests"), which introduced the broaderdoc/debugging.mdin its place. The Readme entry was not updated with it.The GCC LTO content was not lost — it is still the first section of
doc/debugging.md(## How to debug GCC LTO). Since that file now covers more than LTO, the entry is renamed rather than pointed at an anchor, which also matchesCONTRIBUTING.md:124, where the same file is already referred to as[Debugging](doc/debugging.md). The list stays in alphabetical order.How these were found
I resolved every relative markdown link in the repository against the tree. Of 167 files these were the only two that did not resolve, and after the change the same sweep reports none.
I also checked
rustc_codegen_gcc's copy insiderust-lang/rust: both links are broken there too, but since this repo is the subtree source (doc/subtree.md), fixing it here is what will carry over on the next sync.Disclosure
AI-assisted (Claude Code): the link sweep and this description were produced with the tool, and I verified the result myself before opening — I confirmed both targets are absent, traced the two commits that added and removed
debugging-gcc-lto.md, checked that the LTO section survives indoc/debugging.md, and re-ran the sweep afterwards.For transparency about scope: I read the rust-lang LLM usage policy first. Its appendix states that it applies only to
rust-lang/rustand that other repositories in the org, and subtrees, are free to set their own policies, and I did not find a policy in this repository. I am disclosing anyway rather than treating the absence of one as permission. Happy to adjust or withdraw this if you would prefer a different standard here.