From 309f4fb543f47905c79261c19ca197b4a226abe4 Mon Sep 17 00:00:00 2001 From: Ed Santiago Date: Mon, 26 Sep 2022 14:08:44 -0600 Subject: Man pages: refactor common options: --log-opt Simple in reality, but hard to review due to lots of little diffs: - "Logging driver specific options" was only in podman-run; I added it to create and kube-play. - whitespace changes, the 'e.g.'s got consistent 4-space indentation - the "same keys" and "supported only" sentences, I moved up to be closer to **tag** and without intervening whitespace, because they were unclear as they were: I believe the intent is to apply those sentences only to **tag**, not to the **--log-opt** option itself. Signed-off-by: Ed Santiago --- docs/source/markdown/options/log-opt.md | 16 ++++++++++++++++ docs/source/markdown/podman-create.1.md.in | 17 +---------------- docs/source/markdown/podman-kube-play.1.md.in | 17 +---------------- docs/source/markdown/podman-run.1.md.in | 17 +---------------- 4 files changed, 19 insertions(+), 48 deletions(-) create mode 100644 docs/source/markdown/options/log-opt.md 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=\