add runc features man page #4424
Open
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
kolyshkin
reviewed
Oct 2, 2024
kolyshkin
reviewed
Oct 2, 2024
man/runc-features.8.md
Outdated
|
|
||
| # DESCRIPTION | ||
| The **features** command show enabled features. If you don't know what | ||
| is feature you can check feature's section in runtime-spec in github. |
There was a problem hiding this comment.
This sounds condescending to a reader. It's better to give a brief overview and refer to more documentation.
There was a problem hiding this comment.
sure. i'm gonna explain features a little bit and provide more documentation
AkihiroSuda
reviewed
Oct 3, 2024
amghazanfari
force-pushed
the
man_features
branch
from
8b73bf8
to
660c816
Compare
Co-authored-by: Akihiro Suda <[email protected]> Signed-off-by: Amir M. Ghazanfari <[email protected]>
amghazanfari
force-pushed
the
man_features
branch
from
660c816
to
f6e2bf3
Compare
kolyshkin
reviewed
Oct 6, 2024
| **runc features** | ||
|
|
||
| # DESCRIPTION | ||
| The **features** command shows the implemented features in JSON format. Features are properties of runc, such as the minimum and maximum accepted OCI versions. The implemented features may not always be available, depending on the kernel version, system libraries, CPU architecture, etc. For more information about features, you can check the features section in the runtime-spec on GitHub. |
There was a problem hiding this comment.
- nit: It would be better to limit the width to 79 characters or so.
- Add a link to runtime-spec features doc here and/or to SEE ALSO section.
kolyshkin
reviewed
Oct 6, 2024
| # DESCRIPTION | ||
| The **features** command shows the implemented features in JSON format. Features are properties of runc, such as the minimum and maximum accepted OCI versions. The implemented features may not always be available, depending on the kernel version, system libraries, CPU architecture, etc. For more information about features, you can check the features section in the runtime-spec on GitHub. | ||
|
|
||
| # PROPERTIES |
There was a problem hiding this comment.
A man header with such name is not standard. Please see man-pages(7) for which sections are recommended. In general, I think, what's below is part of description and doesn't require a separate section.
kolyshkin
reviewed
Oct 6, 2024
| The **features** command shows the implemented features in JSON format. Features are properties of runc, such as the minimum and maximum accepted OCI versions. The implemented features may not always be available, depending on the kernel version, system libraries, CPU architecture, etc. For more information about features, you can check the features section in the runtime-spec on GitHub. | ||
|
|
||
| # PROPERTIES | ||
| **ociVersionMin**: Minimum OCI version that runc can accept. |
There was a problem hiding this comment.
This (and below) may benefit from using a list.
kolyshkin
reviewed
Oct 6, 2024
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.
In this pr i put man page for runc-features.