Skip to content

[skip changelog] Document Arduino CLI support for global platform.txt, and all recognized paths #2952

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions docs/platform-specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -522,9 +522,17 @@ commands to run to compile the sketch), but the `post*` hooks and all compile co

## Global platform.txt

Properties defined in a platform.txt created in the **hardware** subfolder of the Arduino IDE installation folder will
be used for all platforms and will override local properties. This feature is currently only available when using the
Arduino IDE.
Properties defined in a platform.txt file located in the root of any of the packages folders will be used for all
platforms and will override local properties.

The packages folder locations are:

- `{directories.data}/packages`<br />(where `{directories.data}` is the path from the `directories.data`
[configuration key](configuration.md))
- `{directories.user}/hardware`<br />(where `{directories.user}` is the path from the `directories.user`
[configuration key](configuration.md), or Arduino IDE "Sketchbook location" preference)
- `{Arduino IDE installation}/hardware` (Arduino IDE 1.x only)<br />(where `{Arduino IDE installation}` is the path of
the Arduino IDE installation folder)

## platform.local.txt

Expand Down