From 74c348c272810047edc71de22224300225291bb9 Mon Sep 17 00:00:00 2001 From: venkatbandarupalli Date: Mon, 8 May 2023 10:31:34 -0500 Subject: [PATCH 1/2] docs: add vcs url as part of usage informtion Signed-off-by: venkatbandarupalli --- cmd/plan.go | 4 ++-- cmd/transform.go | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/cmd/plan.go b/cmd/plan.go index 683f9342f..b34ea6e73 100644 --- a/cmd/plan.go +++ b/cmd/plan.go @@ -170,10 +170,10 @@ func GetPlanCommand() *cobra.Command { Run: func(cmd *cobra.Command, _ []string) { planHandler(cmd, flags) }, } - planCmd.Flags().StringVarP(&flags.srcpath, sourceFlag, "s", "", "Specify source directory.") + planCmd.Flags().StringVarP(&flags.srcpath, sourceFlag, "s", "", "Specify source directory or a VCS url.") planCmd.Flags().StringVarP(&flags.planfile, planFlag, "p", common.DefaultPlanFile, "Specify a file path to save plan to.") planCmd.Flags().StringVarP(&flags.name, nameFlag, "n", common.DefaultProjectName, "Specify the project name.") - planCmd.Flags().StringVarP(&flags.customizationsPath, customizationsFlag, "c", "", "Specify directory where customizations are stored. By default we look for "+common.DefaultCustomizationDir) + planCmd.Flags().StringVarP(&flags.customizationsPath, customizationsFlag, "c", "", "Specify directory or a VCS url where customizations are stored. By default we look for "+common.DefaultCustomizationDir) planCmd.Flags().StringSliceVarP(&flags.configs, configFlag, "f", []string{}, "Specify config file locations. By default we look for "+common.DefaultConfigFilePath) planCmd.Flags().StringVarP(&flags.transformerSelector, transformerSelectorFlag, "t", "", "Specify the transformer selector.") planCmd.Flags().StringSliceVar(&flags.preSets, preSetFlag, []string{}, "Specify preset config to use.") diff --git a/cmd/transform.go b/cmd/transform.go index bdeadb3fc..0d821ac50 100644 --- a/cmd/transform.go +++ b/cmd/transform.go @@ -215,7 +215,7 @@ func GetTransformCommand() *cobra.Command { // Basic options transformCmd.Flags().StringVarP(&flags.planfile, planFlag, "p", common.DefaultPlanFile, "Specify a plan file to execute.") transformCmd.Flags().BoolVar(&flags.overwrite, overwriteFlag, false, "Overwrite the output directory if it exists. By default we don't overwrite.") - transformCmd.Flags().StringVarP(&flags.srcpath, sourceFlag, "s", "", "Specify source directory to transform. If you already have a m2k.plan then this will override the sourceDir value specified in that plan.") + transformCmd.Flags().StringVarP(&flags.srcpath, sourceFlag, "s", "", "Specify source directory or a VCS url to transform. If you already have a m2k.plan then this will override the sourceDir value specified in that plan.") transformCmd.Flags().StringVarP(&flags.outpath, outputFlag, "o", ".", "Path for output. Default will be directory with the project name.") transformCmd.Flags().StringVarP(&flags.name, nameFlag, "n", common.DefaultProjectName, "Specify the project name.") transformCmd.Flags().StringVar(&flags.configOut, configOutFlag, ".", "Specify config file output location.") @@ -224,7 +224,7 @@ func GetTransformCommand() *cobra.Command { transformCmd.Flags().StringSliceVar(&flags.preSets, preSetFlag, []string{}, "Specify preset config to use.") transformCmd.Flags().BoolVar(&flags.persistPasswords, qaPersistPasswords, false, "Store passwords in the config and cache. By default passwords are not persisted.") transformCmd.Flags().StringArrayVar(&flags.setconfigs, setConfigFlag, []string{}, "Specify config key-value pairs.") - transformCmd.Flags().StringVarP(&flags.customizationsPath, customizationsFlag, "c", "", "Specify directory where customizations are stored. By default we look for "+common.DefaultCustomizationDir) + transformCmd.Flags().StringVarP(&flags.customizationsPath, customizationsFlag, "c", "", "Specify directory or a VCS url where customizations are stored. By default we look for "+common.DefaultCustomizationDir) transformCmd.Flags().StringVarP(&flags.transformerSelector, transformerSelectorFlag, "t", "", "Specify the transformer selector.") transformCmd.Flags().BoolVar(&flags.qaskip, qaSkipFlag, false, "Enable/disable the default answers to questions posed in QA Cli sub-system. If disabled, you will have to answer the questions posed by QA during interaction.") From 0124aa320c2ea413edbdbba7e8f3b25c37c1abe3 Mon Sep 17 00:00:00 2001 From: venkatbandarupalli Date: Thu, 11 May 2023 18:07:38 -0500 Subject: [PATCH 2/2] fixup! docs: add vcs url as part of usage informtion Signed-off-by: venkatbandarupalli --- cmd/plan.go | 4 ++-- cmd/transform.go | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/cmd/plan.go b/cmd/plan.go index b34ea6e73..4f6799190 100644 --- a/cmd/plan.go +++ b/cmd/plan.go @@ -170,10 +170,10 @@ func GetPlanCommand() *cobra.Command { Run: func(cmd *cobra.Command, _ []string) { planHandler(cmd, flags) }, } - planCmd.Flags().StringVarP(&flags.srcpath, sourceFlag, "s", "", "Specify source directory or a VCS url.") + planCmd.Flags().StringVarP(&flags.srcpath, sourceFlag, "s", "", "Specify source directory or a git url (see https://move2kube.konveyor.io/concepts/git-support).") planCmd.Flags().StringVarP(&flags.planfile, planFlag, "p", common.DefaultPlanFile, "Specify a file path to save plan to.") planCmd.Flags().StringVarP(&flags.name, nameFlag, "n", common.DefaultProjectName, "Specify the project name.") - planCmd.Flags().StringVarP(&flags.customizationsPath, customizationsFlag, "c", "", "Specify directory or a VCS url where customizations are stored. By default we look for "+common.DefaultCustomizationDir) + planCmd.Flags().StringVarP(&flags.customizationsPath, customizationsFlag, "c", "", "Specify directory or a git url (see https://move2kube.konveyor.io/concepts/git-support) where customizations are stored. By default we look for "+common.DefaultCustomizationDir) planCmd.Flags().StringSliceVarP(&flags.configs, configFlag, "f", []string{}, "Specify config file locations. By default we look for "+common.DefaultConfigFilePath) planCmd.Flags().StringVarP(&flags.transformerSelector, transformerSelectorFlag, "t", "", "Specify the transformer selector.") planCmd.Flags().StringSliceVar(&flags.preSets, preSetFlag, []string{}, "Specify preset config to use.") diff --git a/cmd/transform.go b/cmd/transform.go index 0d821ac50..f4abb2a2b 100644 --- a/cmd/transform.go +++ b/cmd/transform.go @@ -215,7 +215,7 @@ func GetTransformCommand() *cobra.Command { // Basic options transformCmd.Flags().StringVarP(&flags.planfile, planFlag, "p", common.DefaultPlanFile, "Specify a plan file to execute.") transformCmd.Flags().BoolVar(&flags.overwrite, overwriteFlag, false, "Overwrite the output directory if it exists. By default we don't overwrite.") - transformCmd.Flags().StringVarP(&flags.srcpath, sourceFlag, "s", "", "Specify source directory or a VCS url to transform. If you already have a m2k.plan then this will override the sourceDir value specified in that plan.") + transformCmd.Flags().StringVarP(&flags.srcpath, sourceFlag, "s", "", "Specify source directory or a git url (see https://move2kube.konveyor.io/concepts/git-support) to transform. If you already have a m2k.plan then this will override the sourceDir value specified in that plan.") transformCmd.Flags().StringVarP(&flags.outpath, outputFlag, "o", ".", "Path for output. Default will be directory with the project name.") transformCmd.Flags().StringVarP(&flags.name, nameFlag, "n", common.DefaultProjectName, "Specify the project name.") transformCmd.Flags().StringVar(&flags.configOut, configOutFlag, ".", "Specify config file output location.") @@ -224,7 +224,7 @@ func GetTransformCommand() *cobra.Command { transformCmd.Flags().StringSliceVar(&flags.preSets, preSetFlag, []string{}, "Specify preset config to use.") transformCmd.Flags().BoolVar(&flags.persistPasswords, qaPersistPasswords, false, "Store passwords in the config and cache. By default passwords are not persisted.") transformCmd.Flags().StringArrayVar(&flags.setconfigs, setConfigFlag, []string{}, "Specify config key-value pairs.") - transformCmd.Flags().StringVarP(&flags.customizationsPath, customizationsFlag, "c", "", "Specify directory or a VCS url where customizations are stored. By default we look for "+common.DefaultCustomizationDir) + transformCmd.Flags().StringVarP(&flags.customizationsPath, customizationsFlag, "c", "", "Specify directory or a git url (see https://move2kube.konveyor.io/concepts/git-support) where customizations are stored. By default we look for "+common.DefaultCustomizationDir) transformCmd.Flags().StringVarP(&flags.transformerSelector, transformerSelectorFlag, "t", "", "Specify the transformer selector.") transformCmd.Flags().BoolVar(&flags.qaskip, qaSkipFlag, false, "Enable/disable the default answers to questions posed in QA Cli sub-system. If disabled, you will have to answer the questions posed by QA during interaction.")