Merge pull request #13621 from Luap99/doc-libpod

[CI:DOCS] document that using libpod package directly is not supported
This commit is contained in:
OpenShift Merge Robot
2022-03-24 18:49:43 +01:00
committed by GitHub
2 changed files with 11 additions and 1 deletions

View File

@ -1,4 +1,3 @@
// +linux
package libpod
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