Adopt RFC2119 terms for requirements language #48
+37
−29
Conversation
This file contains 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
sjg20
reviewed
Oct 17, 2024
jmarinho
force-pushed
the
master
branch
2 times, most recently
from
817a9e5 to
74c0a3a
Compare
jmarinho
force-pushed
the
master
branch
2 times, most recently
from
dea5d0b to
3fef8cb
Compare
sjg20
previously approved these changes
Oct 29, 2024
danh-arm
requested changes
Dec 12, 2024
| @@ -33,10 +33,10 @@ stage concept. Platforms are free to adopt any other boot architecture. | |||
| Example boot architecture | |||
|
|
|||
There was a problem hiding this comment.
The RFC says:
"Authors who follow these guidelines
should incorporate this phrase near the beginning of their document:
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in
[RFC 2119](https://datatracker.ietf.org/doc/html/rfc2119).
"
So I guess we should copy a lower-case version of that to the start of this spec.
There was a problem hiding this comment.
Added the statement to the start of the Intro Section.
The IETF RFC2119 defines terms for requirements and guidance statements. This commit changes the spec to adopt those terms, where relevant, and requires future contributions to comply with RFC2119. Fix FirmwareHandoff#30 Change-Id: Ia4cc7f44bcd4508025f30d2410e83802c6ec4a11 Signed-off-by: Jose Marinho <[email protected]>
sjg20
previously approved these changes
Jan 14, 2025
danh-arm
previously approved these changes
Jan 14, 2025
|
Hi @jmarinho . If you can fix the conflict here, we can merge. |
Done. |
sjg20
approved these changes
Jan 14, 2025
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.
The IETF RFC2119 defines terms for requirements and guidance statements. This commit changes the spec to adopt those terms, where relevant, and requires future contributions to comply with RFC2119.
Fix #30
Change-Id: Ia4cc7f44bcd4508025f30d2410e83802c6ec4a11