Use RFC_2119 style for config.md #444
Merged
Conversation
This file contains hidden or 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
Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
| This SHOULD only be set if **`platform.os`** is `linux`. | ||
| * **`solaris`** (object, optional) [Solaris-specific configuration](config-solaris.md). | ||
| This should only be set if **`platform.os`** is `solaris`. | ||
| This SHOULD only be set if **`platform.os`** is `solaris`. |
Contributor
There was a problem hiding this comment.
Maybe the pattern here should be “This MUST NOT be set if platform.os is not $OS”? If you're writing a Linux config, you should not be setting solaris, but whether you set linux or not is up to you.
Member
There was a problem hiding this comment.
I can't say that yet. Solaris has some linux compatibility modes. It could actually be feasible to have a Linux container that provides solaris configurations as well, IIUC
Member
|
LGTM |
1 similar comment
Member
|
LGTM |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Signed-off-by: Qiang Huang h.huangqiang@huawei.com