Skip to content

[skip changelog] Correct documentation re: default for build_cache.path configuration key #2919

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.

Sign up for GitHub

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
May 28, 2025
Merged

[skip changelog] Correct documentation re: default for build_cache.path configuration key #2919

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 9 additions & 1 deletion docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
- `updater` - configuration options related to Arduino CLI updates
- `enable_notification` - set to `false` to disable notifications of new Arduino CLI releases, defaults to `true`
- `build_cache` configuration options related to the compilation cache
- `path` - the path to the build cache, default is `$TMP/arduino`.
- `path` - the path to the folder under which build caches are stored.
- `extra_paths` - a list of paths to look for precompiled artifacts if not found on `build_cache.path` setting.
- `compilations_before_purge` - interval, in number of compilations, at which the cache is purged, defaults to `10`.
When `0` the cache is never purged.
Expand All @@ -58,6 +58,14 @@
The following are the default directories selected by the Arduino CLI if alternatives are not specified in the
configuration file.

- The `build_cache.path` default is OS-dependent:

- on Linux (and other Unix-based OS) is: if
[`$XDG_CACHE_HOME`](https://specifications.freedesktop.org/basedir-spec/latest/#variables) is defined,
`$XDG_CACHE_HOME/arduino`. Otherwise `{HOME}/.config/arduino`.
- on Windows is: `{HOME}/AppData/Local/arduino`
- on MacOS is: `{HOME}/Library/Caches/arduino`

- The `directories.data` default is OS-dependent:

- on Linux (and other Unix-based OS) is: `{HOME}/.arduino15`
Expand Down