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.

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
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
[skip changelog] Correct documentation re: default for `build_cache.p…
…ath` configuration key

The "Configuration" documentation page includes information on the default values of the configuration keys.

The default value of the build_cache.path configuration key was recently changed, but the documentation was not updated
accordingly.

The documentation is hereby updated to provide the correct information regarding the default value of the
build_cache.path configuration key.

Previously, the information was provided in the list of keys. That is a non-standard location for the information as
there is an established convention of instead providing this information in the separate section of the page dedicated
to documenting default paths. In addition. the location in the keys list became more problematic for the new default
since it is operating system-specific and thus the increased volume of documentation content would be awkward to fit
into the nested list of keys. For these reasons, the documentation content was moved to the standardized location under
the "Default directories" section of the page.
  • Loading branch information
per1234 committed May 26, 2025
commit f66cdfbf169bfc070f2b23dab0920a5b0b9ad6cb
10 changes: 9 additions & 1 deletion docs/configuration.md
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
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy