Skip to content

docs: clarify podman pod ps default output#28707

Merged
Luap99 merged 1 commit into
containers:mainfrom
MayorFaj:docs/28702-pod-ps-clarify
May 15, 2026
Merged

docs: clarify podman pod ps default output#28707
Luap99 merged 1 commit into
containers:mainfrom
MayorFaj:docs/28702-pod-ps-clarify

Conversation

@MayorFaj
Copy link
Copy Markdown
Contributor

Summary

  • clarify that podman pod ps lists all pods on the system by default
  • update example headings that incorrectly referred to "running" pods
  • make the filtered example wording more specific and consistent

Checklist

  • Certify you wrote the patch or otherwise have the right to pass it on as an open-source patch by signing all
    commits. (git commit -s). (If needed, use git commit -s --amend). The author email must match
    the sign-off email address. See CONTRIBUTING.md
    for more information.
  • Referenced issues using Fixes: #00000 in commit message (if applicable)
  • Tests have been added/updated (or no tests are needed)
  • Documentation has been updated (or no documentation changes are needed)
  • All commits pass make validatepr (format/lint checks)
  • Release note entered in the section below (or None if no user-facing changes)

Does this PR introduce a user-facing change?

None

Fixes: #28702

Copy link
Copy Markdown
Member

@danishprakash danishprakash left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM once that suggestion/comment is handled.


On a separate note, I couldn't find a good reason why podman ps and podman pod ps differ in behavior (showing running vs all). Maybe it's accidental or because of docker compat in the case of podman ps.

But as it stands right now, this PR is needed to document the correct behavior, irrespective of the mismatch between the two sub-commands. Though in the long run, it'd be good to consolidate ps' behavior. @containers/podman-maintainers @containers/podman-reviewers

Comment thread docs/source/markdown/podman-pod-ps.1.md.in Outdated
Signed-off-by: MayorFaj <mayorfaj@gmail.com>
@MayorFaj MayorFaj force-pushed the docs/28702-pod-ps-clarify branch from 33b1691 to 8ae6f02 Compare May 15, 2026 06:47
@MayorFaj
Copy link
Copy Markdown
Contributor Author

LGTM once that suggestion/comment is handled.

On a separate note, I couldn't find a good reason why podman ps and podman pod ps differ in behavior (showing running vs all). Maybe it's accidental or because of docker compat in the case of podman ps.

But as it stands right now, this PR is needed to document the correct behavior, irrespective of the mismatch between the two sub-commands. Though in the long run, it'd be good to consolidate ps' behavior. @containers/podman-maintainers @containers/podman-reviewers

I confirmed this locally as well. podman ps only showed running containers by default, while podman pod ps showed both running and created pods without an --all flag.
I kept this PR scoped to documenting the current behavior only.

Copy link
Copy Markdown
Member

@Honny1 Honny1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@packit-as-a-service
Copy link
Copy Markdown

Cockpit tests failed for commit 8ae6f02. @martinpitt, @jelly, @mvollmer please check.

@Honny1
Copy link
Copy Markdown
Member

Honny1 commented May 15, 2026

On a separate note, I couldn't find a good reason why podman ps and podman pod ps differ in behavior (showing running vs all). Maybe it's accidental or because of docker compat in the case of podman ps.

I think it is exactly for Docker compatibility.

But as it stands right now, this PR is needed to document the correct behavior, irrespective of the mismatch between the two sub-commands. Though in the long run, it'd be good to consolidate ps' behavior. @containers/podman-maintainers @containers/podman-reviewers

@MayorFaj Agreed, there should definitely be a note explaining this.

@danishprakash, will you create an issue for consolidation so we don't forget about it?

@MayorFaj
Copy link
Copy Markdown
Contributor Author

consolidation

podman ps (containers) and podman pod ps (pods) are listing different objects.
podman ps -a lists all containers, including containers inside pods, while podman pod ps lists all pods, one row per pod.
So the output difference makes sense from that distinction.

Copy link
Copy Markdown
Member

@Luap99 Luap99 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Luap99 Luap99 merged commit e0b2e70 into containers:main May 15, 2026
41 of 42 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

unclear documentation on podman pod ps

4 participants