diff options
author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2020-11-23 12:53:31 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-11-23 12:53:31 +0100 |
commit | ac55bd1f673156cbb60b568b65f7bf4918daf152 (patch) | |
tree | 1a592f4ead55236eb44733b47c92877cb4828427 | |
parent | 79ab19ab8bbc069c06e47e45dd51e34a35d6a35f (diff) | |
parent | 5d9647a12094c953436b1f9af44f88e53db4af16 (diff) | |
download | podman-ac55bd1f673156cbb60b568b65f7bf4918daf152.tar.gz podman-ac55bd1f673156cbb60b568b65f7bf4918daf152.tar.bz2 podman-ac55bd1f673156cbb60b568b65f7bf4918daf152.zip |
Merge pull request #8449 from vrothberg/top-docs
[CI:DOCS] clarify ps(1) fallback of `podman top`
-rw-r--r-- | cmd/podman/containers/top.go | 8 | ||||
-rw-r--r-- | docs/source/markdown/podman-top.1.md | 2 |
2 files changed, 4 insertions, 6 deletions
diff --git a/cmd/podman/containers/top.go b/cmd/podman/containers/top.go index 3eb6d2af2..f00b1dce1 100644 --- a/cmd/podman/containers/top.go +++ b/cmd/podman/containers/top.go @@ -18,12 +18,10 @@ import ( ) var ( - topDescription = `Similar to system "top" command. - - Specify format descriptors to alter the output. - - Running "podman top -l pid pcpu seccomp" will print the process ID, the CPU percentage and the seccomp mode of each process of the latest container.` + topDescription = `Display the running processes of a container. + The top command extends the ps(1) compatible AIX descriptors with container-specific ones as shown below. In the presence of ps(1) specific flags (e.g, -eo), Podman will execute ps(1) inside the container. +` topOptions = entities.TopOptions{} topCommand = &cobra.Command{ diff --git a/docs/source/markdown/podman-top.1.md b/docs/source/markdown/podman-top.1.md index f307f96da..cfb89567c 100644 --- a/docs/source/markdown/podman-top.1.md +++ b/docs/source/markdown/podman-top.1.md @@ -9,7 +9,7 @@ podman\-top - Display the running processes of a container **podman container top** [*options*] *container* [*format-descriptors*] ## DESCRIPTION -Display the running processes of the container. The *format-descriptors* are ps (1) compatible AIX format descriptors but extended to print additional information, such as the seccomp mode or the effective capabilities of a given process. The descriptors can either be passed as separated arguments or as a single comma-separated argument. Note that you can also specify options and or flags of ps(1); in this case, Podman will fallback to executing ps with the specified arguments and flags in the container. +Display the running processes of the container. The *format-descriptors* are ps (1) compatible AIX format descriptors but extended to print additional information, such as the seccomp mode or the effective capabilities of a given process. The descriptors can either be passed as separated arguments or as a single comma-separated argument. Note that you can also specify options and or flags of ps(1); in this case, Podman will fallback to executing ps with the specified arguments and flags in the container. Please use the "h*" descriptors if you want to extract host-related information. For instance, `podman top $name hpid huser` to display the PID and user of the processes in the host context. ## OPTIONS |