Skip to content

Commit 06c9503

Browse files
authored
[skip changelog]Use standardized term for Boards Manager in documentation (#930)
The term "Boards Manager" has been well established in the Arduino development tools and documentation. Perhaps influenced by the mismatch with the singular term used for its companion "Library Manager", Arduino CLI's documentation has diverged from this standard by sometimes (but not always) referring to it as "Board Manager". This PR resolves the inconsistency by using "Boards Manager" everywhere. Note that "Boards Manager" and "Library Manager" are proper nouns, and so should always be capitalized.
1 parent 6e2b94e commit 06c9503

File tree

7 files changed

+14
-14
lines changed

7 files changed

+14
-14
lines changed

Diff for: README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![cli-logo](./docs/img/CLI_Logo_small.png)
44

5-
Arduino CLI is an all-in-one solution that provides builder, boards/library manager, uploader, discovery and many other
5+
Arduino CLI is an all-in-one solution that provides builder, Boards/Library Manager, uploader, discovery and many other
66
tools needed to use any Arduino compatible board and platforms.
77

88
[![tests-badge]](https://github.com/Arduino/arduino-cli/actions?workflow=test)

Diff for: cli/cli.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ func createCliCommandTree(cmd *cobra.Command) {
106106
viper.BindPFlag("logging.format", cmd.PersistentFlags().Lookup("log-format"))
107107
cmd.PersistentFlags().StringVar(&outputFormat, "format", "text", "The output format, can be {text|json}.")
108108
cmd.PersistentFlags().StringVar(&configFile, "config-file", "", "The custom config file (if not specified the default will be used).")
109-
cmd.PersistentFlags().StringSlice("additional-urls", []string{}, "Comma-separated list of additional URLs for the board manager.")
109+
cmd.PersistentFlags().StringSlice("additional-urls", []string{}, "Comma-separated list of additional URLs for the Boards Manager.")
110110
viper.BindPFlag("board_manager.additional_urls", cmd.PersistentFlags().Lookup("additional-urls"))
111111
}
112112

Diff for: cli/core/search.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ var (
3737
func initSearchCommand() *cobra.Command {
3838
searchCommand := &cobra.Command{
3939
Use: "search <keywords...>",
40-
Short: "Search for a core in the package index.",
41-
Long: "Search for a core in the package index using the specified keywords.",
40+
Short: "Search for a core in Boards Manager.",
41+
Long: "Search for a core in Boards Manager using the specified keywords.",
4242
Example: " " + os.Args[0] + " core search MKRZero -a -v",
4343
Args: cobra.ArbitraryArgs,
4444
Run: runSearchCommand,

Diff for: configuration/defaults.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ func setDefaults(dataDir, userDir string) {
2626
viper.SetDefault("logging.level", "info")
2727
viper.SetDefault("logging.format", "text")
2828

29-
// board manager
29+
// Boards Manager
3030
viper.SetDefault("board_manager.additional_urls", []string{})
3131

3232
// arduino directories

Diff for: docs/configuration.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
## Configuration keys
22

33
- `board_manager`
4-
- `additional_urls` - the URLs to any additional Board Manager package index files needed for your boards platforms.
4+
- `additional_urls` - the URLs to any additional Boards Manager package index files needed for your boards platforms.
55
- `daemon` - options related to running Arduino CLI as a [gRPC] server.
66
- `port` - TCP port used for gRPC client connections.
77
- `directories` - directories used by Arduino CLI.
8-
- `data` - directory used to store Board/Library Manager index files and Board Manager platform installations.
9-
- `downloads` - directory used to stage downloaded archives during Board/Library Manager installations.
8+
- `data` - directory used to store Boards/Library Manager index files and Boards Manager platform installations.
9+
- `downloads` - directory used to stage downloaded archives during Boards/Library Manager installations.
1010
- `user` - the equivalent of the Arduino IDE's ["sketchbook" directory][sketchbook directory]. Library Manager
1111
installations are made to the `libraries` subdirectory of the user directory.
1212
- `logging` - configuration options for Arduino CLI's logs.
@@ -39,7 +39,7 @@ Arduino CLI's command line flags are documented in the command line help and the
3939

4040
#### Example
4141

42-
Setting an additional Board Manager URL using the [`--additional-urls`][arduino-cli global flags] command line flag:
42+
Setting an additional Boards Manager URL using the [`--additional-urls`][arduino-cli global flags] command line flag:
4343

4444
```shell
4545
$ arduino-cli core update-index --additional-urls https://downloads.arduino.cc/packages/package_staging_index.json
@@ -56,7 +56,7 @@ can use the [`set` command][set command].
5656

5757
#### Example
5858

59-
Setting an additional Board Manager URL using the `ARDUINO_BOARD_MANAGER_ADDITIONAL_URLS` environment variable:
59+
Setting an additional Boards Manager URL using the `ARDUINO_BOARD_MANAGER_ADDITIONAL_URLS` environment variable:
6060

6161
```sh
6262
$ export ARDUINO_BOARD_MANAGER_ADDITIONAL_URLS=https://downloads.arduino.cc/packages/package_staging_index.json
@@ -109,7 +109,7 @@ arduino-cli config dump --verbose
109109

110110
#### Example
111111

112-
Setting an additional Board Manager URL using a YAML format configuration file:
112+
Setting an additional Boards Manager URL using a YAML format configuration file:
113113

114114
```yaml
115115
board_manager:

Diff for: docs/getting-started.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Available Commands:
2020
download Downloads one or more cores and corresponding tool dependencies.
2121
install Installs one or more cores and corresponding tool dependencies.
2222
list Shows the list of installed platforms.
23-
search Search for a core in the package index.
23+
search Search for a core in Boards Manager.
2424
uninstall Uninstalls one or more cores and corresponding tool dependencies if no more used.
2525
update-index Updates the index of cores.
2626
upgrade Upgrades one or all installed platforms to the latest version.
@@ -29,7 +29,7 @@ Flags:
2929
-h, --help help for core
3030

3131
Global Flags:
32-
--additional-urls strings Additional URLs for the board manager.
32+
--additional-urls strings Additional URLs for Boards Manager.
3333
--config-file string The custom config file (if not specified the default will be used).
3434
--format string The output format, can be [text|json]. (default "text")
3535
--log-file string Path to the file where logs will be written.

Diff for: docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Arduino CLI is an all-in-one solution that provides builder, boards/library manager, uploader, discovery and many other
1+
Arduino CLI is an all-in-one solution that provides builder, Boards/Library Manager, uploader, discovery and many other
22
tools needed to use any Arduino compatible board and platforms.
33

44
## Installation

0 commit comments

Comments
 (0)