Skip to content

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
merged 1 commit into from
Sep 7, 2022
Merged

Add instructions for accessing IDE's advanced settings #1407

merged 1 commit into from
Sep 7, 2022

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Sep 6, 2022

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

  • PR addresses a single concern.
  • The PR has no duplicates (please search among the Pull Requests before creating one)
  • PR title and description are properly filled.
  • Docs have been added / updated (for bug fixes / features)

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 self-assigned this Sep 6, 2022
Copy link
Contributor

@francescospissu francescospissu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @per1234 👍

@per1234 per1234 merged commit 8f95fd6 into arduino:main Sep 7, 2022
@per1234 per1234 deleted the advanced-usage branch September 7, 2022 07:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document how to access the advanced settings
2 participants