diff options
| author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2022-03-24 18:49:43 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-24 18:49:43 +0100 |
| commit | 3b1d7a7d2450b72853233a635944ceebc9a89262 (patch) | |
| tree | 1db0e3c0492c4b80a04db3a9bdd23a3ed67d89b8 | |
| parent | 4d271912e8b4aa0aa92e414ce4b82557902a35d0 (diff) | |
| parent | 5669ffb3544fd398a280c0adb3c445e1375a752e (diff) | |
| download | podman-3b1d7a7d2450b72853233a635944ceebc9a89262.tar.gz podman-3b1d7a7d2450b72853233a635944ceebc9a89262.tar.bz2 podman-3b1d7a7d2450b72853233a635944ceebc9a89262.zip | |
Merge pull request #13621 from Luap99/doc-libpod
[CI:DOCS] document that using libpod package directly is not supported
| -rw-r--r-- | libpod/container_path_resolution.go | 1 | ||||
| -rw-r--r-- | libpod/doc.go | 11 |
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 |