Skip to content

Commit d35a3c9

Browse files
authored
[skip changelog] Document sketch.always_export_binaries configuration key (#1215)
The existence and meaning of this configuration key was previously undocumented.
1 parent e8501d6 commit d35a3c9

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/configuration.md

+6
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@
2121
- `metrics` - settings related to the collection of data used for continued improvement of Arduino CLI.
2222
- `addr` - TCP port used for metrics communication.
2323
- `enabled` - controls the use of metrics.
24+
- `sketch` - configuration options relating to [Arduino sketches][sketch specification].
25+
- `always_export_binaries` - set to `true` to make [`arduino-cli compile`][arduino-cli compile] always save binaries
26+
to the sketch folder. This is the equivalent of using the [`--export-binaries`][arduino-cli compile options] flag.
2427

2528
## Configuration methods
2629

@@ -131,6 +134,9 @@ additional_urls = [ "https://downloads.arduino.cc/packages/package_staging_index
131134
[grpc]: https://grpc.io
132135
[sketchbook directory]: sketch-specification.md#sketchbook
133136
[arduino cli lib install]: commands/arduino-cli_lib_install.md
137+
[sketch specification]: sketch-specification.md
138+
[arduino-cli compile]: commands/arduino-cli_compile.md
139+
[arduino-cli compile options]: commands/arduino-cli_compile.md#options
134140
[arduino-cli config dump]: commands/arduino-cli_config_dump.md
135141
[arduino cli command reference]: commands/arduino-cli.md
136142
[arduino-cli global flags]: commands/arduino-cli_config.md#options-inherited-from-parent-commands

0 commit comments

Comments
 (0)