opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-07-04 10:10:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: recommend alternatives to podman inspect

Browse Source 
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>
This commit is contained in:
Mark Stosberg
2020-06-25 09:54:04 -04:00
parent e0b93af70f
commit 8d69f5178b
2 changed files with 24 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
cmd/podman/inspect.go
View File

@ -8,12 +8,22 @@ import (
) )
var ( 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 // Command: podman _inspect_ Object_ID
inspectCmd = &cobra.Command{ inspectCmd = &cobra.Command{
Use: "inspect [flags] {CONTAINER_ID | IMAGE_ID} [...]", Use: "inspect [flags] {CONTAINER_ID | IMAGE_ID} [...]",
Short: "Display the configuration of object denoted by 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, RunE: inspectExec,
Long: inspectDescription,
TraverseChildren: true,
Example: `podman inspect fedora Example: `podman inspect fedora
podman inspect --type image fedora podman inspect --type image fedora
podman inspect CtrID ImgID podman inspect CtrID ImgID

14
docs/source/markdown/podman-inspect.1.md
View File

@ -6,15 +6,21 @@ podman\-inspect - Display a container or image's configuration
## SYNOPSIS ## SYNOPSIS
**podman inspect** [*options*] *name* [...] **podman inspect** [*options*] *name* [...]
**podman image inspect** [*options*] *image*
**podman container inspect** [*options*] *container*
## DESCRIPTION ## DESCRIPTION
This displays the low-level information on containers and images identified by name or ID. By default, this will render 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 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. 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 ## OPTIONS
**--type**, **-t**=*type* **--type**, **-t**=*type*