From 5669ffb3544fd398a280c0adb3c445e1375a752e Mon Sep 17 00:00:00 2001 From: Paul Holzinger Date: Wed, 23 Mar 2022 19:03:08 +0100 Subject: document that using libpod package directly is not supported We do not support using the libpod package outside of podman. There is no stable interface which can be used. Instead point users to the API and go bindings. Fixes #13086 Signed-off-by: Paul Holzinger --- libpod/container_path_resolution.go | 1 - libpod/doc.go | 11 +++++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 libpod/doc.go diff --git a/libpod/container_path_resolution.go b/libpod/container_path_resolution.go index 7db23b783..80a3749f5 100644 --- a/libpod/container_path_resolution.go +++ b/libpod/container_path_resolution.go @@ -1,4 +1,3 @@ -// +linux package libpod import ( diff --git a/libpod/doc.go b/libpod/doc.go new file mode 100644 index 000000000..948153181 --- /dev/null +++ b/libpod/doc.go @@ -0,0 +1,11 @@ +// The libpod library is not stable and we do not support use cases outside of +// this repository. The API can change at any time even with patch releases. +// +// If you need a stable interface Podman provides a HTTP API which follows semver, +// please see https://docs.podman.io/en/latest/markdown/podman-system-service.1.html +// to start the api service and https://docs.podman.io/en/latest/_static/api.html +// for the API reference. +// +// We also provide stable go bindings to talk to the api service from another go +// program, see the pkg/bindings directory. +package libpod -- cgit v1.2.3-54-g00ecf