Skip to content

Commit 1819eb9

Browse files
committed
Deployed 2063b6a to dev with MkDocs 1.3.0 and mike 1.1.2
1 parent 4aa0e46 commit 1819eb9

File tree

56 files changed

+158
-141
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+158
-141
lines changed

dev/UPGRADING/index.html

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,13 @@
284284
<nav class="md-nav" aria-label="0.36.0">
285285
<ul class="md-nav__list">
286286

287+
<li class="md-nav__item">
288+
<a href="#yaml-output-format-is-no-more-supported" class="md-nav__link">
289+
YAML output format is no more supported
290+
</a>
291+
292+
</li>
293+
287294
<li class="md-nav__item">
288295
<a href="#the-grpc-ccarduinoclicommandsv1compilerequestexport_binaries-changed-type" class="md-nav__link">
289296
The gRPC cc.arduino.cli.commands.v1.CompileRequest.export_binaries changed type.
@@ -2538,6 +2545,13 @@
25382545
<nav class="md-nav" aria-label="0.36.0">
25392546
<ul class="md-nav__list">
25402547

2548+
<li class="md-nav__item">
2549+
<a href="#yaml-output-format-is-no-more-supported" class="md-nav__link">
2550+
YAML output format is no more supported
2551+
</a>
2552+
2553+
</li>
2554+
25412555
<li class="md-nav__item">
25422556
<a href="#the-grpc-ccarduinoclicommandsv1compilerequestexport_binaries-changed-type" class="md-nav__link">
25432557
The gRPC cc.arduino.cli.commands.v1.CompileRequest.export_binaries changed type.
@@ -3742,6 +3756,8 @@
37423756
<h1 id="upgrading">Upgrading<a class="headerlink" href="#upgrading" title="Permanent link">&para;</a></h1>
37433757
<p>Here you can find a list of migration guides to handle breaking changes between releases of the CLI.</p>
37443758
<h2 id="0360">0.36.0<a class="headerlink" href="#0360" title="Permanent link">&para;</a></h2>
3759+
<h3 id="yaml-output-format-is-no-more-supported">YAML output format is no more supported<a class="headerlink" href="#yaml-output-format-is-no-more-supported" title="Permanent link">&para;</a></h3>
3760+
<p>The <code>yaml</code> option of the <code>--format</code> flag is no more supported. Use <code>--format json</code> if machine parsable output is needed.</p>
37453761
<h3 id="the-grpc-ccarduinoclicommandsv1compilerequestexport_binaries-changed-type">The gRPC <code>cc.arduino.cli.commands.v1.CompileRequest.export_binaries</code> changed type.<a class="headerlink" href="#the-grpc-ccarduinoclicommandsv1compilerequestexport_binaries-changed-type" title="Permanent link">&para;</a></h3>
37463762
<p>Previously the field <code>export_binaries</code> was a <code>google.protobuf.BoolValue</code>. We used this type because it expresses this
37473763
field's optional nature (that is, it could be <code>true</code>, <code>false</code>, and <code>null</code> if not set).</p>

dev/commands/arduino-cli/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1445,8 +1445,8 @@ <h3 id="examples">Examples<a class="headerlink" href="#examples" title="Permanen
14451445
<h3 id="options">Options<a class="headerlink" href="#options" title="Permanent link">&para;</a></h3>
14461446
<div class="highlight"><pre><span></span><code> --additional-urls strings Comma-separated list of additional URLs for the Boards Manager.
14471447
--config-file string The custom config file (if not specified the default will be used).
1448-
--format string The output format for the logs, can be: text, json, jsonmini, yaml (default &quot;text&quot;)
14491448
-h, --help help for arduino-cli
1449+
--json Print the output in JSON format.
14501450
--log Print the logs on the standard output.
14511451
--log-file string Path to the file where logs will be written.
14521452
--log-format string The output format for the logs, can be: text, json

dev/commands/arduino-cli_board/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1463,7 +1463,7 @@ <h3 id="options">Options<a class="headerlink" href="#options" title="Permanent l
14631463
<h3 id="options-inherited-from-parent-commands">Options inherited from parent commands<a class="headerlink" href="#options-inherited-from-parent-commands" title="Permanent link">&para;</a></h3>
14641464
<div class="highlight"><pre><span></span><code> --additional-urls strings Comma-separated list of additional URLs for the Boards Manager.
14651465
--config-file string The custom config file (if not specified the default will be used).
1466-
--format string The output format for the logs, can be: text, json, jsonmini, yaml (default &quot;text&quot;)
1466+
--json Print the output in JSON format.
14671467
--log Print the logs on the standard output.
14681468
--log-file string Path to the file where logs will be written.
14691469
--log-format string The output format for the logs, can be: text, json

