summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2022-09-01 12:41:03 -0600
committerEd Santiago <santiago@redhat.com>2022-09-03 05:49:52 -0600
commitb9df3a6a9f9f68e8ddb1a46e49fb19783187810e (patch)
treeccc1d7566924cf7ae9ee3943d23066284c099d5b /docs
parente136bcc7c97ed9a7576417259cf93f7209f45dd2 (diff)
downloadpodman-b9df3a6a9f9f68e8ddb1a46e49fb19783187810e.tar.gz
podman-b9df3a6a9f9f68e8ddb1a46e49fb19783187810e.tar.bz2
podman-b9df3a6a9f9f68e8ddb1a46e49fb19783187810e.zip
Man pages: refactor common options: --label
Went with the podman-run version, where the "example" is in the option template as per our guidelines. I could not include the network- or volume-create man pages, nor podman build. Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/source/markdown/options/label.md3
-rw-r--r--docs/source/markdown/podman-create.1.md.in4
-rw-r--r--docs/source/markdown/podman-pod-clone.1.md.in4
-rw-r--r--docs/source/markdown/podman-pod-create.1.md.in4
-rw-r--r--docs/source/markdown/podman-run.1.md.in4
5 files changed, 7 insertions, 12 deletions
diff --git a/docs/source/markdown/options/label.md b/docs/source/markdown/options/label.md
new file mode 100644
index 000000000..629aa82e6
--- /dev/null
+++ b/docs/source/markdown/options/label.md
@@ -0,0 +1,3 @@
+#### **--label**, **-l**=*key=value*
+
+Add metadata to a <<container|pod>>.
diff --git a/docs/source/markdown/podman-create.1.md.in b/docs/source/markdown/podman-create.1.md.in
index 4fe50caed..25726af8c 100644
--- a/docs/source/markdown/podman-create.1.md.in
+++ b/docs/source/markdown/podman-create.1.md.in
@@ -260,9 +260,7 @@ To specify multiple static IPv6 addresses per container, set multiple networks u
@@option ipc
-#### **--label**, **-l**=*label*
-
-Add metadata to a container (e.g., --label com.example.key=value)
+@@option label
@@option label-file
diff --git a/docs/source/markdown/podman-pod-clone.1.md.in b/docs/source/markdown/podman-pod-clone.1.md.in
index 24edc44ec..e2e08d2a6 100644
--- a/docs/source/markdown/podman-pod-clone.1.md.in
+++ b/docs/source/markdown/podman-pod-clone.1.md.in
@@ -66,9 +66,7 @@ Print usage statement.
@@option infra-name
-#### **--label**, **-l**=*label*
-
-Add metadata to a pod (e.g., --label com.example.key=value).
+@@option label
@@option label-file
diff --git a/docs/source/markdown/podman-pod-create.1.md.in b/docs/source/markdown/podman-pod-create.1.md.in
index 35d06fa00..f3d6884c5 100644
--- a/docs/source/markdown/podman-pod-create.1.md.in
+++ b/docs/source/markdown/podman-pod-create.1.md.in
@@ -130,9 +130,7 @@ The address must be within the network's IPv6 address pool.
To specify multiple static IPv6 addresses per pod, set multiple networks using the **--network** option with a static IPv6 address specified for each using the `ip6` mode for that option.
-#### **--label**, **-l**=*label*
-
-Add metadata to a pod (e.g., --label com.example.key=value).
+@@option label
@@option label-file
diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in
index 64affa238..a32bf4781 100644
--- a/docs/source/markdown/podman-run.1.md.in
+++ b/docs/source/markdown/podman-run.1.md.in
@@ -280,9 +280,7 @@ To specify multiple static IPv6 addresses per container, set multiple networks u
@@option ipc
-#### **--label**, **-l**=*key=value*
-
-Add metadata to a container.
+@@option label
@@option label-file