Merge pull request #17772 from vrothberg/unhide-events-stream

podman events: unhide --stream
containers · Mar 14, 2023 · a453734 · a453734
2 parents 998acd7 + 4562e61
commit a453734
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/cmd/podman/system/events.go b/cmd/podman/system/events.go
@@ -72,7 +72,7 @@ func eventsFlags(cmd *cobra.Command) {
 	flags.StringVar(&eventFormat, formatFlagName, "", "format the output using a Go template")
 	_ = cmd.RegisterFlagCompletionFunc(formatFlagName, common.AutocompleteFormat(&events.Event{}))
 
-	flags.BoolVar(&eventOptions.Stream, "stream", true, "stream new events; for testing only")
+	flags.BoolVar(&eventOptions.Stream, "stream", true, "stream events and do not exit when returning the last known event")
 
 	sinceFlagName := "since"
 	flags.StringVar(&eventOptions.Since, sinceFlagName, "", "show all events created since timestamp")
@@ -83,8 +83,6 @@ func eventsFlags(cmd *cobra.Command) {
 	untilFlagName := "until"
 	flags.StringVar(&eventOptions.Until, untilFlagName, "", "show all events until timestamp")
 	_ = cmd.RegisterFlagCompletionFunc(untilFlagName, completion.AutocompleteNone)
-
-	_ = flags.MarkHidden("stream")
 }
 
 func eventsCmd(cmd *cobra.Command, _ []string) error {

diff --git a/docs/source/markdown/podman-events.1.md b/docs/source/markdown/podman-events.1.md
@@ -128,6 +128,9 @@ Do not truncate the output (default *true*).
 
 Show all events created since the given timestamp
 
+#### **--stream**
+
+Stream events and do not exit after reading the last known event (default *true*).
 
 #### **--until**=*timestamp*