dev/commands/arduino-cli_board_attach/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1472,7 +1472,7 @@ <h3 id="options">Options<a class="headerlink" href="#options" title="Permanent l
14721472
<h3 id="options-inherited-from-parent-commands">Options inherited from parent commands<a class="headerlink" href="#options-inherited-from-parent-commands" title="Permanent link">&para;</a></h3>
14731473
<div class="highlight"><pre><span></span><code> --additional-urls strings Comma-separated list of additional URLs for the Boards Manager.
14741474
--config-file string The custom config file (if not specified the default will be used).
1475-
--format string The output format for the logs, can be: text, json, jsonmini, yaml (default &quot;text&quot;)
1475+
--json Print the output in JSON format.
14761476
--log Print the logs on the standard output.
14771477
--log-file string Path to the file where logs will be written.
14781478
--log-format string The output format for the logs, can be: text, json

dev/commands/arduino-cli_board_details/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1469,7 +1469,7 @@ <h3 id="options">Options<a class="headerlink" href="#options" title="Permanent l
14691469
<h3 id="options-inherited-from-parent-commands">Options inherited from parent commands<a class="headerlink" href="#options-inherited-from-parent-commands" title="Permanent link">&para;</a></h3>
14701470
<div class="highlight"><pre><span></span><code> --additional-urls strings Comma-separated list of additional URLs for the Boards Manager.
14711471
--config-file string The custom config file (if not specified the default will be used).
1472-
--format string The output format for the logs, can be: text, json, jsonmini, yaml (default &quot;text&quot;)
1472+
--json Print the output in JSON format.
14731473
--log Print the logs on the standard output.
14741474
--log-file string Path to the file where logs will be written.
14751475
--log-format string The output format for the logs, can be: text, json

dev/commands/arduino-cli_board_list/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1468,7 +1468,7 @@ <h3 id="options">Options<a class="headerlink" href="#options" title="Permanent l
14681468
<h3 id="options-inherited-from-parent-commands">Options inherited from parent commands<a class="headerlink" href="#options-inherited-from-parent-commands" title="Permanent link">&para;</a></h3>
14691469
<div class="highlight"><pre><span></span><code> --additional-urls strings Comma-separated list of additional URLs for the Boards Manager.
14701470
--config-file string The custom config file (if not specified the default will be used).
1471-
--format string The output format for the logs, can be: text, json, jsonmini, yaml (default &quot;text&quot;)
1471+
--json Print the output in JSON format.
14721472
--log Print the logs on the standard output.
14731473
--log-file string Path to the file where logs will be written.
14741474
--log-format string The output format for the logs, can be: text, json

dev/commands/arduino-cli_board_listall/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1467,7 +1467,7 @@ <h3 id="options">Options<a class="headerlink" href="#options" title="Permanent l
14671467
<h3 id="options-inherited-from-parent-commands">Options inherited from parent commands<a class="headerlink" href="#options-inherited-from-parent-commands" title="Permanent link">&para;</a></h3>
14681468
<div class="highlight"><pre><span></span><code> --additional-urls strings Comma-separated list of additional URLs for the Boards Manager.
14691469
--config-file string The custom config file (if not specified the default will be used).
1470-
--format string The output format for the logs, can be: text, json, jsonmini, yaml (default &quot;text&quot;)
1470+
--json Print the output in JSON format.
14711471
--log Print the logs on the standard output.
14721472
--log-file string Path to the file where logs will be written.
14731473
--log-format string The output format for the logs, can be: text, json

dev/commands/arduino-cli_board_search/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1466,7 +1466,7 @@ <h3 id="options">Options<a class="headerlink" href="#options" title="Permanent l
14661466
<h3 id="options-inherited-from-parent-commands">Options inherited from parent commands<a class="headerlink" href="#options-inherited-from-parent-commands" title="Permanent link">&para;</a></h3>
14671467
<div class="highlight"><pre><span></span><code> --additional-urls strings Comma-separated list of additional URLs for the Boards Manager.
14681468
--config-file string The custom config file (if not specified the default will be used).
1469-
--format string The output format for the logs, can be: text, json, jsonmini, yaml (default &quot;text&quot;)
1469+
--json Print the output in JSON format.
14701470
--log Print the logs on the standard output.
14711471
--log-file string Path to the file where logs will be written.
14721472
--log-format string The output format for the logs, can be: text, json

