Skip to content

[skip changelog] [skip ci] Clarify additional-urls option usage #548

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 9, 2020
Merged

[skip changelog] [skip ci] Clarify additional-urls option usage #548

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b1cc906
[skip changelog] [skip ci] Clarify additional-urls option usage
Jan 9, 2020
095fc64
rephrase flag warning
Jan 9, 2020
9f3e361
stress 3rd party point
Jan 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 16 additions & 14 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we could stress the fact that you always have to pass the option if you decide to not use the config file, something on these lines:

Alternatively, you can pass a link to the the additional package index file with the --additional-urls option, but this has to be done every time and for every command that operates on a platform core, for example:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 I have rephrased it a bit, please check if it makes sense.

every command that require a platform core to work:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/require/requires


.. 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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down