[doc,dma] Fix RANGE_REGWEN anchor in programmer's guide - #31007
Open
DanielMBouyou wants to merge 1 commit into
Open
[doc,dma] Fix RANGE_REGWEN anchor in programmer's guide#31007DanielMBouyou wants to merge 1 commit into
DanielMBouyou wants to merge 1 commit into
Conversation
The link pointed at registers.md#range_regwEN, but the heading it targets is "## RANGE_REGWEN" at registers.md:328, from which mdBook derives the anchor #range_regwen. This is the only one of the 37 registers.md links in this file that is not lowercase; three correct ones sit on the two lines immediately above. Signed-off-by: Daniel M'BOUYOU <danielmbouyou@gmail.com>
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
1 participant
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.
hw/ip/dma/doc/programmers_guide.mdline 12 links toregisters.md#range_regwEN.The heading that link targets is at
hw/ip/dma/doc/registers.mdline 328,## RANGE_REGWEN. mdBook derives anchors from heading text by lowercasing, so the anchor generated for that heading is#range_regwenand the link as written does not match it. I have not run the documentation build to observe the generated anchor; that step is stated from the heading text and from this repository's existing convention, not from a rendered page.No heading spelled that way has ever existed.
git log --all -S"regwEN" --oneline -- hw/ip/dma/doc/registers.mdreturns no commits.git grep -n "range_regwEN" HEAD -- hw/ip/dma/returns exactly one hit,hw/ip/dma/doc/programmers_guide.md:12, the line changed here.The same file gets this right everywhere else.
git show HEAD~1:hw/ip/dma/doc/programmers_guide.md | grep -o "registers\.md#[A-Za-z_0-9-]*"yields 37 links, of which 36 are entirely lowercase and this was the only one that was not. Three of the correct ones sit on the two lines immediately above, lines 10 and 11:#enabled_memory_range_base,#enabled_memory_range_limitand#range_valid.The link was introduced in 775fcef, "[hw,dma,doc] Add DMA programmers guide".
Nothing was built, rendered, simulated or synthesised for this change.
Spotted, not fixed
Two further cases of the same kind, untouched here. I am happy to send them separately if you would like them.
hw/ip/csrng/doc/programmers_guide.mdlines 42, 70 and 114 link todata/csrng.hjson, a path underdoc/that has never existed; the same three registers are linked correctly throughregisters.md#...a few lines above, on lines 37, 39, 68 and 108.hw/ip/entropy_src/doc/theory_of_operation.mdlines 74, 120 and 176 carry a stray trailing slash,programmers_guide.md/#...andinterfaces.md/#.... That file also carries a second, separate defect, anchors in the legacy Hugo format, so it needs a wider fix than this one.