Skip to content

Commit 55f86b5

Browse files
authored
[skip changelog] Correct documentation re: default for build_cache.path configuration key (#2919)
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.
1 parent dd621ee commit 55f86b5

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/configuration.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
- `updater` - configuration options related to Arduino CLI updates
3939
- `enable_notification` - set to `false` to disable notifications of new Arduino CLI releases, defaults to `true`
4040
- `build_cache` configuration options related to the compilation cache
41-
- `path` - the path to the build cache, default is `$TMP/arduino`.
41+
- `path` - the path to the folder under which build caches are stored.
4242
- `extra_paths` - a list of paths to look for precompiled artifacts if not found on `build_cache.path` setting.
4343
- `compilations_before_purge` - interval, in number of compilations, at which the cache is purged, defaults to `10`.
4444
When `0` the cache is never purged.
@@ -58,6 +58,14 @@
5858
The following are the default directories selected by the Arduino CLI if alternatives are not specified in the
5959
configuration file.
6060

61+
- The `build_cache.path` default is OS-dependent:
62+
63+
- on Linux (and other Unix-based OS) is: if
64+
[`$XDG_CACHE_HOME`](https://specifications.freedesktop.org/basedir-spec/latest/#variables) is defined,
65+
`$XDG_CACHE_HOME/arduino`. Otherwise `{HOME}/.config/arduino`.
66+
- on Windows is: `{HOME}/AppData/Local/arduino`
67+
- on MacOS is: `{HOME}/Library/Caches/arduino`
68+
6169
- The `directories.data` default is OS-dependent:
6270

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

0 commit comments

Comments
 (0)