Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add runc features man page #4424

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add runc features man page #4424

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions man/runc-features.8.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
% runc-features "8"

# NAME
**runc-features** - show implemented features

# SYNOPSIS
**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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. nit: It would be better to limit the width to 79 characters or so.
  2. Add a link to runtime-spec features doc here and/or to SEE ALSO section.


# PROPERTIES
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

**ociVersionMin**: Minimum OCI version that runc can accept.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This (and below) may benefit from using a list.


**ociVersionMax**: Maximum OCI version that runc can accept.

**hooks**: List of hooks that runc supports. Consider hooks as defined stages that can run different commands.

**mountOptions**: List of available options for the runtime to mount a file system. Note that if an option is in the list, it does not necessarily mean your OS supports it.

**linux**: For runtimes that support Linux (which runc is one of), this option shows some Linux-specific properties such as namespaces, capabilities, cgroups, etc.

**annotations**: Contains arbitrary metadata about the runtime, such as the version of the runtime.

**potentiallyUnsafeConfigAnnotations**: Contains a list of values in annotations that can change the runtime's behavior. If it ends with a period, it indicates a prefix for other values.

# SEE ALSO
**runc**(8).
Loading