Skip to content

Commit

Permalink
cli: improve usage formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
fho committed Feb 16, 2024
1 parent ddba773 commit 9eead9c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
1 change: 1 addition & 0 deletions internal/cmd/export.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ const exportCmdShortHelp = "Read dependency definitions and export them to a fil
var exportCmdLongHelp = exportCmdShortHelp + "\n\n" +
`Positional Arguments:
` + descRootDirArg + `
` + descrDependencyFileNames

type exportCmd struct {
Expand Down
6 changes: 3 additions & 3 deletions internal/cmd/order.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,8 @@ const orderShortHelp = "Generate a deployment order."

var descrDependencyFileNames = strings.TrimSpace(`
Dependency yaml configuration files are discovered by searching in all child
directories of ROOT-DIR.
Files that match the path suffix specified via --cfg-name are parsed.
Symlinks in ROOT-DIR are not followed.
directories of ROOT-DIR. Files that match the path suffix specified via
--cfg-name are parsed. Symlinks in ROOT-DIR are not followed.
`)

const descRootDirArg = ` ROOT-DIR - Parent directory in which dependency configuration files are discovered.`
Expand All @@ -28,6 +27,7 @@ var orderLongHelp = orderShortHelp + "\n\n" + strings.TrimSpace(`
Positional Arguments:
`+descRootDirArg+`
DEP-TREE-FILE - Path to an exported dependency tree.
The command can use as input either a marshalled dependency-tree file (DEP-TREE-FILE)
or read and parse YAML configuration files that are found in the child directories of
ROOT-DIR to generate a dependency-tree.
Expand Down

0 comments on commit 9eead9c

Please sign in to comment.