feat: update terminology from RFC2119 to BCP14#257
Open
1456055067 wants to merge 2 commits intoietf-tools:v3from
Open
feat: update terminology from RFC2119 to BCP14#2571456055067 wants to merge 2 commits intoietf-tools:v3from
1456055067 wants to merge 2 commits intoietf-tools:v3from
Conversation
Changes user-facing messages and validation logic to reference BCP14 instead of RFC2119, as BCP14 encompasses both RFC2119 and RFC8174. Changes: - Updated all error/warning messages to say "BCP14" instead of "RFC2119" - Updated JSDoc comments to reference BCP14 - Fixed XML validation to check for RFC2119, RFC8174, or BCP14 references - Added new warning (PREFER_BCP14_REF) when documents reference only RFC2119/RFC8174 without BCP14 - Updated all test expectations to match new message text Fixes ietf-tools#210
NGPixel
approved these changes
Feb 15, 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
2 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.
Summary
Updates all user-facing error messages and validation logic to reference BCP14 instead of RFC2119, as BCP14 encompasses both RFC 2119 and RFC 8174.
Changes Made
1. Message Updates
2. Enhanced Reference Checking
externalEntitiesfor all three reference types (previously only checked RFC2119)3. New Warning:
PREFER_BCP14_REFWhen a document uses RFC2119/RFC8174 keywords and references, but doesn't reference BCP14, the validator now warns:
This encourages best practices while not breaking existing documents.
4. Test Updates
Addresses Issue #210
Per rjsparks' comment, this PR tackles:
✅ Updating user-facing messages to reference BCP14
✅ Fixing code constructs that check references
✅ Warning when BCP14 reference is missing
Testing
All 50 keyword validation tests pass. The full test suite shows only pre-existing failures unrelated to these changes.
Fixes #210