From deb0a5f2ef159da50f077ae3708e415024322d1e Mon Sep 17 00:00:00 2001 From: Akihiro Suda Date: Tue, 7 Dec 2021 17:51:22 +0900 Subject: [PATCH] Mark `runc features` experimental Follow-up to PR 3296 Signed-off-by: Akihiro Suda --- README.md | 1 + docs/experimental.md | 11 +++++++++++ features.go | 1 + types/features/features.go | 1 + 4 files changed, 14 insertions(+) create mode 100644 docs/experimental.md diff --git a/README.md b/README.md index 0d701a345..e2a7b441e 100644 --- a/README.md +++ b/README.md @@ -301,6 +301,7 @@ WantedBy=multi-user.target * [Checkpoint and restore](./docs/checkpoint-restore.md) * [systemd cgroup driver](./docs/systemd.md) * [Terminals and standard IO](./docs/terminals.md) +* [Experimental features](./docs/experimental.md) ## License diff --git a/docs/experimental.md b/docs/experimental.md new file mode 100644 index 000000000..a68dd0680 --- /dev/null +++ b/docs/experimental.md @@ -0,0 +1,11 @@ +# Experimental features + +The following features are experimental and subject to change: + +- The `runc features` command (since runc v1.1.0) + +The following features were experimental in the past: + +Feature | Experimental release | Graduation release +---------------------------------------- | -------------------- | ------------------ +cgroup v2 | v1.0.0-rc91 | v1.0.0-rc93 diff --git a/features.go b/features.go index 4b496549e..c9cd15cd0 100644 --- a/features.go +++ b/features.go @@ -20,6 +20,7 @@ var featuresCommand = cli.Command{ Description: `Show the enabled features. The result is parsable as a JSON. See https://pkg.go.dev/github.com/opencontainers/runc/types/features for the type definition. + The types are experimental and subject to change. `, Action: func(context *cli.Context) error { if err := checkArgs(context, 0, exactArgs); err != nil { diff --git a/types/features/features.go b/types/features/features.go index 37fcbce21..9e463c43a 100644 --- a/types/features/features.go +++ b/types/features/features.go @@ -1,4 +1,5 @@ // Package features provides the JSON structure that is printed by `runc features` (since runc v1.1.0). +// The types in this package are experimental and subject to change. package features // Features represents the supported features of the runtime.