config: Replace "SHOULD consider" for 'rootfs' path value #847
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
|
LGTM |
wking
commented
May 31, 2017
config.md
Outdated
| @@ -29,7 +29,8 @@ For example, if a configuration is compliant with version 1.1 of this specificat | |||
| **`root`** (object, REQUIRED) specifies the container's root filesystem. | |||
|
|
|||
| * **`path`** (string, OPTIONAL) Specifies the path to the root filesystem for the container. The path is either an absolute path or a relative path to the bundle. | |||
| Users SHOULD consider using a conventional name, such as `rootfs`. | |||
|
|
|||
| The value SHOULD be the conventional `rootfs`. | |||
There was a problem hiding this comment.
Neither the old nor the new wording applies to Windows (since #849, because rootfs is not a GUID path). I address that in the in-flight #838, and am leaving it alone here since it seems orthogonal to dropping “consider”. If folks do want me to address the “does not apply to Windows” issue in this PR as well, I'm happy to pull over some of the #838 wording to do that.
SHOULD means that [1]: ... there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course. So consideration is already baked into the definition, and we can just say "SHOULD be" and warn folks whenever they use a value other than 'rootfs'. Also move this under the non-Windows conditions, because the advice they doesn't apply to Windows where the value MUST be a volume GUID path (since 2283e63, Windows: Remove Sandbox, additional tweaks, 2017-05-23, opencontainers#849). [1]: https://tools.ietf.org/html/rfc2119#section-3 Signed-off-by: W. Trevor King <wking@tremily.us>
|
LGTM |
1 similar comment
|
LGTM |
Merged
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.
SHOULD means:
So consideration is already baked into the definition, and we can just say “SHOULD be” and warn folks whenever they use a value other than
rootfs.Also break this into its own paragraph, because the value recommendation is orthogonal to and less important than the value semantics covered in the preceding sentences.