Tags backend doesn't allow output file name to be controlled from ISA manual Makefile #54
Conversation
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
Added tags-output-suffix and renamed tags-prefix to tags-match-prefix. Signed-off-by: james-ball-qualcomm <[email protected]>
james-ball-qualcomm
pushed a commit
to RISC-V-Certification-Steering-Committee/riscv-isa-manual
that referenced
this pull request
Jul 23, 2025
…e in a later commit. Also changed Makefile to build tags when building other artifacts (i.e., html, PDF, EPUB) because I'll be adding a Ruby gem to check the tags against expected tags (in the future) and to change names to clarify that the tags backend is being using to extract normative rule tags. The same backend with a different prefix could extract other tags if needed someday (so I'm future proofing). Also need to use latest version of docs-resources submodule to get the tags converter backend. This commit requires changes to the tags.rb script in the docs-resources I just made to work. See issue riscv/docs-resources#54
This was referenced Jul 23, 2025
Collaborator
|
Good point! |
james-ball-qualcomm
deleted the
53-tags-backend-doesnt-allow-output-file-name-to-be-controlled-from-isa-manual-makefile
branch
james-ball-qualcomm
added a commit
to RISC-V-Certification-Steering-Committee/riscv-isa-manual
that referenced
this pull request
Sep 8, 2025
…uals that CTP (Certification Test Plans) will use to have tests link back to the standards. See ISA manual issue 1397 for a lengthy discussion on the topic.
Merge branch 'riscv:main' into main
Merge remote-tracking branch 'upstream/main'
Started adding anchors for I-extension normative rules.
Finished initial attempt at adding anchors for normative rules for RV32I (Chapter 2. RV32I Base Integer Instruction Set)
Changes after comparing to Jamie's norm rule spreadsheet.
Added normative rule anchors ("norm:" prefix) for RV32I. RV64I to come in a later commit. Also changed Makefile to build tags when building other artifacts (i.e., html, PDF, EPUB) because I'll be adding a Ruby gem to check the tags against expected tags (in the future) and to change names to clarify that the tags backend is being using to extract normative rule tags. The same backend with a different prefix could extract other tags if needed someday (so I'm future proofing). Also need to use latest version of docs-resources submodule to get the tags converter backend. This commit requires changes to the tags.rb script in the docs-resources I just made to work. See issue riscv/docs-resources#54
Merge branch 'riscv:main' into main
Merge branch 'main' into 2-add-adoc-anchors-required-by-i-extension-normative-rules
Removing trailing whitespace detected by pre-commit check
Missed a couple of trailing whitespace lines
Merge pull request #3 from RISC-V-Certification-Steering-Committee/2-add-adoc-anchors-required-by-i-extension-normative-rules
Add adoc anchors required by RV32I normative rules
Fixes issue #5
Merge pull request #6 from RISC-V-Certification-Steering-Committee/5-update-isa-manual-to-use-latest-doc-resources-submodule-with-tagsrb-enhancement
Update ISA manual to use latest doc-resources submodule with tags.rb enhancement
Rename norm:inst:fence.tso:operation to norm:inst:fence_tso:operation to work around bug reported in riscv/docs-resources#55
Renaming fence.tso anchors to fence-tso to workaround adoc restriction. Also reverted normative rule instruction encoding anchors to using [[]] syntax since [#]## syntax misleading.
Change anchored text for norm:basegrp:all:imm_always_sex to include text at beginning of sentence to match David Harris test plan.
Added normative rule tags for RV64I. Fixed name of rv32i/rv64i xregwidth (base not basegrp).
Rename rv64i norm rules that just had rv64
fixed ld rv64i op
Fixing missing # at end of norm rule tag for norm:inst:lwu:rv64i_operation
rename norm rule tag for lwu to operation and not rv64i_operation since it is already an rv64i instruction
fixing more typos in norm rule tags
Merge branch 'riscv:main' into main
Starting adding normative rule tags for the M-mode chapter.
Merge branch 'main' of https://github.com/RISC-V-Certification-Steering-Committee/riscv-isa-manual into 7-add-normative-rule-tags-for-Sm-ext
removed trailing whitespace in machine.adoc
Merge pull request #9 from RISC-V-Certification-Steering-Committee/7-add-normative-rule-tags-for-Sm-ext
Adding normative rule tags for M-mode chapter
Had to move normative statement outside of figure name to be able to tag it.
Merge pull request #10 from RISC-V-Certification-Steering-Committee/7-add-normative-rule-tags-for-Sm-ext
Had to move normative statement outside of figure name to be able to tag it
fix: update param norm rules to remove extension name
Merge pull request #12 from RISC-V-Certification-Steering-Committee/7-add-normative-rule-tags-for-Sm-ext
fix: update param norm rules to remove extension name
Had to add normative rule tags for Zilsd ld/sd since RV64I also has these instructions
whitespace
Merge branch 'main' into 7-add-normative-rule-tags-for-Sm-ext
Merge pull request #13 from RISC-V-Certification-Steering-Committee/7-add-normative-rule-tags-for-Sm-ext
Had to add normative rule tags for Zilsd ld/sd since RV64I also has these instructions
normative rule tag for norm:csr:mstatush:sz_rw_rv32 had formating issue
Merge branch '7-add-normative-rule-tags-for-Sm-ext' of https://github.com/RISC-V-Certification-Steering-Committee/riscv-isa-manual into 7-add-normative-rule-tags-for-Sm-ext
Merge pull request #14 from RISC-V-Certification-Steering-Committee/7-add-normative-rule-tags-for-Sm-ext
Had to fix formatting issue with norm rule tag in machine.adoc
Fixed norm rule tag name for division not following naming scheme
Merge pull request #15 from RISC-V-Certification-Steering-Committee/7-add-normative-rule-tags-for-Sm-ext
Fixed norm rule tag name for division not following naming scheme
Merge pull request riscv#2195 from RISC-V-Certification-Steering-Committee/main
Add normative rule tags for RV32I and RV64I base ISAs
Added documentation on how to tag normative rules
Removing trailing whitespace
Adding empty line at end of file
Normative rule curation Ruby script can parse command-line options and Makefile can call it properly.
clarify prohibition on memory access by SS instructions (riscv#2236)
Add Svrsw60t59b Extension (riscv#2241)
Remove a few dangling RV128 references (riscv#2244)
* Remove RV128 references from pointer-masking chapter
* Remove RV128 references from C chapter
Fix typo in colophon.adoc (riscv#2246)
Files to create curated normative rules (rv32.yaml and rv64.yaml) now working with new Ruby script in docs-resources. Updated Makefile to build norm-rules.json.
Using updated version of docs-resources with the new Ruby script
Accidentally checked in rv32.yaml and rv64.yaml in the wrong directory. Also added README.md in directory where they belong.
Fixed link to doc in docs-resources related to normative rules now that it is checked into main.
Accidental checkin of Ruby script (deleted)
Merge branch 'riscv:main' into 21-create-yaml-files-for-norm-rules
Finished adding norm rule curations for rv32i
Merge branch '21-create-yaml-files-for-norm-rules' of https://github.com/RISC-V-Certification-Steering-Committee/riscv-isa-manual into 21-create-yaml-files-for-norm-rules
Added remaining norm rule YAML files for tags I added to chapters.
Ooops. Test tag (norm:chubby) was accidentally committed.
Missed adding YAML curation for 2 normative rule tags
More fixes/additions to RVI20 norm rule tags
And fixing more norm rule tag names
Switch from curation to creation.
Remove trailing whitespace
Moved normative_rules_def directory parallel to src.
Renamed schema file. Still need to create it.
Merge remote-tracking branch 'origin/19-document-tagging-normative-rules-in-isa-manuals' into 21-create-yaml-files-for-norm-rules
Switch from special norm:enc:insttable:<instname> format to norm:inst:<instname>:enc format now that there is metadata in the def YAML files. Also, fix Makefile dependences for building norm rules.
Forgot to delete this.
Added schema file for norm rule def YAML files and fixed terminology in README.md
Improvements to schema file, created common file for shared content, and created norm-rules.json schema file. These schema files probably should be in the docs-resources repo and not here.
Schema files moved into docs-resources
Renamed norm rules and tags to match new naming scheme agreed to with David Harris
Messed up some of the renames and now fixed.
Signed-off-by: James Ball <[email protected]>
tariqkurd-repo
pushed a commit
to tariqkurd-repo/riscv-cheri
that referenced
this pull request
Dec 3, 2025
…e in a later commit. Also changed Makefile to build tags when building other artifacts (i.e., html, PDF, EPUB) because I'll be adding a Ruby gem to check the tags against expected tags (in the future) and to change names to clarify that the tags backend is being using to extract normative rule tags. The same backend with a different prefix could extract other tags if needed someday (so I'm future proofing). Also need to use latest version of docs-resources submodule to get the tags converter backend. This commit requires changes to the tags.rb script in the docs-resources I just made to work. See issue riscv/docs-resources#54
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.
Fixed #53
Added tags-output-suffix and renamed tags-prefix to tags-match-prefix.
Enhancement of PR #47 from @Timmmm