dev/commands/arduino-cli_burn-bootloader/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1472,7 +1472,7 @@ <h3 id="options">Options<a class="headerlink" href="#options" title="Permanent l
14721472
<h3 id="options-inherited-from-parent-commands">Options inherited from parent commands<a class="headerlink" href="#options-inherited-from-parent-commands" title="Permanent link">&para;</a></h3>
14731473
<div class="highlight"><pre><span></span><code> --additional-urls strings Comma-separated list of additional URLs for the Boards Manager.
14741474
--config-file string The custom config file (if not specified the default will be used).
1475-
--format string The output format for the logs, can be: text, json, jsonmini, yaml (default &quot;text&quot;)
1475+
--json Print the output in JSON format.
14761476
--log Print the logs on the standard output.
14771477
--log-file string Path to the file where logs will be written.
14781478
--log-format string The output format for the logs, can be: text, json

dev/commands/arduino-cli_cache/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1463,7 +1463,7 @@ <h3 id="options">Options<a class="headerlink" href="#options" title="Permanent l
14631463
<h3 id="options-inherited-from-parent-commands">Options inherited from parent commands<a class="headerlink" href="#options-inherited-from-parent-commands" title="Permanent link">&para;</a></h3>
14641464
<div class="highlight"><pre><span></span><code> --additional-urls strings Comma-separated list of additional URLs for the Boards Manager.
14651465
--config-file string The custom config file (if not specified the default will be used).
1466-
--format string The output format for the logs, can be: text, json, jsonmini, yaml (default &quot;text&quot;)
1466+
--json Print the output in JSON format.
14671467
--log Print the logs on the standard output.
14681468
--log-file string Path to the file where logs will be written.
14691469
--log-format string The output format for the logs, can be: text, json

dev/commands/arduino-cli_cache_clean/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1464,7 +1464,7 @@ <h3 id="options">Options<a class="headerlink" href="#options" title="Permanent l
14641464
<h3 id="options-inherited-from-parent-commands">Options inherited from parent commands<a class="headerlink" href="#options-inherited-from-parent-commands" title="Permanent link">&para;</a></h3>
14651465
<div class="highlight"><pre><span></span><code> --additional-urls strings Comma-separated list of additional URLs for the Boards Manager.
14661466
--config-file string The custom config file (if not specified the default will be used).
1467-
--format string The output format for the logs, can be: text, json, jsonmini, yaml (default &quot;text&quot;)
1467+
--json Print the output in JSON format.
14681468
--log Print the logs on the standard output.
14691469
--log-file string Path to the file where logs will be written.
14701470
--log-format string The output format for the logs, can be: text, json

dev/commands/arduino-cli_compile/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1496,7 +1496,7 @@ <h3 id="options">Options<a class="headerlink" href="#options" title="Permanent l
14961496
<h3 id="options-inherited-from-parent-commands">Options inherited from parent commands<a class="headerlink" href="#options-inherited-from-parent-commands" title="Permanent link">&para;</a></h3>
14971497
<div class="highlight"><pre><span></span><code> --additional-urls strings Comma-separated list of additional URLs for the Boards Manager.
14981498
--config-file string The custom config file (if not specified the default will be used).
1499-
--format string The output format for the logs, can be: text, json, jsonmini, yaml (default &quot;text&quot;)
1499+
--json Print the output in JSON format.
15001500
--log Print the logs on the standard output.
15011501
--log-file string Path to the file where logs will be written.
15021502
--log-format string The output format for the logs, can be: text, json

dev/commands/arduino-cli_completion/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1466,7 +1466,7 @@ <h3 id="options">Options<a class="headerlink" href="#options" title="Permanent l
14661466
<h3 id="options-inherited-from-parent-commands">Options inherited from parent commands<a class="headerlink" href="#options-inherited-from-parent-commands" title="Permanent link">&para;</a></h3>
14671467
<div class="highlight"><pre><span></span><code> --additional-urls strings Comma-separated list of additional URLs for the Boards Manager.
14681468
--config-file string The custom config file (if not specified the default will be used).
1469-
--format string The output format for the logs, can be: text, json, jsonmini, yaml (default &quot;text&quot;)
1469+
--json Print the output in JSON format.
14701470
--log Print the logs on the standard output.
14711471
--log-file string Path to the file where logs will be written.
14721472
--log-format string The output format for the logs, can be: text, json

dev/commands/arduino-cli_config/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1446,7 +1446,7 @@ <h3 id="options">Options<a class="headerlink" href="#options" title="Permanent l
14461446
<h3 id="options-inherited-from-parent-commands">Options inherited from parent commands<a class="headerlink" href="#options-inherited-from-parent-commands" title="Permanent link">&para;</a></h3>
14471447
<div class="highlight"><pre><span></span><code> --additional-urls strings Comma-separated list of additional URLs for the Boards Manager.
14481448
--config-file string The custom config file (if not specified the default will be used).
1449-
--format string The output format for the logs, can be: text, json, jsonmini, yaml (default &quot;text&quot;)
1449+
--json Print the output in JSON format.
14501450
--log Print the logs on the standard output.
14511451
--log-file string Path to the file where logs will be written.
14521452
--log-format string The output format for the logs, can be: text, json

