From a90911aefa52d01b97a01a8d8a9eb32ba28c507b Mon Sep 17 00:00:00 2001 From: Geoff Franks Date: Tue, 17 Jun 2025 19:26:22 +0000 Subject: [PATCH] Update help messaging for bosh logs --jobs and bosh logs --only to explain the differences --- cmd/opts/opts.go | 4 ++-- cmd/opts/opts_test.go | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/cmd/opts/opts.go b/cmd/opts/opts.go index 44b9e6d3f..955ba3394 100644 --- a/cmd/opts/opts.go +++ b/cmd/opts/opts.go @@ -877,8 +877,8 @@ type LogsOpts struct { Num int `long:"num" description:"Last number of lines"` Quiet bool `long:"quiet" short:"q" description:"Suppresses printing of headers when multiple files are being examined"` - Jobs []string `long:"job" description:"Limit to only specific jobs"` - Filters []string `long:"only" description:"Filter logs (comma-separated)"` + Jobs []string `long:"job" description:"Limit to only specific jobs (can only be used in combination with --follow)"` + Filters []string `long:"only" description:"Filter logs to specific jobs (comma-separated). Like --jobs, but for when --follow is not being used"` Agent bool `long:"agent" description:"Include only agent logs"` System bool `long:"system" description:"Include only system logs"` All bool `long:"all-logs" description:"Include all logs (agent, system, and job logs)"` diff --git a/cmd/opts/opts_test.go b/cmd/opts/opts_test.go index 094a9e685..af38c7bef 100644 --- a/cmd/opts/opts_test.go +++ b/cmd/opts/opts_test.go @@ -2629,7 +2629,7 @@ var _ = Describe("Opts", func() { Describe("Jobs", func() { It("contains desired values", func() { Expect(getStructTagForName("Jobs", opts)).To(Equal( - `long:"job" description:"Limit to only specific jobs"`, + `long:"job" description:"Limit to only specific jobs (can only be used in combination with --follow)"`, )) }) }) @@ -2637,7 +2637,7 @@ var _ = Describe("Opts", func() { Describe("Filters", func() { It("contains desired values", func() { Expect(getStructTagForName("Filters", opts)).To(Equal( - `long:"only" description:"Filter logs (comma-separated)"`, + `long:"only" description:"Filter logs to specific jobs (comma-separated). Like --jobs, but for when --follow is not being used"`, )) }) })