Repository navigation
[rtl,doc,dv,syn] Fix typos in comments and docs - #2579
Open
mondalsushant wants to merge 1 commit into
Open
mondalsushant wants to merge 1 commit into
mondalsushant wants to merge 1 commit into
Conversation
Misspelled register names (mepc, mseccfg) and a wrong CSR name for address 0x757 (mseccfgh) in the docs made them inconsistent with the RTL and cs_registers.rst, which could mislead readers searching for these names. The remaining typos make comments harder to read and to grep for. Fix these across rtl, doc, dv, syn, shared, examples, and ibex_configs.yaml. Only comments, documentation, and one debug string change, so there is no functional change. Signed-off-by: Sushant Mondal <contact@sushantmondal.com>
|
All contributors have signed the CLA ✍️ ✅ |
Author
|
I have read the CLA Document. By submitting this pull request comment, I am hereby confirming my acceptance of the terms of the CLA Document and my agreement to be legally bound by its terms. |
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
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.
Misspelled register names (
mepc,mseccfg) and a wrong CSR name for address0x757(mseccfgh) in the docs made them inconsistent with the RTL andcs_registers.rst, which could mislead readers searching for these names. The remaining typos make comments harder to read and to grep for.Fix these across
rtl,doc,dv,syn,shared,examples, andibex_configs.yaml. Only comments, documentation, and one debug string change, so there is no functional change.Follow-up:
dv/uvm/core_ibex/directed_tests/pmp_mseccfg_test/pmp_mseccfg_test.S:151still has the typoinstsr("boundary instsr as uncompressed", likely meantinstr/instruction). I left it out of this commit on purpose, because I could be wrong. It can go in an amend.