summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2022-04-11 16:12:16 -0400
committerGitHub <noreply@github.com>2022-04-11 16:12:16 -0400
commit81b9646ceba05b2780d8c8210d60df4eaf6a3bdf (patch)
treee6612970749a29210e3f9688fc3ca0e6983b3d84
parent311d66f515d8b85008d483f390987132b89ebeaf (diff)
parentee4a583ed05794265a1a594d433c7b85b3073f02 (diff)
downloadpodman-81b9646ceba05b2780d8c8210d60df4eaf6a3bdf.tar.gz
podman-81b9646ceba05b2780d8c8210d60df4eaf6a3bdf.tar.bz2
podman-81b9646ceba05b2780d8c8210d60df4eaf6a3bdf.zip
Merge pull request #13826 from stevekuznetsov/skuznets/update-doc
[CI:DOCS] pkg/bindings: document requirements for use
-rw-r--r--pkg/bindings/README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/pkg/bindings/README.md b/pkg/bindings/README.md
index 2863039e4..ebc8a13d1 100644
--- a/pkg/bindings/README.md
+++ b/pkg/bindings/README.md
@@ -30,6 +30,10 @@ rootful connections is `/run/podman/podman.sock` and for rootless it is `/run/US
information about the Podman system service, see `man podman-system-service`.
### Creating a connection
+Ensure the [required dependencies](https://podman.io/getting-started/installation#build-and-run-dependencies) are installed,
+as they will be required to compile a Go program making use of the bindings.
+
+
The first step for using the bindings is to create a connection to the socket. As mentioned earlier, the destination
of the socket depends on the user who owns it. In this case, a rootful connection is made.