This proposes a more comprehensible man page.
A number of things have been lost in translation and this should be reviewed:
- the former docs from --userns say that it is disabled by default. I
suppose that this is the same as --userns:host, but this should be confirmed.
It also stated that is would use options like pid=host, which confuses me
as pid namespaces are a totally different thing from user namespaces. It also
mentions the enabling of --privileged. I think the difference between using
--userns:host and not using any user namespace options at all is not clear
and maybe not very logical. Also what would be the difference between using
--userns:host and using --priveleged alone?
- I found the syntax for --gidmap at the bottom of the man page in the examples.
In the example it doesn't use '=', eg. podman run `--gidmap 0:30000:2000`.
For consistency with the other options I have used '=' for now, but if it is
optional, I would remove it everywhere, as less tokens is usually improved
readability. For now the inconsistency remains between the options doc and the
examples section.
- It wasn't very clear to me whether one should hard wrap long lines or not as the
contains a mix.
- I haven't for now looked at user namespace options on other commands, but
that should be done surely before merging.
- I didn't know which command to run to generate the groff, so that needs doing still.
from issue #1374
Signed-off-by: Naja Melan <najamelan@autistici.org>
Signed-off-by: Naja Melan <najamelan@autistici.org>
Closes: #1380
Approved by: rhatdan
357eff7235
