Skip to content

Update help messaging for bosh logs --jobs and bosh logs --only to explain the differences #691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
selzoc merged 1 commit into from
Jun 17, 2025
Merged

Update help messaging for bosh logs --jobs and bosh logs --only to explain the differences #691

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions cmd/opts/opts.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)"`
Expand Down
4 changes: 2 additions & 2 deletions cmd/opts/opts_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2629,15 +2629,15 @@ 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)"`,
))
})
})

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"`,
))
})
})
Expand Down