[skip changelog] Update Platform Specification link in warning #1199
Conversation
This file contains 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
When a boards platform uses an outdated `recipe.ar.pattern`, Arduino CLI displays a helpful message: Unable to cache built core, please tell foo:[email protected] maintainers to follow http://goo.gl/QdCUjo That short link points to the old Arduino Platform Specification page in the arduino/Arduino repository's wiki. The platform specification has since been moved to the arduino/arduino-cli repository. Even though the old page provides a link to the new location, this message uses an anchor to direct the developer to the relevant section of the specification. When they follow the link from the old page, they will simply end up at the top of the specification and may have a hard time finding the information that tells them how to fix the platform. Updating the link restores the intended behavior.
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.
Please check if the PR fulfills these requirements
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)docs update
When a boards platform uses an outdated
recipe.ar.pattern, Arduino CLI displays a helpful message:That short link points to the old Arduino Platform Specification page in the
arduino/Arduinorepository's wiki. The platform specification has since been moved to thearduino/arduino-clirepository.Even though the old page provides a link to the new location, this message uses an anchor to direct the developer to the relevant section of the specification. When they follow the link from the old page, they will simply end up at the top of the specification and may have a hard time finding the information that tells them how to fix the platform.
The link is updated to point directly to the relevant information:
https://arduino.github.io/arduino-cli/latest/platform-specification/#recipes-to-build-the-corea-archive-file
titled accordingly?
No
Yes
Perhaps it would be better to create a new short link or update the old one, but I think this fix is fine. This message will not be encountered often because it has been a long time since that part of the platform system was changed.