From b1cc906eb04bae55046ba6b62a2da580beb8bd5f Mon Sep 17 00:00:00 2001 From: Roberto Sora Date: Thu, 9 Jan 2020 12:53:10 +0100 Subject: [PATCH 1/3] [skip changelog] [skip ci] Clarify additional-urls option usage --- README.rst | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/README.rst b/README.rst index 5955da25169..57759b040d9 100644 --- a/README.rst +++ b/README.rst @@ -293,21 +293,10 @@ Great! Now we are ready to compile and upload the sketch. Adding 3rd party cores ^^^^^^^^^^^^^^^^^^^^^^ -If your board requires 3rd party core packages to work, you can pass a link to -the the additional package index file with the ``--additional-urls`` option to -any command that require a platform core to work: +If your board requires 3rd party core packages to work, you can list the URLs +to additional package indexes in the Arduino CLI configuration file. -.. code:: console - - $ arduino-cli core search esp8266 --additional-urls https://arduino.esp8266.com/stable/package_esp8266com_index.json - ID Version Name - esp8266:esp8266 2.5.2 esp8266 - -To avoid passing the ``--additional-urls`` option every time you run a command, -you can list the URLs to additional package indexes in the Arduino CLI -configuration file. - -For example, to add the ESP8266 core, edit the configration file and change the +For example, to add the ESP8266 core, edit the configuration file and change the ``board_manager`` settings as follows: .. code:: yaml @@ -330,6 +319,19 @@ additional URL from the configuration file: ID Version Name esp8266:esp8266 2.5.2 esp8266 +Alternatively you can pass a link to the the additional package index file with the ``--additional-urls`` option to +every command that require a platform core to work: + +.. code:: console + + $ arduino-cli core update-index --additional-urls https://arduino.esp8266.com/stable/package_esp8266com_index.json + Updating index: package_esp8266com_index.json downloaded + + $ arduino-cli core search esp8266 --additional-urls https://arduino.esp8266.com/stable/package_esp8266com_index.json + ID Version Name + esp8266:esp8266 2.5.2 esp8266 + + Compile and upload the sketch ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 095fc64c5bbea5d38e1237b65ea7baab809be193 Mon Sep 17 00:00:00 2001 From: Roberto Sora Date: Thu, 9 Jan 2020 14:36:08 +0100 Subject: [PATCH 2/3] rephrase flag warning --- README.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 57759b040d9..aa66206176e 100644 --- a/README.rst +++ b/README.rst @@ -319,8 +319,9 @@ additional URL from the configuration file: ID Version Name esp8266:esp8266 2.5.2 esp8266 -Alternatively you can pass a link to the the additional package index file with the ``--additional-urls`` option to -every command that require a platform core to work: +Alternatively, you can pass a link to the the additional package index file with +the ``--additional-urls`` option, that has to be specified every time and for every +command that operates on a platform core, for example: .. code:: console From 9f3e3619d66b7278ad17303c898ccbd5e3f0f5d9 Mon Sep 17 00:00:00 2001 From: Roberto Sora Date: Thu, 9 Jan 2020 14:37:47 +0100 Subject: [PATCH 3/3] stress 3rd party point --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index aa66206176e..65119083b69 100644 --- a/README.rst +++ b/README.rst @@ -321,7 +321,7 @@ additional URL from the configuration file: Alternatively, you can pass a link to the the additional package index file with the ``--additional-urls`` option, that has to be specified every time and for every -command that operates on a platform core, for example: +command that operates on a 3rd party platform core, for example: .. code:: console