summaryrefslogtreecommitdiff
path: root/docs/source/markdown
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2022-08-16 13:01:59 +0000
committerGitHub <noreply@github.com>2022-08-16 13:01:59 +0000
commit311b5946f74c94c5d6024c904abf6976c75e4d8f (patch)
treec47c63aa035067d7ccb1b6890231e4ec7d8207fd /docs/source/markdown
parentd36f3952d4f4f05d8411ad3d14e9d5b6c1814701 (diff)
parent22f3dd4c29de5be5338bdd33a8adbd201e98790d (diff)
downloadpodman-311b5946f74c94c5d6024c904abf6976c75e4d8f.tar.gz
podman-311b5946f74c94c5d6024c904abf6976c75e4d8f.tar.bz2
podman-311b5946f74c94c5d6024c904abf6976c75e4d8f.zip
Merge pull request #15331 from edsantiago/docs_dedup_piecemeal
Man pages: refactor common options: arch
Diffstat (limited to 'docs/source/markdown')
-rw-r--r--docs/source/markdown/options/README.md2
-rw-r--r--docs/source/markdown/options/arch.md2
-rw-r--r--docs/source/markdown/podman-create.1.md.in3
-rw-r--r--docs/source/markdown/podman-pull.1.md.in3
-rw-r--r--docs/source/markdown/podman-run.1.md.in3
5 files changed, 7 insertions, 6 deletions
diff --git a/docs/source/markdown/options/README.md b/docs/source/markdown/options/README.md
index b737fabf7..92f3d374e 100644
--- a/docs/source/markdown/options/README.md
+++ b/docs/source/markdown/options/README.md
@@ -42,3 +42,5 @@ This allows the shared use of examples in the option file:
```
Example: podman <<subcommand>> --foo --bar
```
+As a special case, `podman-pod-X` becomes just `X` (the "pod" is removed).
+This makes the `pod-id-file` man page more useful.
diff --git a/docs/source/markdown/options/arch.md b/docs/source/markdown/options/arch.md
new file mode 100644
index 000000000..005197707
--- /dev/null
+++ b/docs/source/markdown/options/arch.md
@@ -0,0 +1,2 @@
+#### **--arch**=*ARCH*
+Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`.
diff --git a/docs/source/markdown/podman-create.1.md.in b/docs/source/markdown/podman-create.1.md.in
index 5bb1dceca..45dfe304c 100644
--- a/docs/source/markdown/podman-create.1.md.in
+++ b/docs/source/markdown/podman-create.1.md.in
@@ -73,8 +73,7 @@ and specified with a _tag_.
Add an annotation to the container. The format is key=value.
The **--annotation** option can be set multiple times.
-#### **--arch**=*ARCH*
-Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`.
+@@option arch
#### **--attach**, **-a**=*location*
diff --git a/docs/source/markdown/podman-pull.1.md.in b/docs/source/markdown/podman-pull.1.md.in
index 4321cb364..29c4f865d 100644
--- a/docs/source/markdown/podman-pull.1.md.in
+++ b/docs/source/markdown/podman-pull.1.md.in
@@ -49,8 +49,7 @@ All tagged images in the repository will be pulled.
*IMPORTANT: When using the all-tags flag, Podman will not iterate over the search registries in the **[containers-registries.conf(5)](https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md)** but will always use docker.io for unqualified image names.*
-#### **--arch**=*ARCH*
-Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`.
+@@option arch
#### **--authfile**=*path*
diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in
index 21ce566ce..df9f1c28a 100644
--- a/docs/source/markdown/podman-run.1.md.in
+++ b/docs/source/markdown/podman-run.1.md.in
@@ -90,8 +90,7 @@ and specified with a _tag_.
Add an annotation to the container.
This option can be set multiple times.
-#### **--arch**=*ARCH*
-Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`.
+@@option arch
#### **--attach**, **-a**=*stdin* | *stdout* | *stderr*