Skip to content

Commit 6061cbf

Browse files
authored
[skip changelog] Fix typos in command line help text (#653)
1 parent c076ad3 commit 6061cbf

File tree

11 files changed

+18
-18
lines changed

11 files changed

+18
-18
lines changed

cli/board/board.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ func NewCommand() *cobra.Command {
3030
Example: " # Lists all connected boards.\n" +
3131
" " + os.Args[0] + " board list\n\n" +
3232
" # Attaches a sketch to a board.\n" +
33-
" " + os.Args[0] + " board attach serial:///dev/tty/ACM0 mySketch",
33+
" " + os.Args[0] + " board attach serial:///dev/ttyACM0 mySketch",
3434
}
3535

3636
boardCommand.AddCommand(initAttachCommand())

cli/board/list.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ func initListCommand() *cobra.Command {
3535
listCommand := &cobra.Command{
3636
Use: "list",
3737
Short: "List connected boards.",
38-
Long: "Detects and displays a list of connected boards to the current computer.",
38+
Long: "Detects and displays a list of boards connected to the current computer.",
3939
Example: " " + os.Args[0] + " board list --timeout 10s",
4040
Args: cobra.NoArgs,
4141
Run: runListCommand,

cli/cli.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ func createCliCommandTree(cmd *cobra.Command) {
8383
cmd.AddCommand(version.NewCommand())
8484

8585
cmd.PersistentFlags().BoolVarP(&verbose, "verbose", "v", false, "Print the logs on the standard output.")
86-
cmd.PersistentFlags().String("log-level", "", "Messages with this level and above will be logged. Valid levels are: Trace, Debug, Info, Warning, Error, Fatal, Panic")
86+
cmd.PersistentFlags().String("log-level", "", "Messages with this level and above will be logged. Valid levels are: trace, debug, info, warn, error, fatal, panic")
8787
viper.BindPFlag("logging.level", cmd.PersistentFlags().Lookup("log-level"))
8888
cmd.PersistentFlags().String("log-file", "", "Path to the file where logs will be written.")
8989
viper.BindPFlag("logging.file", cmd.PersistentFlags().Lookup("log-file"))

cli/compile/compile.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,11 @@ func NewCommand() *cobra.Command {
7676
command.Flags().StringVar(&warnings, "warnings", "none",
7777
`Optional, can be "none", "default", "more" and "all". Defaults to "none". Used to tell gcc which warning level to use (-W flag).`)
7878
command.Flags().BoolVarP(&verbose, "verbose", "v", false, "Optional, turns on verbose mode.")
79-
command.Flags().BoolVar(&quiet, "quiet", false, "Optional, supresses almost every output.")
79+
command.Flags().BoolVar(&quiet, "quiet", false, "Optional, suppresses almost every output.")
8080
command.Flags().BoolVarP(&uploadAfterCompile, "upload", "u", false, "Upload the binary after the compilation.")
8181
command.Flags().StringVarP(&port, "port", "p", "", "Upload port, e.g.: COM10 or /dev/ttyACM0")
8282
command.Flags().BoolVarP(&verify, "verify", "t", false, "Verify uploaded binary after the upload.")
83-
command.Flags().StringVar(&vidPid, "vid-pid", "", "When specified, VID/PID specific build properties are used, if boards supports them.")
83+
command.Flags().StringVar(&vidPid, "vid-pid", "", "When specified, VID/PID specific build properties are used, if board supports them.")
8484
command.Flags().StringSliceVar(&libraries, "libraries", []string{},
8585
"List of custom libraries paths separated by commas. Or can be used multiple times for multiple libraries paths.")
8686
command.Flags().BoolVar(&optimizeForDebug, "optimize-for-debug", false, "Optional, optimize compile output for debug, not for release.")

cli/config/config.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import (
2525
func NewCommand() *cobra.Command {
2626
configCommand := &cobra.Command{
2727
Use: "config",
28-
Short: "Arduino Configuration Commands.",
28+
Short: "Arduino configuration commands.",
2929
Example: " " + os.Args[0] + " config init",
3030
}
3131

cli/core/core.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ import (
2525
func NewCommand() *cobra.Command {
2626
coreCommand := &cobra.Command{
2727
Use: "core",
28-
Short: "Arduino Core operations.",
29-
Long: "Arduino Core operations.",
28+
Short: "Arduino core operations.",
29+
Long: "Arduino core operations.",
3030
Example: " " + os.Args[0] + " core update-index",
3131
}
3232

cli/core/download.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,12 @@ import (
3232

3333
func initDownloadCommand() *cobra.Command {
3434
downloadCommand := &cobra.Command{
35-
Use: "download [PACKAGER:ARCH[=VERSION]](S)",
35+
Use: "download [PACKAGER:ARCH[@VERSION]](S)",
3636
Short: "Downloads one or more cores and corresponding tool dependencies.",
3737
Long: "Downloads one or more cores and corresponding tool dependencies.",
3838
Example: "" +
39-
" " + os.Args[0] + " core download arduino:samd # to download the latest version of arduino SAMD core.\n" +
40-
" " + os.Args[0] + " core download arduino:samd=1.6.9 # for a specific version (in this case 1.6.9).",
39+
" " + os.Args[0] + " core download arduino:samd # to download the latest version of Arduino SAMD core.\n" +
40+
" " + os.Args[0] + " core download arduino:samd@1.6.9 # for a specific version (in this case 1.6.9).",
4141
Args: cobra.MinimumNArgs(1),
4242
Run: runDownloadCommand,
4343
}

cli/core/install.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ func initInstallCommand() *cobra.Command {
3535
Use: "install PACKAGER:ARCH[@VERSION] ...",
3636
Short: "Installs one or more cores and corresponding tool dependencies.",
3737
Long: "Installs one or more cores and corresponding tool dependencies.",
38-
Example: " # download the latest version of arduino SAMD core.\n" +
38+
Example: " # download the latest version of Arduino SAMD core.\n" +
3939
" " + os.Args[0] + " core install arduino:samd\n\n" +
4040
" # download a specific version (in this case 1.6.9).\n" +
4141
" " + os.Args[0] + " core install arduino:[email protected]",

cli/core/uninstall.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ import (
3333
func initUninstallCommand() *cobra.Command {
3434
return &cobra.Command{
3535
Use: "uninstall PACKAGER:ARCH ...",
36-
Short: "Uninstalls one or more cores and corresponding tool dependencies if no more used.",
37-
Long: "Uninstalls one or more cores and corresponding tool dependencies if no more used.",
36+
Short: "Uninstalls one or more cores and corresponding tool dependencies if no longer used.",
37+
Long: "Uninstalls one or more cores and corresponding tool dependencies if no longer used.",
3838
Example: " " + os.Args[0] + " core uninstall arduino:samd\n",
3939
Args: cobra.MinimumNArgs(1),
4040
Run: runUninstallCommand,

cli/sketch/sketch.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ import (
2525
func NewCommand() *cobra.Command {
2626
cmd := &cobra.Command{
2727
Use: "sketch",
28-
Short: "Arduino CLI Sketch Commands.",
29-
Long: "Arduino CLI Sketch Commands.",
28+
Short: "Arduino CLI sketch commands.",
29+
Long: "Arduino CLI sketch commands.",
3030
Example: " " + os.Args[0] + " sketch new MySketch",
3131
}
3232

cli/version/version.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ import (
2727
func NewCommand() *cobra.Command {
2828
return &cobra.Command{
2929
Use: "version",
30-
Short: "Shows version number of arduino CLI.",
31-
Long: "Shows version number of arduino CLI which is installed on your system.",
30+
Short: "Shows version number of Arduino CLI.",
31+
Long: "Shows the version number of Arduino CLI which is installed on your system.",
3232
Example: " " + os.Args[0] + " version",
3333
Args: cobra.NoArgs,
3434
Run: run,

0 commit comments

Comments
 (0)