tags.rb: report normative tags in admonitions as errors - #263
Merged
Bill Traynor (wmat) merged 1 commit intoOct 1, 2026
Merged
Conversation
Admonitions are non-normative, so a tag inside one, or an anchor on the line just above one (which tags the admonition itself), is an error. With --failure-level=WARN, as the norm-tag builds use, this fails the build. The admonition cases in test-ch2.adoc move to tests/tags/admonition.adoc, which must fail and report each bad tag, and normative-rules.md now says admonitions cannot hold normative rules. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: David Harris <David_Harris@hmc.edu>
Jordan Carlin (jordancarlin)
approved these changes
Oct 1, 2026
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
3 participants
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.
Admonitions are non-normative, so the tags backend now reports an error for a tag inside an admonition of any type, or for an anchor on the line just above one, which tags the admonition itself. The norm-tag builds run with
--failure-level=WARN, so this fails the build. This replaces the pre-commit script proposed in riscv/riscv-isa-manual#3443, following this suggestion to put the check in the normative-rule tooling.This reverses the guidance in
normative-rules.md§4, which described how to tag admonitions. That section now says to move the text out of the admonition or drop the tag. The admonition cases intest-ch2.adocmove to a newtests/tags/admonition.adoc, which must fail and report each bad tag; the expected outputs lose those 7 rules.On riscv-isa-manual, this reports the same 37 tags as #3443's script before riscv/riscv-isa-manual#3439, and the same 4 on current
main. The ISA manual should take this submodule update only after riscv/riscv-isa-manual#3440, #3441 and #3442 merge, which remove the last 4.🤖 Generated with Claude Code