summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2022-09-13 17:00:51 +0200
committerGitHub <noreply@github.com>2022-09-13 17:00:51 +0200
commit4ff5bd854243a5931ea0dddb8254b161462ad0b6 (patch)
treed016a6db72a72e2c8be259a7040ea577b3ed4ca8
parent7e03a497d1f46a36129020fe39de04e8cb5af448 (diff)
parentdacd5942470b574608594ab034695cc3ead880b9 (diff)
downloadpodman-4ff5bd854243a5931ea0dddb8254b161462ad0b6.tar.gz
podman-4ff5bd854243a5931ea0dddb8254b161462ad0b6.tar.bz2
podman-4ff5bd854243a5931ea0dddb8254b161462ad0b6.zip
Merge pull request #15773 from edsantiago/docs_dedup_publish_all
[CI:DOCS] Man pages: refactor common options: --publish-all
-rw-r--r--docs/source/markdown/options/publish-all.md12
-rw-r--r--docs/source/markdown/podman-create.1.md.in12
-rw-r--r--docs/source/markdown/podman-run.1.md.in13
3 files changed, 14 insertions, 23 deletions
diff --git a/docs/source/markdown/options/publish-all.md b/docs/source/markdown/options/publish-all.md
new file mode 100644
index 000000000..6651599a0
--- /dev/null
+++ b/docs/source/markdown/options/publish-all.md
@@ -0,0 +1,12 @@
+#### **--publish-all**, **-P**
+
+Publish all exposed ports to random ports on the host interfaces. The default is **false**.
+
+When set to **true**, publish all exposed ports to the host interfaces. The
+default is **false**. If the operator uses **-P** (or **-p**) then Podman will make the
+exposed port accessible on the host and the ports will be available to any
+client that can reach the host.
+
+When using this option, Podman will bind any exposed port to a random port on the host
+within an ephemeral port range defined by */proc/sys/net/ipv4/ip_local_port_range*.
+To find the mapping between the host ports and the exposed ports, use **podman port**.
diff --git a/docs/source/markdown/podman-create.1.md.in b/docs/source/markdown/podman-create.1.md.in
index b78db81bf..3dec9ce80 100644
--- a/docs/source/markdown/podman-create.1.md.in
+++ b/docs/source/markdown/podman-create.1.md.in
@@ -377,17 +377,7 @@ associated ports. If one container binds to a port, no other container can use t
within the pod while it is in use. Containers in the pod can also communicate over localhost
by having one container bind to localhost in the pod, and another connect to that port.
-#### **--publish-all**, **-P**
-
-Publish all exposed ports to random ports on the host interfaces. The default is *false*.
-
-When set to true publish all exposed ports to the host interfaces. The
-default is false. If the operator uses -P (or -p) then Podman will make the
-exposed port accessible on the host and the ports will be available to any
-client that can reach the host. When using -P, Podman will bind any exposed
-port to a random port on the host within an *ephemeral port range* defined by
-`/proc/sys/net/ipv4/ip_local_port_range`. To find the mapping between the host
-ports and the exposed ports, use `podman port`.
+@@option publish-all
@@option pull
diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in
index b4ec0c23e..fb421a4c3 100644
--- a/docs/source/markdown/podman-run.1.md.in
+++ b/docs/source/markdown/podman-run.1.md.in
@@ -408,18 +408,7 @@ associated ports. If one container binds to a port, no other container can use t
within the pod while it is in use. Containers in the pod can also communicate over localhost
by having one container bind to localhost in the pod, and another connect to that port.
-#### **--publish-all**, **-P**
-
-Publish all exposed ports to random ports on the host interfaces. The default is **false**.
-
-When set to **true**, publish all exposed ports to the host interfaces. The
-default is **false**. If the operator uses **-P** (or **-p**) then Podman will make the
-exposed port accessible on the host and the ports will be available to any
-client that can reach the host.
-
-When using this option, Podman will bind any exposed port to a random port on the host
-within an ephemeral port range defined by */proc/sys/net/ipv4/ip_local_port_range*.
-To find the mapping between the host ports and the exposed ports, use **podman port**.
+@@option publish-all
@@option pull