summaryrefslogtreecommitdiff
path: root/pkg/bindings/README.md
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2021-09-14 13:04:11 -0400
committerGitHub <noreply@github.com>2021-09-14 13:04:11 -0400
commitbb8b2ed7deb71431521d24486b0856845e7a7867 (patch)
tree3afa51a80166d3033bd1c793f1812bb7c9953155 /pkg/bindings/README.md
parent20daae1de93c1a73f454f3f3ba04bba03a348f81 (diff)
parentd7256be807890892c988cc7d270e3d1bf951397c (diff)
downloadpodman-bb8b2ed7deb71431521d24486b0856845e7a7867.tar.gz
podman-bb8b2ed7deb71431521d24486b0856845e7a7867.tar.bz2
podman-bb8b2ed7deb71431521d24486b0856845e7a7867.zip
Merge pull request #11559 from jwhonce/wip/generator
Enhance bindings for IDE hints
Diffstat (limited to 'pkg/bindings/README.md')
-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 f41304e0f..9e3610043 100644
--- a/pkg/bindings/README.md
+++ b/pkg/bindings/README.md
@@ -57,6 +57,10 @@ to interact with containers.
### Examples
The following examples build upon the connection example from above. They are all rootful connections as well.
+Note: Optional arguments to the bindings methods are set using With*() methods on *Option structures.
+Composite types are not duplicated rather the address is used. As such, you should not change an underlying
+field between initializing the *Option structure and calling the bindings method.
+
#### Inspect a container
The following example obtains the inspect information for a container named `foorbar` and then prints
the container's ID. Note the use of optional inspect options for size.