Unverified Commit 6061cbf6 authored by per1234's avatar per1234 Committed by GitHub

[skip changelog] Fix typos in command line help text (#653)

parent c076ad30
...@@ -30,7 +30,7 @@ func NewCommand() *cobra.Command { ...@@ -30,7 +30,7 @@ func NewCommand() *cobra.Command {
Example: " # Lists all connected boards.\n" + Example: " # Lists all connected boards.\n" +
" " + os.Args[0] + " board list\n\n" + " " + os.Args[0] + " board list\n\n" +
" # Attaches a sketch to a board.\n" + " # Attaches a sketch to a board.\n" +
" " + os.Args[0] + " board attach serial:///dev/tty/ACM0 mySketch", " " + os.Args[0] + " board attach serial:///dev/ttyACM0 mySketch",
} }
boardCommand.AddCommand(initAttachCommand()) boardCommand.AddCommand(initAttachCommand())
......
...@@ -35,7 +35,7 @@ func initListCommand() *cobra.Command { ...@@ -35,7 +35,7 @@ func initListCommand() *cobra.Command {
listCommand := &cobra.Command{ listCommand := &cobra.Command{
Use: "list", Use: "list",
Short: "List connected boards.", Short: "List connected boards.",
Long: "Detects and displays a list of connected boards to the current computer.", Long: "Detects and displays a list of boards connected to the current computer.",
Example: " " + os.Args[0] + " board list --timeout 10s", Example: " " + os.Args[0] + " board list --timeout 10s",
Args: cobra.NoArgs, Args: cobra.NoArgs,
Run: runListCommand, Run: runListCommand,
......
...@@ -83,7 +83,7 @@ func createCliCommandTree(cmd *cobra.Command) { ...@@ -83,7 +83,7 @@ func createCliCommandTree(cmd *cobra.Command) {
cmd.AddCommand(version.NewCommand()) cmd.AddCommand(version.NewCommand())
cmd.PersistentFlags().BoolVarP(&verbose, "verbose", "v", false, "Print the logs on the standard output.") cmd.PersistentFlags().BoolVarP(&verbose, "verbose", "v", false, "Print the logs on the standard output.")
cmd.PersistentFlags().String("log-level", "", "Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic") cmd.PersistentFlags().String("log-level", "", "Messages with this level and above will be logged. Valid levels are: trace, debug, info, warn, error, fatal, panic")
viper.BindPFlag("logging.level", cmd.PersistentFlags().Lookup("log-level")) viper.BindPFlag("logging.level", cmd.PersistentFlags().Lookup("log-level"))
cmd.PersistentFlags().String("log-file", "", "Path to the file where logs will be written.") cmd.PersistentFlags().String("log-file", "", "Path to the file where logs will be written.")
viper.BindPFlag("logging.file", cmd.PersistentFlags().Lookup("log-file")) viper.BindPFlag("logging.file", cmd.PersistentFlags().Lookup("log-file"))
......
...@@ -76,11 +76,11 @@ func NewCommand() *cobra.Command { ...@@ -76,11 +76,11 @@ func NewCommand() *cobra.Command {
command.Flags().StringVar(&warnings, "warnings", "none", command.Flags().StringVar(&warnings, "warnings", "none",
`Optional, can be "none", "default", "more" and "all". Defaults to "none". Used to tell gcc which warning level to use (-W flag).`) `Optional, can be "none", "default", "more" and "all". Defaults to "none". Used to tell gcc which warning level to use (-W flag).`)
command.Flags().BoolVarP(&verbose, "verbose", "v", false, "Optional, turns on verbose mode.") command.Flags().BoolVarP(&verbose, "verbose", "v", false, "Optional, turns on verbose mode.")
command.Flags().BoolVar(&quiet, "quiet", false, "Optional, supresses almost every output.") command.Flags().BoolVar(&quiet, "quiet", false, "Optional, suppresses almost every output.")
command.Flags().BoolVarP(&uploadAfterCompile, "upload", "u", false, "Upload the binary after the compilation.") command.Flags().BoolVarP(&uploadAfterCompile, "upload", "u", false, "Upload the binary after the compilation.")
command.Flags().StringVarP(&port, "port", "p", "", "Upload port, e.g.: COM10 or /dev/ttyACM0") command.Flags().StringVarP(&port, "port", "p", "", "Upload port, e.g.: COM10 or /dev/ttyACM0")
command.Flags().BoolVarP(&verify, "verify", "t", false, "Verify uploaded binary after the upload.") command.Flags().BoolVarP(&verify, "verify", "t", false, "Verify uploaded binary after the upload.")
command.Flags().StringVar(&vidPid, "vid-pid", "", "When specified, VID/PID specific build properties are used, if boards supports them.") command.Flags().StringVar(&vidPid, "vid-pid", "", "When specified, VID/PID specific build properties are used, if board supports them.")
command.Flags().StringSliceVar(&libraries, "libraries", []string{}, command.Flags().StringSliceVar(&libraries, "libraries", []string{},
"List of custom libraries paths separated by commas. Or can be used multiple times for multiple libraries paths.") "List of custom libraries paths separated by commas. Or can be used multiple times for multiple libraries paths.")
command.Flags().BoolVar(&optimizeForDebug, "optimize-for-debug", false, "Optional, optimize compile output for debug, not for release.") command.Flags().BoolVar(&optimizeForDebug, "optimize-for-debug", false, "Optional, optimize compile output for debug, not for release.")
......
...@@ -25,7 +25,7 @@ import ( ...@@ -25,7 +25,7 @@ import (
func NewCommand() *cobra.Command { func NewCommand() *cobra.Command {
configCommand := &cobra.Command{ configCommand := &cobra.Command{
Use: "config", Use: "config",
Short: "Arduino Configuration Commands.", Short: "Arduino configuration commands.",
Example: " " + os.Args[0] + " config init", Example: " " + os.Args[0] + " config init",
} }
......
...@@ -25,8 +25,8 @@ import ( ...@@ -25,8 +25,8 @@ import (
func NewCommand() *cobra.Command { func NewCommand() *cobra.Command {
coreCommand := &cobra.Command{ coreCommand := &cobra.Command{
Use: "core", Use: "core",
Short: "Arduino Core operations.", Short: "Arduino core operations.",
Long: "Arduino Core operations.", Long: "Arduino core operations.",
Example: " " + os.Args[0] + " core update-index", Example: " " + os.Args[0] + " core update-index",
} }
......
...@@ -32,12 +32,12 @@ import ( ...@@ -32,12 +32,12 @@ import (
func initDownloadCommand() *cobra.Command { func initDownloadCommand() *cobra.Command {
downloadCommand := &cobra.Command{ downloadCommand := &cobra.Command{
Use: "download [PACKAGER:ARCH[=VERSION]](S)", Use: "download [PACKAGER:ARCH[@VERSION]](S)",
Short: "Downloads one or more cores and corresponding tool dependencies.", Short: "Downloads one or more cores and corresponding tool dependencies.",
Long: "Downloads one or more cores and corresponding tool dependencies.", Long: "Downloads one or more cores and corresponding tool dependencies.",
Example: "" + Example: "" +
" " + os.Args[0] + " core download arduino:samd # to download the latest version of arduino SAMD core.\n" + " " + os.Args[0] + " core download arduino:samd # to download the latest version of Arduino SAMD core.\n" +
" " + os.Args[0] + " core download arduino:samd=1.6.9 # for a specific version (in this case 1.6.9).", " " + os.Args[0] + " core download arduino:samd@1.6.9 # for a specific version (in this case 1.6.9).",
Args: cobra.MinimumNArgs(1), Args: cobra.MinimumNArgs(1),
Run: runDownloadCommand, Run: runDownloadCommand,
} }
......
...@@ -35,7 +35,7 @@ func initInstallCommand() *cobra.Command { ...@@ -35,7 +35,7 @@ func initInstallCommand() *cobra.Command {
Use: "install PACKAGER:ARCH[@VERSION] ...", Use: "install PACKAGER:ARCH[@VERSION] ...",
Short: "Installs one or more cores and corresponding tool dependencies.", Short: "Installs one or more cores and corresponding tool dependencies.",
Long: "Installs one or more cores and corresponding tool dependencies.", Long: "Installs one or more cores and corresponding tool dependencies.",
Example: " # download the latest version of arduino SAMD core.\n" + Example: " # download the latest version of Arduino SAMD core.\n" +
" " + os.Args[0] + " core install arduino:samd\n\n" + " " + os.Args[0] + " core install arduino:samd\n\n" +
" # download a specific version (in this case 1.6.9).\n" + " # download a specific version (in this case 1.6.9).\n" +
" " + os.Args[0] + " core install arduino:samd@1.6.9", " " + os.Args[0] + " core install arduino:samd@1.6.9",
......
...@@ -33,8 +33,8 @@ import ( ...@@ -33,8 +33,8 @@ import (
func initUninstallCommand() *cobra.Command { func initUninstallCommand() *cobra.Command {
return &cobra.Command{ return &cobra.Command{
Use: "uninstall PACKAGER:ARCH ...", Use: "uninstall PACKAGER:ARCH ...",
Short: "Uninstalls one or more cores and corresponding tool dependencies if no more used.", Short: "Uninstalls one or more cores and corresponding tool dependencies if no longer used.",
Long: "Uninstalls one or more cores and corresponding tool dependencies if no more used.", Long: "Uninstalls one or more cores and corresponding tool dependencies if no longer used.",
Example: " " + os.Args[0] + " core uninstall arduino:samd\n", Example: " " + os.Args[0] + " core uninstall arduino:samd\n",
Args: cobra.MinimumNArgs(1), Args: cobra.MinimumNArgs(1),
Run: runUninstallCommand, Run: runUninstallCommand,
......
...@@ -25,8 +25,8 @@ import ( ...@@ -25,8 +25,8 @@ import (
func NewCommand() *cobra.Command { func NewCommand() *cobra.Command {
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "sketch", Use: "sketch",
Short: "Arduino CLI Sketch Commands.", Short: "Arduino CLI sketch commands.",
Long: "Arduino CLI Sketch Commands.", Long: "Arduino CLI sketch commands.",
Example: " " + os.Args[0] + " sketch new MySketch", Example: " " + os.Args[0] + " sketch new MySketch",
} }
......
...@@ -27,8 +27,8 @@ import ( ...@@ -27,8 +27,8 @@ import (
func NewCommand() *cobra.Command { func NewCommand() *cobra.Command {
return &cobra.Command{ return &cobra.Command{
Use: "version", Use: "version",
Short: "Shows version number of arduino CLI.", Short: "Shows version number of Arduino CLI.",
Long: "Shows version number of arduino CLI which is installed on your system.", Long: "Shows the version number of Arduino CLI which is installed on your system.",
Example: " " + os.Args[0] + " version", Example: " " + os.Args[0] + " version",
Args: cobra.NoArgs, Args: cobra.NoArgs,
Run: run, Run: run,
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment