Skip to content

Commit 82f60c6

Browse files
authored
Document breaking change to config get command output (#2676)
* Correct typo in Upgrading docs * Document breaking change to `config get` command output Previously, the `config dump` CLI command returned the effective configuration, including both the values explicitly set via the configuration file and environment variables as well as the values provided by defaults. It was changed to only return the explicitly set configuration data. The breaking change was not documented at that time.
1 parent b8c927b commit 82f60c6

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

Diff for: docs/UPGRADING.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -530,12 +530,21 @@ breaking changes as needed.
530530
{ "sketch_path": "/tmp/my_sketch" }
531531
```
532532

533+
### `config dump` no longer returns default configuration values
534+
535+
Previously, the `config dump` CLI command returned the effective configuration, including both the values explicitly set
536+
via the configuration file and environment variables as well as the values provided by defaults.
537+
538+
It now only returns the explicitly set configuration data.
539+
540+
Use `config get <configuration key>` to get the effective value of the configuration
541+
533542
### The gRPC response `cc.arduino.cli.commands.v1.CompileResponse` has been changed.
534543

535544
The `CompilerResponse` message has been refactored to made explicit which fields are intended for streaming the build
536545
process and which fields are part of the build result.
537546

538-
The old `CompilerResposne`:
547+
The old `CompilerResponse`:
539548

540549
```protoc
541550
message CompileResponse {

0 commit comments

Comments
 (0)