Skip to content

Commit

Permalink
Merge pull request #8449 from vrothberg/top-docs
Browse files Browse the repository at this point in the history
[CI:DOCS] clarify ps(1) fallback of `podman top`
  • Loading branch information
openshift-merge-robot authored Nov 23, 2020
2 parents 79ab19a + 5d9647a commit ac55bd1
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
8 changes: 3 additions & 5 deletions cmd/podman/containers/top.go
Original file line number Diff line number Diff line change
Expand Up @@ -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{
Expand Down
2 changes: 1 addition & 1 deletion docs/source/markdown/podman-top.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit ac55bd1

Please sign in to comment.