opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-06-27 13:38:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

[CI:DOCS] uidmap man pages: fix corrupt italics

Browse Source 
The markdown-to-manpage sequence interprets
_from_uid_ and *from_uid* differently.
Use the latter syntax to get the expected result.

Fixes: https://github.com/containers/podman/issues/19171

Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
This commit is contained in:
Erik Sjölund
2023-07-09 10:50:48 +02:00
parent 94dba6d891
commit eec438222a
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/source/markdown/options/uidmap.container.md
View File

@ -9,7 +9,7 @@ option conflicts with the **--userns** and **--subuidname** options. This
option provides a way to map host UIDs to container UIDs. It can be passed option provides a way to map host UIDs to container UIDs. It can be passed
several times to map different ranges. several times to map different ranges.
The _from_uid_ value is based upon the user running the command, either rootful or rootless users. The *from_uid* value is based upon the user running the command, either rootful or rootless users.
* rootful user: *container_uid*:*host_uid*:*amount* * rootful user: *container_uid*:*host_uid*:*amount*
* rootless user: *container_uid*:*intermediate_uid*:*amount* * rootless user: *container_uid*:*intermediate_uid*:*amount*
@ -23,13 +23,13 @@ If for example _amount_ is **4** the mapping looks like:
| host UID | container UID | | host UID | container UID |
| ---------- | ---------------- | | ---------- | ---------------- |
| _from_uid_ | _container_uid_ | | *from_uid* | *container_uid* |
| _from_uid_ + 1 | _container_uid_ + 1 | | *from_uid* + 1 | *container_uid* + 1 |
| _from_uid_ + 2 | _container_uid_ + 2 | | *from_uid* + 2 | *container_uid* + 2 |
| _from_uid_ + 3 | _container_uid_ + 3 | | *from_uid* + 3 | *container_uid* + 3 |
When **podman <<subcommand>>** is called by an unprivileged user (i.e. running rootless), When **podman <<subcommand>>** is called by an unprivileged user (i.e. running rootless),
the value _from_uid_ is interpreted as an "intermediate UID". In the rootless the value *from_uid* is interpreted as an "intermediate UID". In the rootless
case, host UIDs are not mapped directly to container UIDs. Instead the mapping case, host UIDs are not mapped directly to container UIDs. Instead the mapping
happens over two mapping steps: happens over two mapping steps:
@ -59,11 +59,11 @@ If for example _amount_ is **5** the second mapping step looks like:
| intermediate UID | container UID | | intermediate UID | container UID |
| ------------------ | ---------------- | | ------------------ | ---------------- |
| _from_uid_ | _container_uid_ | | *from_uid* | *container_uid* |
| _from_uid_ + 1 | _container_uid_ + 1 | | *from_uid* + 1 | *container_uid* + 1 |
| _from_uid_ + 2 | _container_uid_ + 2 | | *from_uid* + 2 | *container_uid* + 2 |
| _from_uid_ + 3 | _container_uid_ + 3 | | *from_uid* + 3 | *container_uid* + 3 |
| _from_uid_ + 4 | _container_uid_ + 4 | | *from_uid* + 4 | *container_uid* + 4 |
When running as rootless, Podman uses all the ranges configured in the _/etc/subuid_ file. When running as rootless, Podman uses all the ranges configured in the _/etc/subuid_ file.