Merge pull request #6773 from markstos/issue-6756-improve-inspect-docs

docs: recommend alternatives to podman inspect
containers · Jun 30, 2020 · 6fbd157 · 6fbd157
2 parents c2a0ccd + 8d69f51
commit 6fbd157
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 8 deletions.
diff --git 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

diff --git a/docs/source/markdown/podman-inspect.1.md b/docs/source/markdown/podman-inspect.1.md
@@ -6,15 +6,21 @@ podman\-inspect - Display a container or image's configuration
 ## SYNOPSIS
 **podman inspect** [*options*] *name* [...]
 
-**podman image inspect** [*options*] *image*
-
-**podman container inspect** [*options*] *container*
-
 ## DESCRIPTION
+
 This displays the low-level information on containers and images identified by name or ID. By default, this will render
 all results in a JSON array. If the container and image have the same name, this will return container JSON for
 unspecified type. If a format is specified, the given template will be executed for each result.
 
+For more inspection options, see:
+
+      podman container inspect
+      podman image inspect
+      podman network inspect
+      podman pod inspect
+      podman volume inspect
+
+
 ## OPTIONS
 
 **--type**, **-t**=*type*