-
-
Notifications
You must be signed in to change notification settings - Fork 514
Add instructions for accessing IDE's advanced settings #1407
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
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
Although the Arduino IDE's primary preferences interface provides all required configuration capabilities, advanced users may wish to fine tune the behavior of the application or temporarily enable additional log output to use for troubleshooting problems with the IDE. The IDE provides such settings in a separate interface. Previously, the existence and access procedure for these settings was undocumented. Since this is an advanced capability, the documentation is not appropriate for inclusion with the standard user documentation on arduino.cc. A file here in the Arduino IDE is used instead. This file will serve as a container for all such user-targeted documentation.
@per1234
per1234
added
topic: documentation
Related to documentation for the project
type: enhancement
Proposed improvement
labels
Sep 6, 2022
@per1234
per1234
requested review from
AlbyIanna,
francescospissu and
kittaakos
September 6, 2022 18:46
francescospissu
francescospissu
approved these changes
Sep 7, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks @per1234 👍
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.
Motivation
Although the Arduino IDE's primary preferences interface provides all required configuration capabilities, advanced users may wish to fine tune the behavior of the application or temporarily enable additional log output to use for troubleshooting problems with the IDE.
The IDE provides such settings in a separate interface.
The existence and access procedure for these settings is undocumented.
Change description
Provide instructions for accessing the advanced settings.
Since this is an advanced capability, the documentation is not appropriate for inclusion with the standard user
documentation on arduino.cc. A file here in the Arduino IDE is used instead. This file will serve as a container for all
such user-targeted documentation.
Other information
Resolves #1367
Reviewer checklist