diff options
author | Ed Santiago <santiago@redhat.com> | 2022-09-27 15:05:03 -0600 |
---|---|---|
committer | Ed Santiago <santiago@redhat.com> | 2022-10-03 05:07:45 -0600 |
commit | eaa3892623111378ed50ed938dae391272ba999f (patch) | |
tree | ae96aa68da32e194e8406cde691c57c441539209 /docs | |
parent | ddf36e06490b5112fd8150f8e5090aa85bfa4018 (diff) | |
download | podman-eaa3892623111378ed50ed938dae391272ba999f.tar.gz podman-eaa3892623111378ed50ed938dae391272ba999f.tar.bz2 podman-eaa3892623111378ed50ed938dae391272ba999f.zip |
Man pages: refactor common options: --variant
Two different texts, split into two .md files. Nontrivial, but
still easy to review because the text is unchanged.
I was unable to reconcile either version with podman-build,
so that file remains with a separate version.
Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/source/markdown/.gitignore | 1 | ||||
-rw-r--r-- | docs/source/markdown/options/variant.container.md | 3 | ||||
-rw-r--r-- | docs/source/markdown/options/variant.manifest.md | 5 | ||||
-rw-r--r-- | docs/source/markdown/podman-create.1.md.in | 3 | ||||
-rw-r--r-- | docs/source/markdown/podman-manifest-add.1.md.in | 6 | ||||
-rw-r--r-- | docs/source/markdown/podman-manifest-annotate.1.md.in (renamed from docs/source/markdown/podman-manifest-annotate.1.md) | 6 | ||||
-rw-r--r-- | docs/source/markdown/podman-pull.1.md.in | 4 | ||||
-rw-r--r-- | docs/source/markdown/podman-run.1.md.in | 3 |
8 files changed, 14 insertions, 17 deletions
diff --git a/docs/source/markdown/.gitignore b/docs/source/markdown/.gitignore index 57a64e1c1..f5c4c2e24 100644 --- a/docs/source/markdown/.gitignore +++ b/docs/source/markdown/.gitignore @@ -12,6 +12,7 @@ podman-login.1.md podman-logout.1.md podman-logs.1.md podman-manifest-add.1.md +podman-manifest-annotate.1.md podman-manifest-create.1.md podman-manifest-push.1.md podman-pause.1.md diff --git a/docs/source/markdown/options/variant.container.md b/docs/source/markdown/options/variant.container.md new file mode 100644 index 000000000..ed7cd29d3 --- /dev/null +++ b/docs/source/markdown/options/variant.container.md @@ -0,0 +1,3 @@ +#### **--variant**=*VARIANT* + +Use _VARIANT_ instead of the default architecture variant of the container image. Some images can use multiple variants of the arm architectures, such as arm/v5 and arm/v7. diff --git a/docs/source/markdown/options/variant.manifest.md b/docs/source/markdown/options/variant.manifest.md new file mode 100644 index 000000000..b1d7b28aa --- /dev/null +++ b/docs/source/markdown/options/variant.manifest.md @@ -0,0 +1,5 @@ +#### **--variant** + +Specify the variant which the list or index records for the image. This option +is typically used to distinguish between multiple entries which share the same +architecture value, but which expect different versions of its instruction set. diff --git a/docs/source/markdown/podman-create.1.md.in b/docs/source/markdown/podman-create.1.md.in index 503e6fac7..92bcce94b 100644 --- a/docs/source/markdown/podman-create.1.md.in +++ b/docs/source/markdown/podman-create.1.md.in @@ -398,8 +398,7 @@ Note: Labeling can be disabled for all containers by setting label=false in the @@option uts.container -#### **--variant**=*VARIANT* -Use _VARIANT_ instead of the default architecture variant of the container image. Some images can use multiple variants of the arm architectures, such as arm/v5 and arm/v7. +@@option variant.container @@option volume diff --git a/docs/source/markdown/podman-manifest-add.1.md.in b/docs/source/markdown/podman-manifest-add.1.md.in index 6a9df69b4..d39945e00 100644 --- a/docs/source/markdown/podman-manifest-add.1.md.in +++ b/docs/source/markdown/podman-manifest-add.1.md.in @@ -58,11 +58,7 @@ image. This option is rarely used. @@option tls-verify -#### **--variant** - -Specify the variant which the list or index records for the image. This option -is typically used to distinguish between multiple entries which share the same -architecture value, but which expect different versions of its instruction set. +@@option variant.manifest ## Transport diff --git a/docs/source/markdown/podman-manifest-annotate.1.md b/docs/source/markdown/podman-manifest-annotate.1.md.in index a6f82aa9a..0a8cbf5ac 100644 --- a/docs/source/markdown/podman-manifest-annotate.1.md +++ b/docs/source/markdown/podman-manifest-annotate.1.md.in @@ -44,11 +44,7 @@ for the image. This option is rarely used. Specify the OS version which the list or index records as a requirement for the image. This option is rarely used. -#### **--variant** - -Specify the variant which the list or index records for the image. This option -is typically used to distinguish between multiple entries which share the same -architecture value, but which expect different versions of its instruction set. +@@option variant.manifest ## EXAMPLE diff --git a/docs/source/markdown/podman-pull.1.md.in b/docs/source/markdown/podman-pull.1.md.in index 46adec97b..2add9d703 100644 --- a/docs/source/markdown/podman-pull.1.md.in +++ b/docs/source/markdown/podman-pull.1.md.in @@ -73,9 +73,7 @@ Suppress output information when pulling images @@option tls-verify -#### **--variant**=*VARIANT* - -Use _VARIANT_ instead of the default architecture variant of the container image. Some images can use multiple variants of the arm architectures, such as arm/v5 and arm/v7. +@@option variant.container ## FILES diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in index 88547e126..692c218ad 100644 --- a/docs/source/markdown/podman-run.1.md.in +++ b/docs/source/markdown/podman-run.1.md.in @@ -439,8 +439,7 @@ echo "asdf" | podman run --rm -i someimage /bin/cat @@option uts.container -#### **--variant**=*VARIANT* -Use _VARIANT_ instead of the default architecture variant of the container image. Some images can use multiple variants of the arm architectures, such as arm/v5 and arm/v7. +@@option variant.container @@option volume |