[ReadMe] Add Compliance Language #381
Closed
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
Add language parallel to what is in the OCI Runtime. Signed-off-by: Rob Dolin <robdolin@microsoft.com>
wking
reviewed
Oct 11, 2016
| @@ -27,6 +27,9 @@ The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SH | |||
|
|
|||
| The keywords "unspecified", "undefined", and "implementation-defined" are to be interpreted as described in the [rationale for the C99 standard][c99-unspecified]. | |||
|
|
|||
| An implementation is not compliant if it fails to satisfy one or more of the MUST, REQUIRED, or SHALL requirements. | |||
| An implementation is compliant if it satisfies all the MUST, REQUIRED, and SHALL requirements. | |||
There was a problem hiding this comment.
I think we want to follow runtime-spec more closely and:
- Use the “for the protocols it implements” language.
- Explicitly list protocols defined by this specification (the “Understanding the Specification” section below is close to this already, since defining protocols for compliance is very closely related to the current base/optional layer wording that section is currently using).
|
Agreed, we will have entire sections of the spec that are optional vs parts of sections. |
|
This SGTM. It has a whitespace that needs to be fixed also. |
|
Per discussion on today's OCI Dev ConCall, recommendation is to have more detailed language as Trevor suggests. There may be a separate issue related to manifest lists. |
|
LGTM We need to add clarifying language manifest list top matter but I have no further concerns for other objects. |
|
Moved to #432 |
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.
Add language parallel to what is in the OCI Runtime.
Signed-off-by: Rob Dolin robdolin@microsoft.com