container/podman
container/podman
1
0
Fork 0
mirror of https://github.com/containers/podman synced 2024-10-18 16:24:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

document that using libpod package directly is not supported

Browse source 
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>
This commit is contained in:
Paul Holzinger 2022-03-23 19:03:08 +01:00
parent f049cba47c
commit 5669ffb354
No known key found for this signature in database
GPG key ID: EB145DD938A3CAF2
2 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
libpod/container_path_resolution.go
View file

@ -1,4 +1,3 @@
// +linux
package libpod package libpod
import ( import (

11
libpod/doc.go Normal file
View file

@ -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