Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit bfb5f3f

Browse files
[Skip-changelog] Improve documentation regarding ARDUINO_BOARD_MANAGER_ADDITIONAL_URLS (#2136)
* Print error message if `board_manager.additional_urls` contains comma separated urls * Improve documentation regarding the usage of environment variables
1 parent 042f76a commit bfb5f3f

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

‎docs/configuration.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@ variable sets the `directories.user` configuration option.
7676
On Linux or macOS, you can use the [`export` command][export command] to set environment variables. On Windows cmd, you
7777
can use the [`set` command][set command].
7878

79+
`ARDUINO_BOARD_MANAGER_ADDITIONAL_URLS` environment variables can be a list of space-separated URLs.
80+
7981
#### Example
8082

8183
Setting an additional Boards Manager URL using the `ARDUINO_BOARD_MANAGER_ADDITIONAL_URLS` environment variable:
@@ -84,6 +86,12 @@ Setting an additional Boards Manager URL using the `ARDUINO_BOARD_MANAGER_ADDITI
8486
$ export ARDUINO_BOARD_MANAGER_ADDITIONAL_URLS=https://downloads.arduino.cc/packages/package_staging_index.json
8587
```
8688

89+
Setting multiple additional Boards Manager URLs using the `ARDUINO_BOARD_MANAGER_ADDITIONAL_URLS` environment variable:
90+
91+
```sh
92+
$ export ARDUINO_BOARD_MANAGER_ADDITIONAL_URLS="https://downloads.arduino.cc/packages/package_staging_index.json https://downloads.arduino.cc/packages/package_mbed_index.json"
93+
```
94+
8795
### Configuration file
8896

8997
[`arduino-cli config init`][arduino-cli config init] creates or updates a configuration file with the current

‎internal/cli/config/init.go‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ package config
1717

1818
import (
1919
"os"
20+
"strings"
2021

2122
"github.com/arduino/arduino-cli/configuration"
2223
"github.com/arduino/arduino-cli/internal/cli/arguments"
@@ -97,6 +98,13 @@ func runInitCommand(cmd *cobra.Command, args []string) {
9798
configuration.SetDefaults(newSettings)
9899
configuration.BindFlags(cmd, newSettings)
99100

101+
for _, url := range newSettings.GetStringSlice("board_manager.additional_urls") {
102+
if strings.Contains(url, ",") {
103+
feedback.Fatal(tr("Urls cannot contain commas. Separate multiple urls exported as env var with a space:\n%s", url),
104+
feedback.ErrGeneric)
105+
}
106+
}
107+
100108
if err := newSettings.WriteConfigAs(configFileAbsPath.String()); err != nil {
101109
feedback.Fatal(tr("Cannot create config file: %v", err), feedback.ErrGeneric)
102110
}

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /