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

[skip changelog] Document sketch.always_export_binaries configuration key #1215

Merged
merged 1 commit into from
Mar 9, 2021
Merged

[skip changelog] Document sketch.always_export_binaries configuration key #1215

merged 1 commit into from
Mar 9, 2021

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Mar 9, 2021

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • UPGRADING.md has been updated with a migration guide (for breaking changes)
  • What kind of change does this PR introduce?

docs update

  • What is the current behavior?

The existence and meaning of the sketch.always_export_binaries configuration key (#1042) is undocumented.

  • What is the new behavior?

The sketch.always_export_binaries configuration key is documented in the Arduino CLI Configuration page of the documentation website:
https://arduino.github.io/arduino-cli/dev/configuration/

No

…on key

The existence and meaning of this configuration key was previously undocumented.
@ubidefeo
Copy link

ubidefeo commented Mar 9, 2021

@per1234 , should the system ENV variable also be mentioned somewhere?

@per1234
Copy link
Contributor Author

per1234 commented Mar 9, 2021

Configuration via environment variables is documented here:
https://arduino.github.io/arduino-cli/dev/configuration/#environment-variables
This explains how the environment variable name is derived from the configuration key name. I think this is better than maintaining parallel documentation for the specific environment variable names.

@ubidefeo
Copy link

ubidefeo commented Mar 9, 2021

@per1234 agreed.
Thank you :)

Copy link

@ubidefeo ubidefeo left a comment

Choose a reason for hiding this comment

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

LGTM

@per1234 per1234 merged commit d35a3c9 into arduino:master Mar 9, 2021
@per1234 per1234 deleted the document-sketch_always_export_binaries branch March 9, 2021 08:15
@per1234 per1234 self-assigned this Nov 23, 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.

2 participants