Skip to content

Commit

Permalink
"target" flag descriptions (#655)
Browse files Browse the repository at this point in the history
  • Loading branch information
allaVolkov authored and tal-sapan committed Jan 12, 2020
1 parent 2f1a590 commit ebba04d
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 23 deletions.
4 changes: 2 additions & 2 deletions cmd/assembly.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ var assembleCommand = &cobra.Command{

func init() {
assembleCommand.Flags().StringVarP(&assembleCmdSrc,
"source", "s", "", "The path to the MTA project; the current path is set as the default")
"source", "s", "", "The path to the MTA project; the current path is set as default")
assembleCommand.Flags().StringVarP(&assembleCmdTrg,
"target", "t", "", "The path to the results folder; the current path is set as the default")
"target", "t", "", `The path to the folder in which the MTAR file is created; the path to the "mta_archives" subfolder of the current folder is set as default`)
assembleCommand.Flags().StringSliceVarP(&assembleCmdExtensions, "extensions", "e", nil,
"The MTA extension descriptors")
assembleCommand.Flags().StringVarP(&assembleCmdMtarName,
Expand Down
6 changes: 3 additions & 3 deletions cmd/cmd.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,16 +43,16 @@ func init() {

// set flags of cleanup command
cleanupCmd.Flags().StringVarP(&cleanupCmdSrc, "source", "s", "",
"The path to the MTA project; the current path is set as the default")
"The path to the MTA project; the current path is set as default")
cleanupCmd.Flags().StringVarP(&cleanupCmdTrg, "target", "t", "",
"The path to the results folder; the current path is set as the default")
"The path to the folder in which the temporary artifacts were created; the current path is set as default")
cleanupCmd.Flags().StringVarP(&cleanupCmdDesc, "desc", "d", "",
`The MTA descriptor; supported values: "dev" (development descriptor, default value) and "dep" (deployment descriptor)`)
cleanupCmd.Flags().BoolP("help", "h", false, `Displays detailed information about the "cleanup" command`)

// set flags of validation command
validateCmd.Flags().StringVarP(&validateCmdSrc, "source", "s", "",
"The path to the MTA project; the current path is set as the default")
"The path to the MTA project; the current path is set as default")
validateCmd.Flags().StringVarP(&validateCmdMode, "mode", "m", "",
`The validation mode; supported values: "schema", "semantic" (default)`)
validateCmd.Flags().StringVarP(&validateCmdDesc, "desc", "d", "",
Expand Down
12 changes: 6 additions & 6 deletions cmd/gen.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ func init() {

// set flags of mtad command
mtadCmd.Flags().StringVarP(&mtadCmdSrc, "source", "s", "",
"The path to the MTA project; the current path is set as the default")
"The path to the MTA project; the current path is set as default")
mtadCmd.Flags().StringVarP(&mtadCmdTrg, "target", "t",
"", "The path to the results folder; the current path is set as the default")
"", "The path to the folder in which the 'mtad.yaml' file is generated; the current path is set as default")
mtadCmd.Flags().StringSliceVarP(&mtadCmdExtensions, "extensions", "e", nil,
"The MTA extension descriptors")
mtadCmd.Flags().StringVarP(&mtadCmdPlatform, "platform", "p", "cf",
Expand All @@ -45,9 +45,9 @@ func init() {

// set flags of meta command
metaCmd.Flags().StringVarP(&metaCmdSrc, "source", "s", "",
"The path to the MTA project; the current path is set as the default")
"The path to the MTA project; the current path is set as default")
metaCmd.Flags().StringVarP(&metaCmdTrg, "target", "t", "",
"The path to the results folder; the current path is set as the default")
"The path to the folder in which a temporary folder with generated metadata is created; the current path is set as default")
metaCmd.Flags().StringVarP(&metaCmdDesc, "desc", "d", "",
`The MTA descriptor; supported values: "dev" (development descriptor, default value) and "dep" (deployment descriptor)`)
metaCmd.Flags().StringSliceVarP(&metaCmdExtensions, "extensions", "e", nil,
Expand All @@ -58,9 +58,9 @@ func init() {

// set flags of mtar command
mtarCmd.Flags().StringVarP(&mtarCmdSrc, "source", "s", "",
"The path to the MTA project; the current path is set as the default")
"The path to the MTA project; the current path is set as default")
mtarCmd.Flags().StringVarP(&mtarCmdTrg, "target", "t", "",
"The path to the results folder; the current path is set as the default")
`The path to the folder in which the MTAR file is created; the path to the "mta_archives" subfolder of the current folder is set as default`)
mtarCmd.Flags().StringVarP(&mtarCmdDesc, "desc", "d", "",
`The MTA descriptor; supported values: "dev" (development descriptor, default value) and "dep" (deployment descriptor)`)
mtarCmd.Flags().StringSliceVarP(&mtarCmdExtensions, "extensions", "e", nil,
Expand Down
8 changes: 4 additions & 4 deletions cmd/init.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,16 @@ var buildCmdOutputSync bool

func init() {
// set flags for init command
initCmd.Flags().StringVarP(&initCmdSrc, "source", "s", "", "The path to the MTA project; the current path is set as the default")
initCmd.Flags().StringVarP(&initCmdTrg, "target", "t", "", "The path to the generated Makefile folder; the current path is set as the default")
initCmd.Flags().StringVarP(&initCmdSrc, "source", "s", "", "The path to the MTA project; the current path is set as default")
initCmd.Flags().StringVarP(&initCmdTrg, "target", "t", "", "The path to the folder in which the Makefile is generated; the current path is set as default")
initCmd.Flags().StringSliceVarP(&initCmdExtensions, "extensions", "e", nil, "The MTA extension descriptors")
initCmd.Flags().StringVarP(&initCmdMode, "mode", "m", "", `The mode of the Makefile generation; supported values: "default" and "verbose"`)
_ = initCmd.Flags().MarkHidden("mode")
initCmd.Flags().BoolP("help", "h", false, `Displays detailed information about the "init" command`)

// set flags of build command
buildCmd.Flags().StringVarP(&buildCmdSrc, "source", "s", "", "The path to the MTA project; the current path is set as the default")
buildCmd.Flags().StringVarP(&buildCmdTrg, "target", "t", "", "The path to the results folder; the current path is set as the default")
buildCmd.Flags().StringVarP(&buildCmdSrc, "source", "s", "", "The path to the MTA project; the current path is set as default")
buildCmd.Flags().StringVarP(&buildCmdTrg, "target", "t", "", `The path to the folder in which the MTAR file is created; the path to the "mta_archives" subfolder of the current folder is set as default`)
buildCmd.Flags().StringSliceVarP(&buildCmdExtensions, "extensions", "e", nil, "The MTA extension descriptors")
buildCmd.Flags().StringVarP(&buildCmdMtar, "mtar", "", "", "The file name of the generated archive file")
buildCmd.Flags().StringVarP(&buildCmdPlatform, "platform", "p", "cf", `The deployment platform; supported platforms: "cf", "xsa", "neo"`)
Expand Down
4 changes: 2 additions & 2 deletions cmd/merge.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ var mergeCmd = &cobra.Command{
func init() {
// set flag of merge command
mergeCmd.Flags().StringVarP(&mergeCmdSrc, "source", "s", "",
"The path to the MTA project; the current path is set as the default")
"The path to the MTA project; the current path is set as default")
mergeCmd.Flags().StringVarP(&mergeCmdTrg, "target", "t",
"", "The path to the results folder; the current path is set as the default")
"", "The path to the folder in which the merged file is generated")
mergeCmd.Flags().StringSliceVarP(&mergeCmdExtensions, "extensions", "e", nil,
"The MTA extension descriptors")
mergeCmd.Flags().StringVarP(&mergeCmdName, "target-file-name", "n", "",
Expand Down
8 changes: 4 additions & 4 deletions cmd/module.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ func init() {

// sets the flags of of the command pack module
packModuleCmd.Flags().StringVarP(&packCmdSrc, "source", "s", "",
"The path to the MTA project; the current path is is set as the default")
"The path to the MTA project; the current path is is set as default")
packModuleCmd.Flags().StringVarP(&packCmdTrg, "target", "t", "",
"The path to the results folder; the current path is set as the default")
"The path to the folder in which the temporary artifacts of the module pack are created; the current path is is set as default")
packModuleCmd.Flags().StringSliceVarP(&packCmdExtensions, "extensions", "e", nil,
"The MTA extension descriptors")
packModuleCmd.Flags().StringVarP(&packCmdModule, "module", "m", "",
Expand All @@ -38,9 +38,9 @@ func init() {

// sets the flags of the command build module
buildModuleCmd.Flags().StringVarP(&buildModuleCmdSrc, "source", "s", "",
"The path to the MTA project; the current path is set as the default")
"The path to the MTA project; the current path is set as default")
buildModuleCmd.Flags().StringVarP(&buildModuleCmdTrg, "target", "t", "",
"The path to the results folder; the current path is set as the default")
"The path to the folder in which the temporary artifacts of the module build are created; the current path is set as default")
buildModuleCmd.Flags().StringSliceVarP(&buildModuleCmdExtensions, "extensions", "e", nil,
"The MTA extension descriptors")
buildModuleCmd.Flags().StringVarP(&buildModuleCmdModule, "module", "m", "",
Expand Down
4 changes: 2 additions & 2 deletions cmd/project.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ var projectBuildCmdPhase string

func init() {
projectBuildCmd.Flags().StringVarP(&projectBuildCmdSrc,
"source", "s", "", "The path to the MTA project; the current path is set as the default")
"source", "s", "", "The path to the MTA project; the current path is set as default")
projectBuildCmd.Flags().StringVarP(&projectBuildCmdTrg,
"target", "t", "", "The path to the results folder; the current path is set as the default")
"target", "t", "", "The path to the folder in which the temporary artifacts of the project build are created; the current path is set as default")
projectBuildCmd.Flags().StringVarP(&projectBuildCmdDesc,
"desc", "d", "", `The MTA descriptor; supported values: "dev" (development descriptor, default value) and "dep" (deployment descriptor)`)
projectBuildCmd.Flags().StringSliceVarP(&projectBuildCmdExtensions, "extensions", "e", nil,
Expand Down

0 comments on commit ebba04d

Please sign in to comment.