Rename WARL/WLRL types to better match norm rule naming schemes#237
Merged
james-ball-qualcomm merged 1 commit intomainfrom Mar 26, 2026
Merged
Rename WARL/WLRL types to better match norm rule naming schemes#237james-ball-qualcomm merged 1 commit intomainfrom
james-ball-qualcomm merged 1 commit intomainfrom
Conversation
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR renames the CSR definition type discriminator values across the generators, schemas, docs, and test fixtures to better align with the normative rule naming scheme.
Changes:
- Renamed CSR
typevalues to PascalCase (LegalEnum,VarWidth,ConstMask,Other) and updated validation/rendering accordingly. - Updated JSON Schemas to enforce the new
typevalues (includingVarWidth→width-parameterrequirement). - Refreshed all YAML inputs and expected JSON/HTML/AsciiDoc outputs in tests to match the new naming.
Reviewed changes
Copilot reviewed 25 out of 25 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tools/create_params.py | Updates allowed CSR type values, VarWidth validation, and HTML type rendering strings. |
| tools/create_csr_appendix.py | Updates CSR TYPE column rendering to use new type strings and VarWidth = <param> formatting. |
| tools/README.md | Updates documentation and examples to the new CSR type naming. |
| tests/params/test-ch2.yaml | Updates CSR input YAML to use new type values. |
| tests/params/test-ch1.yaml | Updates CSR input YAML to use VarWidth. |
| tests/params/expected/test-params.json | Updates expected generated JSON to use new type values. |
| tests/params/expected/test-params.html | Updates expected generated HTML table type strings to new values. |
| tests/params/expected/test-csr-table-variants/test-csr-table-reordered/test-ch2/zort.XYZ.adoc | Updates expected AsciiDoc fragment type to ConstMask. |
| tests/params/expected/test-csr-table-variants/test-csr-table-reordered/test-ch2/qux.QQQ.adoc | Updates expected AsciiDoc fragment type to Other. |
| tests/params/expected/test-csr-table-variants/test-csr-table-reordered/test-ch2/foo.GHI.adoc | Updates expected AsciiDoc fragment type string to VarWidth = …. |
| tests/params/expected/test-csr-table-variants/test-csr-table-reordered/test-ch2/foo.ABC.adoc | Updates expected AsciiDoc fragment type to LegalEnum. |
| tests/params/expected/test-csr-table-variants/test-csr-table-reordered/test-ch1/satp.MODE.adoc | Updates expected AsciiDoc fragment type string to VarWidth = …. |
| tests/params/expected/test-csr-table-variants/test-csr-table-full-default/test-ch2/zort.XYZ.adoc | Updates expected AsciiDoc fragment type to ConstMask. |
| tests/params/expected/test-csr-table-variants/test-csr-table-full-default/test-ch2/qux.QQQ.adoc | Updates expected AsciiDoc fragment type to Other. |
| tests/params/expected/test-csr-table-variants/test-csr-table-full-default/test-ch2/foo.GHI.adoc | Updates expected AsciiDoc fragment type string to VarWidth = …. |
| tests/params/expected/test-csr-table-variants/test-csr-table-full-default/test-ch2/foo.ABC.adoc | Updates expected AsciiDoc fragment type to LegalEnum. |
| tests/params/expected/test-csr-table-variants/test-csr-table-full-default/test-ch1/satp.MODE.adoc | Updates expected AsciiDoc fragment type string to VarWidth = …. |
| tests/params/expected/test-csr-appendix-adoc-includes/test-ch2/zort.XYZ.adoc | Updates expected AsciiDoc include fragment type to ConstMask. |
| tests/params/expected/test-csr-appendix-adoc-includes/test-ch2/qux.QQQ.adoc | Updates expected AsciiDoc include fragment type to Other. |
| tests/params/expected/test-csr-appendix-adoc-includes/test-ch2/foo.GHI.adoc | Updates expected AsciiDoc include fragment type string to VarWidth = …. |
| tests/params/expected/test-csr-appendix-adoc-includes/test-ch2/foo.ABC.adoc | Updates expected AsciiDoc include fragment type to LegalEnum. |
| tests/params/expected/test-csr-appendix-adoc-includes/test-ch1/satp.MODE.adoc | Updates expected AsciiDoc include fragment type string to VarWidth = …. |
| schemas/params-schema.json | Updates VarWidth conditional logic to match renamed discriminator value. |
| schemas/param-defs-schema.json | Updates VarWidth conditional logic for input YAML schema validation. |
| schemas/param-common-schema.json | Updates the canonical CSR type enum and related schema descriptions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.