Major revamp of schema for WARL/WLRL#233
Merged
james-ball-qualcomm merged 6 commits intomainfrom Mar 25, 2026
Merged
Conversation
Signed-off-by: James Ball <[email protected]>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the WARL/WLRL CSR schema encoding to use a single discriminator (type) plus an optional width-parameter (only for var-width), and updates the params generator + test fixtures to match the new contract.
Changes:
- Replace CSR selector properties (
enum/width/ro-mask/ro-value) withtypeand conditionalwidth-parameterin schemas. - Update
tools/create_params.pyto validate/emit the new CSR shape and simplify CSR HTML “Type” rendering. - Update test YAML inputs and golden JSON/HTML outputs for params + normative rules.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| tools/create_params.py | Switch CSR parsing/output to type + width-parameter; update CSR HTML “Type” column rendering. |
| tools/README.md | Update documentation for new CSR encoding (but sections appear accidentally overwritten). |
| tests/params/test-ch1.yaml | Update CSR definition to new type + width-parameter form. |
| tests/params/test-ch2.yaml | Update CSR definitions to new type-based encoding. |
| tests/params/expected/test-params.json | Refresh expected params JSON for new CSR output shape. |
| tests/params/expected/test-params.html | Refresh expected params HTML CSR “Type” column output. |
| tests/norm-rule/test-ch2.yaml | Update normative-rule names/tags to match revised fixtures. |
| tests/norm-rule/test-ch2.adoc | Update normative rule text/tags used by fixtures. |
| tests/norm-rule/expected/test-norm-rules.json | Refresh expected normative-rules JSON for updated fixtures. |
| tests/norm-rule/expected/test-norm-rules.html | Refresh expected normative-rules HTML for updated fixtures. |
| tests/norm-rule/expected/test-ch2-norm-tags.json | Refresh expected extracted tag text mapping. |
| schemas/params-schema.json | Require CSR type; add conditional requirement/ban of width-parameter. |
| schemas/param-defs-schema.json | Require CSR type; add conditional requirement/ban of width-parameter. |
| schemas/param-common-schema.json | Add csrType + description helpers; remove old CSR enum/multibase definitions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
|
@james-ball-qualcomm I've opened a new pull request, #234, to work on those changes. Once the pull request is ready, I'll request review from you. |
Co-authored-by: Copilot <[email protected]> Signed-off-by: James Ball <[email protected]>
… and shared_utils.py Co-authored-by: james-ball-qualcomm <[email protected]> Agent-Logs-Url: https://github.com/riscv/docs-resources/sessions/35313467-fbb3-4500-8b67-f37fbb905423
Signed-off-by: James Ball <[email protected]>
Fix tools/README.md: restore corrupted tag_text_to_html.py and shared_utils.py sections
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.
No description provided.