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

use standard requirements language #30

Open
thomas-fossati opened this issue Nov 16, 2023 · 4 comments · May be fixed by #48
Open

use standard requirements language #30

thomas-fossati opened this issue Nov 16, 2023 · 4 comments · May be fixed by #48

Comments

@thomas-fossati
Copy link
Contributor

Using RFC2119 terms would make it easier to grasp the level of requirements when implementing and/or testing the spec.
@danh-arm
Copy link
Contributor

I believe that is the intention. If there are examples that don't fit this then please report a specific bug or raise a PR.

@thomas-fossati
Copy link
Contributor Author

I believe that is the intention.

There are lowercase "will", "must" and "may", but I could not find any instance of capitalised MUST/SHOULD/MAY in the spec.

@danh-arm
Copy link
Contributor

OK, if this is about capitalization that's fine. I thought you meant there was general misuse of the words.

@thomas-fossati
Copy link
Contributor Author

No no, I haven't detected any misuse :-) I'm just suggesting that the prose clearly distinguishes a) what is a requirement from what isn't, and b) the requirement level. This way there is no possible ambiguity in what behaviour is expected and whether a specific behaviour is to be considered mandatory or optional.

jmarinho added a commit to jmarinho/firmware_handoff that referenced this issue Oct 17, 2024
@jmarinho
Adopt RFC2119 terms for requirements language
4805f81 
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
@jmarinho jmarinho linked a pull request Oct 17, 2024 that will close this issue
Open
jmarinho added a commit to jmarinho/firmware_handoff that referenced this issue Oct 17, 2024
@jmarinho
Adopt RFC2119 terms for requirements language
dea5d0b 
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 <jose.marinho@arm.com>
jmarinho added a commit to jmarinho/firmware_handoff that referenced this issue Oct 22, 2024
@jmarinho
Adopt RFC2119 terms for requirements language
3fef8cb 
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 <jose.marinho@arm.com>
jmarinho added a commit to jmarinho/firmware_handoff that referenced this issue Dec 28, 2024
@jmarinho
Adopt RFC2119 terms for requirements language
282c124 
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 <jose.marinho@arm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Adopt RFC2119 terms for requirements language jmarinho/firmware_handoff
2 participants
@danh-arm @thomas-fossati