bundle: Move 'rootfs' recommendation to config.md #839
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
Anyone setting 'rootfs.path' should be aware of this advice,
regardless of whether they're the ones composing the bundle or not.
Use the RFC 2119 "SHOULD" (vs. the old lowercase "should") for this
recommendation. The SHOULD semantics make sense and using SHOULD
avoids confusing readers ("did they mean to SHOULD this?").
Also drop the "While the name of this directory may be arbitrary"
caveat, because SHOULD already implies "but you can pick another
directory name if you want".
Note that the "MUST be present in a single directory" line which is
still in bundle.md forbids you from picking "foo/bar", "../foo", or
other paths that do not point at a direct child of the bundle
directory. I don't like that direct-child restriction [1], but I'm
not touching it in this commit.
[1]: opencontainers#469
Signed-off-by: W. Trevor King <[email protected]>
|
LGTM |
1 similar comment
|
LGTM |
mrunalp
approved these changes
May 22, 2017
This was referenced May 22, 2017
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.
Anyone setting 'rootfs.path' should be aware of this advice, regardless of whether they're the ones composing the bundle or not.
Use the RFC 2119 “SHOULD” (vs. the old lowercase “should”) for this recommendation. The SHOULD semantics make sense and using SHOULD avoids confusing readers (“did they mean to SHOULD this?”).
Also drop the “While the name of this directory may be arbitrary” caveat, because SHOULD already implies “but you can pick another directory name if you want”.
Note that the “MUST be present in a single directory” line which is still in
bundle.mdforbids you from pickingfoo/bar,../foo, or other paths that do not point at a direct child of the bundle directory. I don't like that direct-child restriction, but I'm not touching it in this commit.