diff options
| author | Ed Santiago <santiago@redhat.com> | 2022-08-22 13:06:49 -0600 |
|---|---|---|
| committer | Ed Santiago <santiago@redhat.com> | 2022-08-22 18:37:38 -0600 |
| commit | 74388fe75ffa896993256c5336dabaa071b034f9 (patch) | |
| tree | 407559ed45cf8cbd2bc9002858d5943f5eda7dd9 /docs/source/markdown/options | |
| parent | d97f4dfbcc5af69c01afa2a76194486d178f63a6 (diff) | |
| download | podman-74388fe75ffa896993256c5336dabaa071b034f9.tar.gz podman-74388fe75ffa896993256c5336dabaa071b034f9.tar.bz2 podman-74388fe75ffa896993256c5336dabaa071b034f9.zip | |
Man pages: refactor common options: --pod-id-file
Much like --cidfile (#15414), --pod-id-file has two meanings.
One is used in pod-related commands, one in container ones.
Both meanings read the file, so the read/write split used
in --cidfile is not applicable here.
podman-pod-create keeps its --pod-id-file option because
that one cannot be refactored: that's the only command (now)
that writes a pod-id file.
Reviewable using hack/markdown-preprocess-review but I
did take some liberties with the #### args because they
were wrong. And, since I had to much with the description
text anyway (resulting in diffs), I also took the liberty
of cleaning up a double space.
Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/options')
| -rw-r--r-- | docs/source/markdown/options/pod-id-file.container.md | 4 | ||||
| -rw-r--r-- | docs/source/markdown/options/pod-id-file.pod.md | 3 |
2 files changed, 7 insertions, 0 deletions
diff --git a/docs/source/markdown/options/pod-id-file.container.md b/docs/source/markdown/options/pod-id-file.container.md new file mode 100644 index 000000000..1c102dc6b --- /dev/null +++ b/docs/source/markdown/options/pod-id-file.container.md @@ -0,0 +1,4 @@ +#### **--pod-id-file**=*file* + +Run container in an existing pod and read the pod's ID from the specified *file*. +If a container is run within a pod, and the pod has an infra-container, the infra-container will be started before the container is. diff --git a/docs/source/markdown/options/pod-id-file.pod.md b/docs/source/markdown/options/pod-id-file.pod.md new file mode 100644 index 000000000..69e2ac6e9 --- /dev/null +++ b/docs/source/markdown/options/pod-id-file.pod.md @@ -0,0 +1,3 @@ +#### **--pod-id-file**=*file* + +Read pod ID from the specified *file* and <<subcommand>> the pod. Can be specified multiple times. |