From 99cbe59917ada7896b3f4c3252d91af6768c2e9b Mon Sep 17 00:00:00 2001 From: Valentin Rothberg Date: Tue, 9 Jun 2020 16:28:13 +0200 Subject: [PATCH] podman-events: clarify streaming behaviour Unless `--since` or `--until` is specified, `podman events` will stream new events. Clarify this behavior in the `--help` message and man page to avoid confusion. Fixes: #6536 Signed-off-by: Valentin Rothberg --- cmd/podman/system/events.go | 6 ++++-- docs/source/markdown/podman-events.1.md | 2 ++ 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/cmd/podman/system/events.go b/cmd/podman/system/events.go index 27e80138ec..c401c5a929 100644 --- a/cmd/podman/system/events.go +++ b/cmd/podman/system/events.go @@ -17,8 +17,10 @@ import ( ) var ( - eventsDescription = "Monitor podman events" - eventsCommand = &cobra.Command{ + eventsDescription = `Monitor podman events. + + By default, streaming mode is used, printing new events as they occur. Previous events can be listed via --since and --until.` + eventsCommand = &cobra.Command{ Use: "events", Args: validate.NoArgs, Short: "Show podman events", diff --git a/docs/source/markdown/podman-events.1.md b/docs/source/markdown/podman-events.1.md index a05047684d..abfc6e9c1d 100644 --- a/docs/source/markdown/podman-events.1.md +++ b/docs/source/markdown/podman-events.1.md @@ -15,6 +15,8 @@ value to `file`. Only `file` and `journald` are accepted. A `none` logger is al available but this logging mechanism completely disables events; nothing will be reported by `podman events`. +By default, streaming mode is used, printing new events as they occur. Previous events can be listed via `--since` and `--until`. + The *container* event type will report the follow statuses: * attach * checkpoint