From eaa3892623111378ed50ed938dae391272ba999f Mon Sep 17 00:00:00 2001 From: Ed Santiago Date: Tue, 27 Sep 2022 15:05:03 -0600 Subject: 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 --- docs/source/markdown/.gitignore | 1 + docs/source/markdown/options/variant.container.md | 3 ++ docs/source/markdown/options/variant.manifest.md | 5 ++ docs/source/markdown/podman-create.1.md.in | 3 +- docs/source/markdown/podman-manifest-add.1.md.in | 6 +-- docs/source/markdown/podman-manifest-annotate.1.md | 61 ---------------------- .../markdown/podman-manifest-annotate.1.md.in | 57 ++++++++++++++++++++ docs/source/markdown/podman-pull.1.md.in | 4 +- docs/source/markdown/podman-run.1.md.in | 3 +- 9 files changed, 70 insertions(+), 73 deletions(-) create mode 100644 docs/source/markdown/options/variant.container.md create mode 100644 docs/source/markdown/options/variant.manifest.md delete mode 100644 docs/source/markdown/podman-manifest-annotate.1.md create mode 100644 docs/source/markdown/podman-manifest-annotate.1.md.in 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 deleted file mode 100644 index a6f82aa9a..000000000 --- a/docs/source/markdown/podman-manifest-annotate.1.md +++ /dev/null @@ -1,61 +0,0 @@ -% podman-manifest-annotate 1 - -## NAME -podman\-manifest\-annotate - Add or update information about an entry in a manifest list or image index - -## SYNOPSIS -**podman manifest annotate** [*options*] *listnameorindexname* *imagemanifestdigest* - -## DESCRIPTION - -Adds or updates information about an image included in a manifest list or image index. - -## OPTIONS - -#### **--annotation**=*annotation=value* - -Set an annotation on the entry for the specified image. - -#### **--arch** - -Override the architecture which the list or index records as a requirement for -the image. This is usually automatically retrieved from the image's -configuration information, so it is rarely necessary to use this option. - - -#### **--features** - -Specify the features list which the list or index records as requirements for -the image. This option is rarely used. - -#### **--os** - -Override the OS which the list or index records as a requirement for the image. -This is usually automatically retrieved from the image's configuration -information, so it is rarely necessary to use this option. - -#### **--os-features** - -Specify the OS features list which the list or index records as requirements -for the image. This option is rarely used. - -#### **--os-version** - -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. - -## EXAMPLE - -``` -podman manifest annotate --arch arm64 --variant v8 mylist:v1.11 sha256:59eec8837a4d942cc19a52b8c09ea75121acc38114a2c68b98983ce9356b8610 -07ec8dc22b5dba3a33c60b68bce28bbd2b905e383fdb32a90708fa5eeac13a07: sha256:59eec8837a4d942cc19a52b8c09ea75121acc38114a2c68b98983ce9356b8610 -``` - -## SEE ALSO -**[podman(1)](podman.1.md)**, **[podman-manifest(1)](podman-manifest.1.md)** diff --git a/docs/source/markdown/podman-manifest-annotate.1.md.in b/docs/source/markdown/podman-manifest-annotate.1.md.in new file mode 100644 index 000000000..0a8cbf5ac --- /dev/null +++ b/docs/source/markdown/podman-manifest-annotate.1.md.in @@ -0,0 +1,57 @@ +% podman-manifest-annotate 1 + +## NAME +podman\-manifest\-annotate - Add or update information about an entry in a manifest list or image index + +## SYNOPSIS +**podman manifest annotate** [*options*] *listnameorindexname* *imagemanifestdigest* + +## DESCRIPTION + +Adds or updates information about an image included in a manifest list or image index. + +## OPTIONS + +#### **--annotation**=*annotation=value* + +Set an annotation on the entry for the specified image. + +#### **--arch** + +Override the architecture which the list or index records as a requirement for +the image. This is usually automatically retrieved from the image's +configuration information, so it is rarely necessary to use this option. + + +#### **--features** + +Specify the features list which the list or index records as requirements for +the image. This option is rarely used. + +#### **--os** + +Override the OS which the list or index records as a requirement for the image. +This is usually automatically retrieved from the image's configuration +information, so it is rarely necessary to use this option. + +#### **--os-features** + +Specify the OS features list which the list or index records as requirements +for the image. This option is rarely used. + +#### **--os-version** + +Specify the OS version which the list or index records as a requirement for the +image. This option is rarely used. + +@@option variant.manifest + +## EXAMPLE + +``` +podman manifest annotate --arch arm64 --variant v8 mylist:v1.11 sha256:59eec8837a4d942cc19a52b8c09ea75121acc38114a2c68b98983ce9356b8610 +07ec8dc22b5dba3a33c60b68bce28bbd2b905e383fdb32a90708fa5eeac13a07: sha256:59eec8837a4d942cc19a52b8c09ea75121acc38114a2c68b98983ce9356b8610 +``` + +## SEE ALSO +**[podman(1)](podman.1.md)**, **[podman-manifest(1)](podman-manifest.1.md)** 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 -- cgit v1.2.3-54-g00ecf