[skip changelog] [skip ci] Clarify additional-urls option usage #548
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
masci
reviewed
Jan 9, 2020
README.rst
Outdated
| @@ -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: | |||
README.rst
Outdated
| @@ -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 | |||
There was a problem hiding this comment.
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-urlsoption, but this has to be done every time and for every command that operates on a platform core, for example:
There was a problem hiding this comment.
👍 I have rephrased it a bit, please check if it makes sense.
added 2 commits
January 9, 2020 14:36
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR propose the usage of the config file option as best mode for 3rd party core usage.
The
--additional-urlsflag is now presented as an alternative, adding a complete usage explanation.