From 17ed370de6076290d65b0d6ae687bae37fa522b4 Mon Sep 17 00:00:00 2001
From: dwelch-spike <53876192+dwelch-spike@users.noreply.github.com>
Date: Mon, 13 Nov 2023 09:43:36 -0800
Subject: [PATCH] docs: clairfy the use of the --aerospike-version option (#21)

---
 cmd/convert.go | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/cmd/convert.go b/cmd/convert.go
index df868bb..cb7b6bb 100644
--- a/cmd/convert.go
+++ b/cmd/convert.go
@@ -39,6 +39,8 @@ func newConvertCmd() *cobra.Command {
 		Short: "Convert between yaml and Aerospike config format.",
 		Long: `Convert is used to convert between yaml and aerospike configuration
 				files. Input files are converted to their opposite format, yaml -> conf, conf -> yaml.
+				The convert command validates the configuration file for compatibility with the Aerospike
+				version passed to the --aerospike-version option, unless the --force option is used.
 				Specifying the server version that will use the aerospike.conf is required.
 				Usage examples...
 				convert local file "aerospike.yaml" to aerospike config format for version 6.2.0 and
@@ -220,7 +222,7 @@ func newConvertCmd() *cobra.Command {
 
 	// flags and configuration settings
 	// aerospike-version is marked required in this cmd's PreRun if the --force flag is not provided
-	res.Flags().StringP("aerospike-version", "a", "", "Aerospike server version for the configuration file. Ex: 6.2.0.\nThe first 3 digits of the Aerospike version number are required.\nThis option is required unless --force is used")
+	res.Flags().StringP("aerospike-version", "a", "", "Aerospike server version to validate the configuration file for. Ex: 6.2.0.\nThe first 3 digits of the Aerospike version number are required.\nThis option is required unless --force is used")
 	res.Flags().BoolP("force", "f", false, "Override checks for supported server version and config validation")
 	res.Flags().StringP("output", "o", os.Stdout.Name(), "File path to write output to")