diff options
| author | Matthew Heon <matthew.heon@pm.me> | 2020-05-06 14:30:51 -0400 |
|---|---|---|
| committer | Matthew Heon <matthew.heon@pm.me> | 2020-05-06 14:30:51 -0400 |
| commit | 344084430ee72b25e93a7b73f09aa36747c1aa47 (patch) | |
| tree | 98e8bbbfb03462100f97ba587b6244f108ad9c65 /docs | |
| parent | 0eb905ff2c2f033ee3009d8d374dcd2347ac04d1 (diff) | |
| download | podman-344084430ee72b25e93a7b73f09aa36747c1aa47.tar.gz podman-344084430ee72b25e93a7b73f09aa36747c1aa47.tar.bz2 podman-344084430ee72b25e93a7b73f09aa36747c1aa47.zip | |
Update manpages for image volumes and MAC address
When reviewing the manpages for `podman run` to find options to
test, I found a few mistakes. The description of how we handle
image volumes is extremely outdated, and we now provide full
support for the `--mac-address` option. Update the docs for these
flags so they're accurate.
Signed-off-by: Matthew Heon <matthew.heon@pm.me>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/markdown/podman-create.1.md | 12 | ||||
| -rw-r--r-- | docs/source/markdown/podman-run.1.md | 5 |
2 files changed, 6 insertions, 11 deletions
diff --git a/docs/source/markdown/podman-create.1.md b/docs/source/markdown/podman-create.1.md index f0494ca7d..665f5ca58 100644 --- a/docs/source/markdown/podman-create.1.md +++ b/docs/source/markdown/podman-create.1.md @@ -358,12 +358,12 @@ Defaults to `true` **--image-volume**, **builtin-volume**=*bind|tmpfs|ignore* -Tells Podman how to handle the builtin image volumes. The options are: 'bind', 'tmpfs', or 'ignore' (default 'bind'). -bind: A directory is created inside the container state directory and bind mounted into -the container for the volumes. -tmpfs: The volume is mounted onto the container as a tmpfs, which allows the users to create +Tells Podman how to handle the builtin image volumes. Default is **bind**. + +- **bind**: An anonymous named volume will be created and mounted into the container. +- **tmpfs**: The volume is mounted onto the container as a tmpfs, which allows the users to create content that disappears when the container is stopped. -ignore: All volumes are just ignored and no action is taken. +- **ignore**: All volumes are just ignored and no action is taken. **--init** @@ -445,8 +445,6 @@ Remember that the MAC address in an Ethernet network must be unique. The IPv6 link-local address will be based on the device's MAC address according to RFC4862. -Not currently supported - **--memory**, **-m**=*limit* Memory limit (format: <number>[<unit>], where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes)) diff --git a/docs/source/markdown/podman-run.1.md b/docs/source/markdown/podman-run.1.md index b21eb9da9..745dbfc01 100644 --- a/docs/source/markdown/podman-run.1.md +++ b/docs/source/markdown/podman-run.1.md @@ -371,8 +371,7 @@ Defaults to **true**. Tells Podman how to handle the builtin image volumes. Default is **bind**. -- **bind**: A directory is created inside the container state directory and bind mounted into -the container for the volumes. +- **bind**: An anonymous named volume will be created and mounted into the container. - **tmpfs**: The volume is mounted onto the container as a tmpfs, which allows the users to create content that disappears when the container is stopped. - **ignore**: All volumes are just ignored and no action is taken. @@ -454,8 +453,6 @@ Remember that the MAC address in an Ethernet network must be unique. The IPv6 link-local address will be based on the device's MAC address according to RFC4862. -Not currently supported - **--memory**, **-m**=_number_[_unit_] Memory limit. A _unit_ can be **b** (bytes), **k** (kilobytes), **m** (megabytes), or **g** (gigabytes). |