Improve bosh scp -h

- It is non-obvious how to compose remote path references for the `bosh
  scp` command. This change provides a minimal example of a remote path
  reference (`:/some/remote/path`) when help for scp is invoked.  This
  example should be sufficient to allow a user to guess at what this
  command wants in order to target a remote path. It directs users to
  the documentation for further examples (as there are some other
  "special" parameters one can use with these path arguments that are
  not enumerated in the CLI help).

Author: ragaskar

cmd/opts/opts.go

@@ -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."`
 }
 
 type GatewayFlags struct {

cmd/opts/opts_test.go

@@ -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"`))
 			})
 		})
 	})