summaryrefslogtreecommitdiff
path: root/cmd/podman/inspect.go
diff options
context:
space:
mode:
authorMark Stosberg <mark@rideamigos.com>2020-06-25 09:54:04 -0400
committerMark Stosberg <mark@rideamigos.com>2020-06-30 10:50:33 -0400
commit8d69f5178b0b06b45986044d28f91a2ed16a7532 (patch)
tree3b38bd4f468a56876bf761a4a4bc6cea58f99fae /cmd/podman/inspect.go
parente0b93af70f1f1a183c99a350c6e588898b45c717 (diff)
downloadpodman-8d69f5178b0b06b45986044d28f91a2ed16a7532.tar.gz
podman-8d69f5178b0b06b45986044d28f91a2ed16a7532.tar.bz2
podman-8d69f5178b0b06b45986044d28f91a2ed16a7532.zip
docs: recommend alternatives to podman inspect
podman inspect is problematic because there can be naming clashes. Also, it only inspects a couple of types of objects and the docs for it didn't help discover that several more types could be inspected as well. To address both concerns, we deprecate `podman inspect` and update the docs to point to to the recommend alternatives. Issue: #6756 Signed-off-by: Mark Stosberg <mark@rideamigos.com>
Diffstat (limited to 'cmd/podman/inspect.go')
-rw-r--r--cmd/podman/inspect.go18
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