Skip to content

Update links to troubleshooting guides in error messages #11387

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.

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 1 commit into from
Apr 8, 2021
Merged

Update links to troubleshooting guides in error messages #11387

merged 1 commit into from
Apr 8, 2021

Conversation

per1234
Copy link
Collaborator

@per1234 per1234 commented Mar 29, 2021

When the compiled size of a sketch exceeds the available flash or RAM on the board, the error message includes a link to
a troubleshooting guide:

Sketch uses 16110 bytes (112%) of program storage space. Maximum is 14336 bytes.
Global variables use 685 bytes (66%) of dynamic memory, leaving 339 bytes for local variables. Maximum is 1024 bytes.
Sketch too big; see http://www.arduino.cc/en/Guide/Troubleshooting#size for tips on reducing it.

Archived copy here: https://web.archive.org/web/20200320112114/https://www.arduino.cc/en/Guide/Troubleshooting#size

When an upload fails, the error message includes a link to a troubleshooting guide:

Problem uploading to board.  See http://www.arduino.cc/en/Guide/Troubleshooting#upload for suggestions.

Archived copy here: https://web.archive.org/web/20200320112114/https://www.arduino.cc/en/Guide/Troubleshooting#upload

http://www.arduino.cc/en/Guide/Troubleshooting was recently replaced with the Arduino Help Center. Even though that URL
redirects to the Help Center, it only goes to the home page, leaving the user to hunt for the relevant article.

A better user experience is provided by linking directly to the relevant content in the Help Center:


Fixes #11382
Fixes #11140

Related: arduino/arduino-cli#1197

@per1234 per1234 requested a review from alranel March 29, 2021 05:06
@per1234 per1234 changed the title Update links to troubleshooting guides in sketch overmem error messages Update links to troubleshooting guides in error messages Mar 29, 2021
When the compiled size of a sketch exceeds the available flash or RAM on the board, the error message includes a link to
a troubleshooting guide:

Sketch uses 16110 bytes (112%) of program storage space. Maximum is 14336 bytes.
Global variables use 685 bytes (66%) of dynamic memory, leaving 339 bytes for local variables. Maximum is 1024 bytes.
Sketch too big; see http://www.arduino.cc/en/Guide/Troubleshooting#size for tips on reducing it.

When an upload fails, the error message includes a link to a troubleshooting guide:

Problem uploading to board.  See http://www.arduino.cc/en/Guide/Troubleshooting#upload for suggestions.
http://www.arduino.cc/en/Guide/Troubleshooting was recently replaced with the Arduino Help Center. Even though that URL
redirects to the Help Center, it only goes to the home page, leaving the user to hunt for the relevant article.

A better user experience is provided by linking directly to the relevant content in the Help Center.
@cmaglie cmaglie merged commit 03f5f8a into arduino:master Apr 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Broken link in troubleshooting messages "Sketch too big" print includes broken link
2 participants