aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2022-09-29 17:35:40 +0200
committerGitHub <noreply@github.com>2022-09-29 17:35:40 +0200
commit00f0bb516cf2fb26917307d1639edb20e92e5363 (patch)
tree5242b0fb59ffa663bb3153e56660a2d4d121ae5a
parent4c39b391036c8383825b76ad0e2edf1efb53b4da (diff)
parent309f4fb543f47905c79261c19ca197b4a226abe4 (diff)
downloadpodman-00f0bb516cf2fb26917307d1639edb20e92e5363.tar.gz
podman-00f0bb516cf2fb26917307d1639edb20e92e5363.tar.bz2
podman-00f0bb516cf2fb26917307d1639edb20e92e5363.zip
Merge pull request #15996 from edsantiago/docs_dedup_log-opt
[CI:DOCS] Man pages: refactor common options: --log-opt
-rw-r--r--docs/source/markdown/options/log-opt.md16
-rw-r--r--docs/source/markdown/podman-create.1.md.in17
-rw-r--r--docs/source/markdown/podman-kube-play.1.md.in17
-rw-r--r--docs/source/markdown/podman-run.1.md.in17
4 files changed, 19 insertions, 48 deletions
diff --git a/docs/source/markdown/options/log-opt.md b/docs/source/markdown/options/log-opt.md
new file mode 100644
index 000000000..4eafc1fb0
--- /dev/null
+++ b/docs/source/markdown/options/log-opt.md
@@ -0,0 +1,16 @@
+#### **--log-opt**=*name=value*
+
+Logging driver specific options.
+
+Set custom logging configuration. The following *name*s are supported:
+
+**path**: specify a path to the log file
+ (e.g. **--log-opt path=/var/log/container/mycontainer.json**);
+
+**max-size**: specify a max size of the log file
+ (e.g. **--log-opt max-size=10mb**);
+
+**tag**: specify a custom log tag for the container
+ (e.g. **--log-opt tag="{{.ImageName}}"**.
+It supports the same keys as **podman inspect --format**.
+This option is currently supported only by the **journald** log driver.
diff --git a/docs/source/markdown/podman-create.1.md.in b/docs/source/markdown/podman-create.1.md.in
index 351124dc4..102215585 100644
--- a/docs/source/markdown/podman-create.1.md.in
+++ b/docs/source/markdown/podman-create.1.md.in
@@ -228,22 +228,7 @@ pod when that pod is not running.
@@option log-driver
-#### **--log-opt**=*name=value*
-
-Set custom logging configuration. The following *name*s are supported:
-
-- **path**: specify a path to the log file
-(e.g. **--log-opt path=/var/log/container/mycontainer.json**);
-
-- **max-size**: specify a max size of the log file
-(e.g. **--log-opt max-size=10mb**);
-
-- **tag**: specify a custom log tag for the container
-(e.g. **--log-opt tag="{{.ImageName}}"**.
-
-It supports the same keys as **podman inspect --format**.
-
-This option is currently supported only by the **journald** log driver.
+@@option log-opt
@@option mac-address
diff --git a/docs/source/markdown/podman-kube-play.1.md.in b/docs/source/markdown/podman-kube-play.1.md.in
index 3bbe8113a..cc7934b5d 100644
--- a/docs/source/markdown/podman-kube-play.1.md.in
+++ b/docs/source/markdown/podman-kube-play.1.md.in
@@ -146,22 +146,7 @@ Note: When joining multiple networks you should use the **--network name:ip=\<ip
Set logging driver for all created containers.
-#### **--log-opt**=*name=value*
-
-Set custom logging configuration. The following *name*s are supported:
-
-- **path**: specify a path to the log file
-(e.g. **--log-opt path=/var/log/container/mycontainer.json**);
-
-- **max-size**: specify a max size of the log file
-(e.g. **--log-opt max-size=10mb**);
-
-- **tag**: specify a custom log tag for the container
-(e.g. **--log-opt tag="{{.ImageName}}"**.
-
-It supports the same keys as **podman inspect --format**.
-
-This option is currently supported only by the **journald** log driver.
+@@option log-opt
#### **--mac-address**=*MAC address*
diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in
index 95ee595d9..57474975a 100644
--- a/docs/source/markdown/podman-run.1.md.in
+++ b/docs/source/markdown/podman-run.1.md.in
@@ -249,22 +249,7 @@ Print usage statement
@@option log-driver
-#### **--log-opt**=*name=value*
-
-Logging driver specific options.
-
-Set custom logging configuration. The following *name*s are supported:
-
-**path**: specify a path to the log file
- (e.g. **--log-opt path=/var/log/container/mycontainer.json**);
-
-**max-size**: specify a max size of the log file
- (e.g. **--log-opt max-size=10mb**);
-
-**tag**: specify a custom log tag for the container
- (e.g. **--log-opt tag="{{.ImageName}}"**.
-
-This option is currently supported only by the **journald** log driver.
+@@option log-opt
@@option mac-address