dev/commands/arduino-cli_config_add/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1465,7 +1465,7 @@ <h3 id="options">Options<a class="headerlink" href="#options" title="Permanent l
14651465
<h3 id="options-inherited-from-parent-commands">Options inherited from parent commands<a class="headerlink" href="#options-inherited-from-parent-commands" title="Permanent link">&para;</a></h3>
14661466
<div class="highlight"><pre><span></span><code> --additional-urls strings Comma-separated list of additional URLs for the Boards Manager.
14671467
--config-file string The custom config file (if not specified the default will be used).
1468-
--format string The output format for the logs, can be: text, json, jsonmini, yaml (default &quot;text&quot;)
1468+
--json Print the output in JSON format.
14691469
--log Print the logs on the standard output.
14701470
--log-file string Path to the file where logs will be written.
14711471
--log-format string The output format for the logs, can be: text, json

dev/commands/arduino-cli_config_delete/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1465,7 +1465,7 @@ <h3 id="options">Options<a class="headerlink" href="#options" title="Permanent l
14651465
<h3 id="options-inherited-from-parent-commands">Options inherited from parent commands<a class="headerlink" href="#options-inherited-from-parent-commands" title="Permanent link">&para;</a></h3>
14661466
<div class="highlight"><pre><span></span><code> --additional-urls strings Comma-separated list of additional URLs for the Boards Manager.
14671467
--config-file string The custom config file (if not specified the default will be used).
1468-
--format string The output format for the logs, can be: text, json, jsonmini, yaml (default &quot;text&quot;)
1468+
--json Print the output in JSON format.
14691469
--log Print the logs on the standard output.
14701470
--log-file string Path to the file where logs will be written.
14711471
--log-format string The output format for the logs, can be: text, json

dev/commands/arduino-cli_config_dump/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1464,7 +1464,7 @@ <h3 id="options">Options<a class="headerlink" href="#options" title="Permanent l
14641464
<h3 id="options-inherited-from-parent-commands">Options inherited from parent commands<a class="headerlink" href="#options-inherited-from-parent-commands" title="Permanent link">&para;</a></h3>
14651465
<div class="highlight"><pre><span></span><code> --additional-urls strings Comma-separated list of additional URLs for the Boards Manager.
14661466
--config-file string The custom config file (if not specified the default will be used).
1467-
--format string The output format for the logs, can be: text, json, jsonmini, yaml (default &quot;text&quot;)
1467+
--json Print the output in JSON format.
14681468
--log Print the logs on the standard output.
14691469
--log-file string Path to the file where logs will be written.
14701470
--log-format string The output format for the logs, can be: text, json

dev/commands/arduino-cli_config_get/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1385,7 +1385,7 @@ <h3 id="options">Options<a class="headerlink" href="#options" title="Permanent l
13851385
<h3 id="options-inherited-from-parent-commands">Options inherited from parent commands<a class="headerlink" href="#options-inherited-from-parent-commands" title="Permanent link">&para;</a></h3>
13861386
<div class="highlight"><pre><span></span><code> --additional-urls strings Comma-separated list of additional URLs for the Boards Manager.
13871387
--config-file string The custom config file (if not specified the default will be used).
1388-
--format string The output format for the logs, can be: text, json, jsonmini, yaml (default &quot;text&quot;)
1388+
--json Print the output in JSON format.
13891389
--log Print the logs on the standard output.
13901390
--log-file string Path to the file where logs will be written.
13911391
--log-format string The output format for the logs, can be: text, json

dev/commands/arduino-cli_config_init/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1470,7 +1470,7 @@ <h3 id="options">Options<a class="headerlink" href="#options" title="Permanent l
14701470
<h3 id="options-inherited-from-parent-commands">Options inherited from parent commands<a class="headerlink" href="#options-inherited-from-parent-commands" title="Permanent link">&para;</a></h3>
14711471
<div class="highlight"><pre><span></span><code> --additional-urls strings Comma-separated list of additional URLs for the Boards Manager.
14721472
--config-file string The custom config file (if not specified the default will be used).
1473-
--format string The output format for the logs, can be: text, json, jsonmini, yaml (default &quot;text&quot;)
1473+
--json Print the output in JSON format.
14741474
--log Print the logs on the standard output.
14751475
--log-file string Path to the file where logs will be written.
14761476
--log-format string The output format for the logs, can be: text, json

0 commit comments

Comments
 (0)