Added WARL/WLRL CSR AsciiDoc appendix include files like already have for parameters#235
Merged
james-ball-qualcomm merged 5 commits intomainfrom Mar 25, 2026
Merged
Added WARL/WLRL CSR AsciiDoc appendix include files like already have for parameters#235james-ball-qualcomm merged 5 commits intomainfrom
james-ball-qualcomm merged 5 commits intomainfrom
Conversation
… for parameters Signed-off-by: James Ball <jameball@qti.qualcomm.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a CSR appendix generator that mirrors the existing parameter appendix workflow, producing per-CSR AsciiDoc row fragments and higher-level include files driven by a CSR table-layout YAML.
Changes:
- Introduces
tools/create_csr_appendix.pyplusschemas/csr-table-schema.jsonand a default CSR table layout YAML. - Refactors shared appendix-generation helpers into
tools/appendix_shared_utils.pyand updatescreate_param_appendix.pyto use it. - Extends Makefile-based golden-output testing to cover CSR appendix generation and table-layout variants.
Reviewed changes
Copilot reviewed 60 out of 60 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| tools/default_csr_table.yaml | Adds default CSR table column layout/widths. |
| tools/create_param_appendix.py | Switches to shared appendix helper utilities. |
| tools/create_csr_appendix.py | New CSR appendix generator producing per-CSR fragments and include files. |
| tools/appendix_shared_utils.py | New shared helpers for appendix generators (filename, header, cols spec, norm-rule inference). |
| tools/README.md | Documents the new CSR appendix generator CLI and outputs. |
| tests/params/test-csr-table-reordered.yaml | Test CSR table layout variant (reordered columns). |
| tests/params/test-csr-table-minimal.yaml | Test CSR table layout variant (minimal columns). |
| tests/params/test-csr-table-full-default.yaml | Test CSR table layout variant matching defaults. |
| tests/params/test-csr-appendix.adoc | Test harness AsciiDoc that includes generated CSR appendix outputs. |
| tests/params/expected/test-csr-table-variants/test-csr-table-reordered/test-ch2/zort.XYZ.adoc | Golden expected CSR row fragment (reordered variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-reordered/test-ch2/wlrl_csrs.adoc | Golden expected per-category include (reordered variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-reordered/test-ch2/warl_csrs.adoc | Golden expected per-category include (reordered variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-reordered/test-ch2/qux.QQQ.adoc | Golden expected CSR row fragment (reordered variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-reordered/test-ch2/foo.GHI.adoc | Golden expected CSR row fragment (reordered variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-reordered/test-ch2/foo.ABC.adoc | Golden expected CSR row fragment (reordered variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-reordered/test-ch2/all_csrs.adoc | Golden expected chapter-level include (reordered variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-reordered/test-ch1/warl_csrs.adoc | Golden expected per-category include (reordered variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-reordered/test-ch1/satp.MODE.adoc | Golden expected CSR row fragment (reordered variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-reordered/test-ch1/all_csrs.adoc | Golden expected chapter-level include (reordered variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-reordered/all_csrs_by_chapter.adoc | Golden expected top-level by-chapter table include (reordered variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-reordered/all_csrs_a_to_z.adoc | Golden expected top-level A–Z table include (reordered variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-minimal/test-ch2/zort.XYZ.adoc | Golden expected CSR row fragment (minimal variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-minimal/test-ch2/wlrl_csrs.adoc | Golden expected per-category include (minimal variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-minimal/test-ch2/warl_csrs.adoc | Golden expected per-category include (minimal variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-minimal/test-ch2/qux.QQQ.adoc | Golden expected CSR row fragment (minimal variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-minimal/test-ch2/foo.GHI.adoc | Golden expected CSR row fragment (minimal variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-minimal/test-ch2/foo.ABC.adoc | Golden expected CSR row fragment (minimal variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-minimal/test-ch2/all_csrs.adoc | Golden expected chapter-level include (minimal variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-minimal/test-ch1/warl_csrs.adoc | Golden expected per-category include (minimal variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-minimal/test-ch1/satp.MODE.adoc | Golden expected CSR row fragment (minimal variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-minimal/test-ch1/all_csrs.adoc | Golden expected chapter-level include (minimal variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-minimal/all_csrs_by_chapter.adoc | Golden expected top-level by-chapter table include (minimal variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-minimal/all_csrs_a_to_z.adoc | Golden expected top-level A–Z table include (minimal variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-full-default/test-ch2/zort.XYZ.adoc | Golden expected CSR row fragment (full-default variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-full-default/test-ch2/wlrl_csrs.adoc | Golden expected per-category include (full-default variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-full-default/test-ch2/warl_csrs.adoc | Golden expected per-category include (full-default variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-full-default/test-ch2/qux.QQQ.adoc | Golden expected CSR row fragment (full-default variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-full-default/test-ch2/foo.GHI.adoc | Golden expected CSR row fragment (full-default variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-full-default/test-ch2/foo.ABC.adoc | Golden expected CSR row fragment (full-default variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-full-default/test-ch2/all_csrs.adoc | Golden expected chapter-level include (full-default variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-full-default/test-ch1/warl_csrs.adoc | Golden expected per-category include (full-default variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-full-default/test-ch1/satp.MODE.adoc | Golden expected CSR row fragment (full-default variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-full-default/test-ch1/all_csrs.adoc | Golden expected chapter-level include (full-default variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-full-default/all_csrs_by_chapter.adoc | Golden expected top-level by-chapter table include (full-default variant). |
| tests/params/expected/test-csr-table-variants/test-csr-table-full-default/all_csrs_a_to_z.adoc | Golden expected top-level A–Z table include (full-default variant). |
| tests/params/expected/test-csr-appendix.adoc | Golden expected top-level CSR appendix include harness. |
| tests/params/expected/test-csr-appendix-adoc-includes/test-ch2/zort.XYZ.adoc | Golden expected generated CSR fragment (default CSR appendix run). |
| tests/params/expected/test-csr-appendix-adoc-includes/test-ch2/wlrl_csrs.adoc | Golden expected per-category include (default CSR appendix run). |
| tests/params/expected/test-csr-appendix-adoc-includes/test-ch2/warl_csrs.adoc | Golden expected per-category include (default CSR appendix run). |
| tests/params/expected/test-csr-appendix-adoc-includes/test-ch2/qux.QQQ.adoc | Golden expected generated CSR fragment (default CSR appendix run). |
| tests/params/expected/test-csr-appendix-adoc-includes/test-ch2/foo.GHI.adoc | Golden expected generated CSR fragment (default CSR appendix run). |
| tests/params/expected/test-csr-appendix-adoc-includes/test-ch2/foo.ABC.adoc | Golden expected generated CSR fragment (default CSR appendix run). |
| tests/params/expected/test-csr-appendix-adoc-includes/test-ch2/all_csrs.adoc | Golden expected chapter include (default CSR appendix run). |
| tests/params/expected/test-csr-appendix-adoc-includes/test-ch1/warl_csrs.adoc | Golden expected per-category include (default CSR appendix run). |
| tests/params/expected/test-csr-appendix-adoc-includes/test-ch1/satp.MODE.adoc | Golden expected generated CSR fragment (default CSR appendix run). |
| tests/params/expected/test-csr-appendix-adoc-includes/test-ch1/all_csrs.adoc | Golden expected chapter include (default CSR appendix run). |
| tests/params/expected/test-csr-appendix-adoc-includes/all_csrs_by_chapter.adoc | Golden expected top-level by-chapter include (default CSR appendix run). |
| tests/params/expected/test-csr-appendix-adoc-includes/all_csrs_a_to_z.adoc | Golden expected top-level A–Z include (default CSR appendix run). |
| schemas/csr-table-schema.json | New JSON Schema for CSR table layout YAML files. |
| Makefile | Adds build/compare/update test targets for CSR appendix generation and table variants. |
💡 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, #236, to work on those changes. Once the pull request is ready, I'll request review from you. |
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
Co-authored-by: james-ball-qualcomm <140646808+james-ball-qualcomm@users.noreply.github.com> Agent-Logs-Url: https://github.com/riscv/docs-resources/sessions/97879fc1-cfcc-4840-9ac8-a85f60aa5b19
Validate `category` field before use as dict key in CSR appendix generation
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.