diff options
| author | Ed Santiago <santiago@redhat.com> | 2022-10-04 11:22:06 -0600 |
|---|---|---|
| committer | Ed Santiago <santiago@redhat.com> | 2022-10-05 04:27:47 -0600 |
| commit | 3451aac35e949018cda0e999a4a161b44486faa9 (patch) | |
| tree | 9ef82b59ba0f6cac6d0e22fa33bb68b345a82dbf | |
| parent | 84c85f4d9457fb35849fa93ba04814df681b9093 (diff) | |
| download | podman-3451aac35e949018cda0e999a4a161b44486faa9.tar.gz podman-3451aac35e949018cda0e999a4a161b44486faa9.tar.bz2 podman-3451aac35e949018cda0e999a4a161b44486faa9.zip | |
Man pages: refactor common options: --pod
Only between podman-create and -run; the other meanings
of --pod are too different. This almost didn't feel worth
refactoring, except the podman-run version fixed a word
and added a possibly important note about infra containers.
I went with the podman-run version.
Signed-off-by: Ed Santiago <santiago@redhat.com>
| -rw-r--r-- | docs/source/markdown/options/pod.run.md | 5 | ||||
| -rw-r--r-- | docs/source/markdown/podman-create.1.md.in | 5 | ||||
| -rw-r--r-- | docs/source/markdown/podman-run.1.md.in | 6 |
3 files changed, 7 insertions, 9 deletions
diff --git a/docs/source/markdown/options/pod.run.md b/docs/source/markdown/options/pod.run.md new file mode 100644 index 000000000..6ba3c718b --- /dev/null +++ b/docs/source/markdown/options/pod.run.md @@ -0,0 +1,5 @@ +#### **--pod**=*name* + +Run container in an existing pod. If you want Podman to make the pod for you, prefix the pod name with **new:**. +To make a pod with more granular options, use the **podman pod create** command before creating a container. +If a container is run with 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/podman-create.1.md.in b/docs/source/markdown/podman-create.1.md.in index 92bcce94b..b7f621866 100644 --- a/docs/source/markdown/podman-create.1.md.in +++ b/docs/source/markdown/podman-create.1.md.in @@ -276,10 +276,7 @@ This option conflicts with **--add-host**. @@option platform -#### **--pod**=*name* - -Run container in an existing pod. If you want Podman to make the pod for you, preference the pod name with `new:`. -To make a pod with more granular options, use the `podman pod create` command before creating a container. +@@option pod.run @@option pod-id-file.container diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in index 692c218ad..d596ee902 100644 --- a/docs/source/markdown/podman-run.1.md.in +++ b/docs/source/markdown/podman-run.1.md.in @@ -302,11 +302,7 @@ This is used to override the Podman provided user setup in favor of entrypoint c @@option platform -#### **--pod**=*name* - -Run container in an existing pod. If you want Podman to make the pod for you, prefix the pod name with **new:**. -To make a pod with more granular options, use the **podman pod create** command before creating a container. -If a container is run with a pod, and the pod has an infra-container, the infra-container will be started before the container is. +@@option pod.run @@option pod-id-file.container |