summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2022-09-12 15:20:54 -0600
committerEd Santiago <santiago@redhat.com>2022-09-12 17:56:57 -0600
commit09ba2e0b9eb4ce08724fc99b3e73109a496eeee1 (patch)
treec78c46e8d1dab08a9a4883bb5124b5b7998e904d /docs
parent4aeaeafde54eb223468ae3ea8425ab548e90e8e8 (diff)
downloadpodman-09ba2e0b9eb4ce08724fc99b3e73109a496eeee1.tar.gz
podman-09ba2e0b9eb4ce08724fc99b3e73109a496eeee1.tar.bz2
podman-09ba2e0b9eb4ce08724fc99b3e73109a496eeee1.zip
Man pages: refactor common options: --rootfs
podman-create and -run only. The SELinux text was added to podman-run (but not -create) in #3631, and reformatted in #5192. I assume here that it also applies to podman-create. Per feedback from Dan, added :s0 to SELinux context Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/source/markdown/options/rootfs.md19
-rw-r--r--docs/source/markdown/podman-create.1.md.in17
-rw-r--r--docs/source/markdown/podman-run.1.md.in20
3 files changed, 21 insertions, 35 deletions
diff --git a/docs/source/markdown/options/rootfs.md b/docs/source/markdown/options/rootfs.md
new file mode 100644
index 000000000..a03c4eef1
--- /dev/null
+++ b/docs/source/markdown/options/rootfs.md
@@ -0,0 +1,19 @@
+#### **--rootfs**
+
+If specified, the first argument refers to an exploded container on the file system.
+
+This is useful to run a container without requiring any image management, the rootfs
+of the container is assumed to be managed externally.
+
+ `Overlay Rootfs Mounts`
+
+ The `:O` flag tells Podman to mount the directory from the rootfs path as
+storage using the `overlay file system`. The container processes
+can modify content within the mount point which is stored in the
+container storage in a separate directory. In overlay terms, the source
+directory will be the lower, and the container storage directory will be the
+upper. Modifications to the mount point are destroyed when the container
+finishes executing, similar to a tmpfs mount point being unmounted.
+
+Note: On **SELinux** systems, the rootfs needs the correct label, which is by default
+**unconfined_u:object_r:container_file_t:s0**.
diff --git a/docs/source/markdown/podman-create.1.md.in b/docs/source/markdown/podman-create.1.md.in
index 0d03c8671..6f6bb29e5 100644
--- a/docs/source/markdown/podman-create.1.md.in
+++ b/docs/source/markdown/podman-create.1.md.in
@@ -418,22 +418,7 @@ Suppress output information when pulling images
Automatically remove the container when it exits. The default is *false*.
-#### **--rootfs**
-
-If specified, the first argument refers to an exploded container on the file system.
-
-This is useful to run a container without requiring any image management, the rootfs
-of the container is assumed to be managed externally.
-
- `Overlay Rootfs Mounts`
-
- The `:O` flag tells Podman to mount the directory from the rootfs path as
-storage using the `overlay file system`. The container processes
-can modify content within the mount point which is stored in the
-container storage in a separate directory. In overlay terms, the source
-directory will be the lower, and the container storage directory will be the
-upper. Modifications to the mount point are destroyed when the container
-finishes executing, similar to a tmpfs mount point being unmounted.
+@@option rootfs
@@option sdnotify
diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in
index 7b762d060..53f7cfe99 100644
--- a/docs/source/markdown/podman-run.1.md.in
+++ b/docs/source/markdown/podman-run.1.md.in
@@ -455,25 +455,7 @@ Automatically remove the container when it exits. The default is **false**.
After exit of the container, remove the image unless another
container is using it. The default is *false*.
-#### **--rootfs**
-
-If specified, the first argument refers to an exploded container on the file system.
-
-This is useful to run a container without requiring any image management, the rootfs
-of the container is assumed to be managed externally.
-
- `Overlay Rootfs Mounts`
-
- The `:O` flag tells Podman to mount the directory from the rootfs path as
-storage using the `overlay file system`. The container processes
-can modify content within the mount point which is stored in the
-container storage in a separate directory. In overlay terms, the source
-directory will be the lower, and the container storage directory will be the
-upper. Modifications to the mount point are destroyed when the container
-finishes executing, similar to a tmpfs mount point being unmounted.
-
-Note: On **SELinux** systems, the rootfs needs the correct label, which is by default
-**unconfined_u:object_r:container_file_t**.
+@@option rootfs
@@option sdnotify