Skip to content

Improve bosh scp -h #693

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
rkoster merged 4 commits into from
Oct 11, 2025
Merged

Improve bosh scp -h #693

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a6c318d
Improve `bosh scp -h`
ragaskar Aug 19, 2025
c3e0b31
Apply suggestion from @peanball
rkoster Sep 25, 2025
728230a
fix: resolve linting errors in struct tag for bosh scp help
rubionic Oct 10, 2025
9fccd54
Merge pull request #698 from rubionic/improve_help_scp_linting_fix
rkoster Oct 10, 2025
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
2 changes: 1 addition & 1 deletion cmd/opts/opts.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1019,7 +1019,7 @@ type SCPOpts struct {
}

type SCPArgs struct {
Paths []string `positional-arg-name:"PATH"`
Paths []string `positional-arg-name:"PATH" description:"Strings referencing remote (e.g. \":/some/remote/path\" -- \"user@host\" may be omitted) or local paths (e.g. \"./some/local/path\"). See CLI documentation for more examples."`
Comment thread
rkoster marked this conversation as resolved.
Outdated
Copy link
Copy Markdown

@a-hassanin a-hassanin Sep 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually IMHO I would rather name it differently:
Usage:
bosh [OPTIONS] scp [scp-OPTIONS] source ... target

The same way a typical scp command would also describe it. I see it is technically one array, but it better describes how it can actually be used

Copy link
Copy Markdown
Contributor

@rkoster rkoster Sep 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ragaskar do you have any opinion on this?

Copy link
Copy Markdown
Member

@aramprice aramprice Sep 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ragaskar - are you ok with switching the the scp style documentation, instead of the example-based version in this PR?

}

type GatewayFlags struct {
Expand Down
2 changes: 1 addition & 1 deletion cmd/opts/opts_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2912,7 +2912,7 @@ var _ = Describe("Opts", func() {

Describe("Paths", func() {
It("contains desired values", func() {
Expect(getStructTagForName("Paths", opts)).To(Equal(`positional-arg-name:"PATH"`))
Expect(getStructTagForName("Paths", opts)).To(ContainSubstring(`positional-arg-name:"PATH"`))
})
})
})
Expand Down
Loading