summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Holzinger <pholzing@redhat.com>2022-03-23 19:03:08 +0100
committerPaul Holzinger <pholzing@redhat.com>2022-03-23 19:05:29 +0100
commit5669ffb3544fd398a280c0adb3c445e1375a752e (patch)
tree78cdeeb2ae3a1ebbdb20d03fb3bb7c6328faf4e3
parentf049cba47c31d31a4a8ed9a9180f0e847be3411c (diff)
downloadpodman-5669ffb3544fd398a280c0adb3c445e1375a752e.tar.gz
podman-5669ffb3544fd398a280c0adb3c445e1375a752e.tar.bz2
podman-5669ffb3544fd398a280c0adb3c445e1375a752e.zip
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 <pholzing@redhat.com>
-rw-r--r--libpod/container_path_resolution.go1
-rw-r--r--libpod/doc.go11
2 files changed, 11 insertions, 1 deletions
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