Skip to content

Rename WARL/WLRL types to better match norm rule naming schemes#237

Merged
james-ball-qualcomm merged 1 commit intomainfrom
rename_csr_types
Mar 26, 2026
Merged

Rename WARL/WLRL types to better match norm rule naming schemes#237
james-ball-qualcomm merged 1 commit intomainfrom
rename_csr_types

Conversation

@james-ball-qualcomm
Copy link
Copy Markdown
Collaborator

No description provided.

Signed-off-by: James Ball <jameball@qti.qualcomm.com>
@james-ball-qualcomm james-ball-qualcomm self-assigned this Mar 26, 2026
Copilot AI review requested due to automatic review settings March 26, 2026 19:14
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 type values to PascalCase (LegalEnum, VarWidth, ConstMask, Other) and updated validation/rendering accordingly.
  • Updated JSON Schemas to enforce the new type values (including VarWidthwidth-parameter requirement).
  • 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.

@james-ball-qualcomm james-ball-qualcomm merged commit 80abf55 into main Mar 26, 2026
6 checks passed
@james-ball-qualcomm james-ball-qualcomm deleted the rename_csr_types branch March 26, 2026 19:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants