Skip to content

Commit

Permalink
docs: clairfy the use of the --aerospike-version option (#21)
Browse files Browse the repository at this point in the history
  • Loading branch information
dwelch-spike authored Nov 13, 2023
1 parent 74ba302 commit 17ed370
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion cmd/convert.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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")

Expand Down

0 comments on commit 17ed370

Please sign in to comment.