Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Conform to RFC2119 specification word definitions in the the hardware spec #38

Open
jonnew opened this issue Nov 11, 2024 · 1 comment
Open

Conform to RFC2119 specification word definitions in the the hardware spec #38

jonnew opened this issue Nov 11, 2024 · 1 comment
Assignees
@jonnew @aacuevas @bparks13
Milestone
2.0

Comments

@jonnew
Copy link
Member

jonnew commented Nov 11, 2024

RFC2119 provides very practical definitions for the words MUST, MUST NOT, etc.

https://datatracker.ietf.org/doc/html/rfc2119

The hardware spec should conform to these words. This is related to our discussion of how to properly declare certain portions of the text as optional.
@jonnew jonnew added this to the 2.0 milestone Nov 11, 2024
@jonnew jonnew mentioned this issue Nov 11, 2024
Merged
@jonnew
Copy link
Member Author

jonnew commented Nov 22, 2024

This should be the last merge of V2.0. In this final PR, explanatory text and a link to the the RFC can be added to the second page of the spec. Additionally, the text should be combed for place where these words are used, or should be used.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jonnew jonnew

@aacuevas aacuevas

@bparks13 bparks13

Labels
None yet
Projects
None yet
Milestone
2.0
Development

No branches or pull requests
3 participants
@jonnew @aacuevas @bparks13