diff options
| author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2020-06-30 12:35:32 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-06-30 12:35:32 -0400 |
| commit | 6fbd1570f86fc2509b6842c28dc2bc2e75e696d2 (patch) | |
| tree | 9747c0551c8e0ed539b55e9e8704520ec0d8a61b /cmd | |
| parent | c2a0ccd39464a91b7ba5fdca3af3c2ed66f2cbca (diff) | |
| parent | 8d69f5178b0b06b45986044d28f91a2ed16a7532 (diff) | |
| download | podman-6fbd1570f86fc2509b6842c28dc2bc2e75e696d2.tar.gz podman-6fbd1570f86fc2509b6842c28dc2bc2e75e696d2.tar.bz2 podman-6fbd1570f86fc2509b6842c28dc2bc2e75e696d2.zip | |
Merge pull request #6773 from markstos/issue-6756-improve-inspect-docs
docs: recommend alternatives to podman inspect
Diffstat (limited to 'cmd')
| -rw-r--r-- | cmd/podman/inspect.go | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/cmd/podman/inspect.go b/cmd/podman/inspect.go index 12e11d0f5..befdeb445 100644 --- a/cmd/podman/inspect.go +++ b/cmd/podman/inspect.go @@ -8,12 +8,22 @@ import ( ) var ( + inspectDescription = `Displays the low-level information on an object identified by name or ID. + For more inspection options, see: + + podman container inspect + podman image inspect + podman network inspect + podman pod inspect + podman volume inspect` + // Command: podman _inspect_ Object_ID inspectCmd = &cobra.Command{ - Use: "inspect [flags] {CONTAINER_ID | IMAGE_ID} [...]", - Short: "Display the configuration of object denoted by ID", - Long: "Displays the low-level information on an object identified by name or ID", - RunE: inspectExec, + Use: "inspect [flags] {CONTAINER_ID | IMAGE_ID} [...]", + Short: "Display the configuration of object denoted by ID", + RunE: inspectExec, + Long: inspectDescription, + TraverseChildren: true, Example: `podman inspect fedora podman inspect --type image fedora podman inspect CtrID ImgID |