containers / containers/podman-compose

Manual page naming conflict creates ambiguity

Open
#1,074 0 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
Python
Stars
6.2k
Forks
622
PR merge metrics
No merged PRs in 30d

Description

**Describe the bug**
The naming scheme for `podman` sub-command man pages creates a conflict when it comes to `podman-compose` because there is the sub-command and the underlying "provider". It yields this confusion: [Debian](https://manpages.debian.org/testing/podman-compose/podman-compose.1.en.html) vs [upsteam](https://docs.podman.io/en/latest/markdown/podman-compose.1.html). These two pages have the same name, in the same section of the manual, but they're talking about two different things: the `podman-compose` provider in the first case, and the `podman compose` sub-command in the second.

I have no suggestion for disentangling it, but the problem came up on the Discord server when a command told the user to go to the `podman-compose(1)` man page for a solution, but they got the first page linked above, which doesn't contain the solution. (The second one does.)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.