diff options
| author | Ed Santiago <santiago@redhat.com> | 2022-08-15 13:21:37 -0600 |
|---|---|---|
| committer | Ed Santiago <santiago@redhat.com> | 2022-08-16 07:04:48 -0600 |
| commit | a78b67a47bf889b76383d09bce0127f5f397cd25 (patch) | |
| tree | 81dcbe0366d029b1c0b2ff66239d93f96ce218cc /docs | |
| parent | 311b5946f74c94c5d6024c904abf6976c75e4d8f (diff) | |
| download | podman-a78b67a47bf889b76383d09bce0127f5f397cd25.tar.gz podman-a78b67a47bf889b76383d09bce0127f5f397cd25.tar.bz2 podman-a78b67a47bf889b76383d09bce0127f5f397cd25.zip | |
Man pages: refactor common options: --annotation
Refactor the --annotation option, but only between podman create,
kube play, and run.
This does not include:
* podman build:
- usage is in terms of images, not containers/pods
* manifest add, manifest annotate:
- usage is in terms of images, not containers/pods
- also, wording is slightly different
Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/markdown/options/annotation.container.md | 3 | ||||
| -rw-r--r-- | docs/source/markdown/podman-create.1.md.in | 5 | ||||
| -rw-r--r-- | docs/source/markdown/podman-kube-play.1.md.in | 5 | ||||
| -rw-r--r-- | docs/source/markdown/podman-run.1.md.in | 5 |
4 files changed, 6 insertions, 12 deletions
diff --git a/docs/source/markdown/options/annotation.container.md b/docs/source/markdown/options/annotation.container.md new file mode 100644 index 000000000..bd561a15f --- /dev/null +++ b/docs/source/markdown/options/annotation.container.md @@ -0,0 +1,3 @@ +#### **--annotation**=*key=value* + +Add an annotation to the container<| or pod>. This option can be set multiple times. diff --git a/docs/source/markdown/podman-create.1.md.in b/docs/source/markdown/podman-create.1.md.in index 45dfe304c..f5301c60a 100644 --- a/docs/source/markdown/podman-create.1.md.in +++ b/docs/source/markdown/podman-create.1.md.in @@ -68,10 +68,7 @@ and specified with a _tag_. @@option add-host -#### **--annotation**=*key=value* - -Add an annotation to the container. The format is key=value. -The **--annotation** option can be set multiple times. +@@option annotation.container @@option arch diff --git a/docs/source/markdown/podman-kube-play.1.md.in b/docs/source/markdown/podman-kube-play.1.md.in index 9e9fc7f38..1da848b15 100644 --- a/docs/source/markdown/podman-kube-play.1.md.in +++ b/docs/source/markdown/podman-kube-play.1.md.in @@ -110,10 +110,7 @@ and as a result environment variable `FOO` will be set to `bar` for container `c ## OPTIONS -#### **--annotation**=*key=value* - -Add an annotation to the container or pod. The format is key=value. -The **--annotation** option can be set multiple times. +@@option annotation.container #### **--authfile**=*path* diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in index df9f1c28a..81b635bc8 100644 --- a/docs/source/markdown/podman-run.1.md.in +++ b/docs/source/markdown/podman-run.1.md.in @@ -85,10 +85,7 @@ and specified with a _tag_. ## OPTIONS @@option add-host -#### **--annotation**=*key=value* - -Add an annotation to the container. -This option can be set multiple times. +@@option annotation.container @@option arch |