Skip to content
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

Link check on REFERENCE_LINK field of keywords.txt not working with Arduino IDE >1.8.15 #32

Open
per1234 opened this issue Jul 31, 2022 · 0 comments
Labels

Comments

@per1234
Copy link
Owner

per1234 commented Jul 31, 2022

The check_keywords_txt function has an optional feature to check whether there is a reference page for the values in the REFERENCE_LINK field of keywords.txt.

Arduino IDE 1.x has a Help > Find in Reference feature where the reference page for the selected keyword is opened in the browser. In Arduino IDE 1.8.15 and older, a bundled copy of the reference pages was used to allow this feature to work regardless of whether there was an Internet connection. The system used to generate that reference content was broken during the migration to the current Arduino Language Reference content system. Since the offline reference content was no longer possible to maintain, the reference lookup feature was changed to simply open a search for the keyword on search.arduino.cc (arduino/Arduino#11495).

Since the new system draws from the entire contents of arduino.cc, including the forum, there is no way for the reference page check of check_keywords_txt to validate whether relevant information will be returned by the Help > Find in Reference feature of Arduino IDE >1.8.15.

The check still has some value for validating the values for compatibility with the older versions of the Arduino IDE, so I don't see a need to remove it. However, it will fail spuriously when a version of the Arduino IDE >1.8.15 was set via install_ide before running the function. The check must be skipped if a later version is used, with a warning printed that clearly communicates the limitation to the user.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant