-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use RFC 2119's keywords (MUST, MAY, ...)
This approach has landed in opencontainers/specs [1,2]. You can find the RFC here [3]. [1]: opencontainers/runtime-spec#256 [2]: opencontainers/runtime-spec#260 [3]: http://tools.ietf.org/html/rfc2119 Signed-off-by: W. Trevor King <[email protected]>
- Loading branch information
Showing
1 changed file
with
14 additions
and
14 deletions.
There are no files selected for viewing
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
527f3c6
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewed. Looks good to me.
527f3c6
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
527f3c6
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
MAY means OPTIONAL. So in the first example you are saying additional options are in fact optional. In the second example you are saying those semantics are optional for the log level option are optional semantics. Lower case may holds less weight.
527f3c6
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
527f3c6
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They were not saying that MAY is a generic extension mechanism. They are saying it means truly optional for the item. For extensions and whether or not the global options MUST NOT fail fast and MUST instead allow for plugins/hooks/extensions etc. to process said unknown global options... Well you just need to make that statement if that's what you want :-)
527f3c6
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IOW the language in rfc2119 around MAY include an item means the item is optional. Item is one of those legal terms. It's used for substitution. You replace the word item with your thing that is made optional by the use of the word MAY.
527f3c6
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
527f3c6
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
527f3c6
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes it makes sense. Note: The might language is simply listing options. It's not saying those are the only options or that one has be be chosen to be compliant. Thus.... the use of the term MAY is just to say it's truly optional to have a reply to field. It is not necessary to have a reply to field.