Skip to content

Commit b00a771

Browse files
committed
Deployed b72f5ca to dev with MkDocs 1.3.0 and mike 1.1.2
1 parent 8e4d1a6 commit b00a771

File tree

5 files changed

+125
-72
lines changed

5 files changed

+125
-72
lines changed

dev/UPGRADING/index.html

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -317,6 +317,20 @@
317317
YAML output format is no more supported
318318
</a>
319319

320+
</li>
321+
322+
<li class="md-nav__item">
323+
<a href="#grpc-the-type-field-has-been-renamed-to-types-in-the-ccarduinoclicommandsv1platformrelease-message" class="md-nav__link">
324+
gRPC: The type field has been renamed to types in the cc.arduino.cli.commands.v1.PlatformRelease message.
325+
</a>
326+
327+
</li>
328+
329+
<li class="md-nav__item">
330+
<a href="#the-type-field-has-been-renamed-to-types-in-the-json-output-including-a-platform-release" class="md-nav__link">
331+
The type field has been renamed to types in the JSON output including a platform release.
332+
</a>
333+
320334
</li>
321335

322336
<li class="md-nav__item">
@@ -2613,6 +2627,20 @@
26132627
YAML output format is no more supported
26142628
</a>
26152629

2630+
</li>
2631+
2632+
<li class="md-nav__item">
2633+
<a href="#grpc-the-type-field-has-been-renamed-to-types-in-the-ccarduinoclicommandsv1platformrelease-message" class="md-nav__link">
2634+
gRPC: The type field has been renamed to types in the cc.arduino.cli.commands.v1.PlatformRelease message.
2635+
</a>
2636+
2637+
</li>
2638+
2639+
<li class="md-nav__item">
2640+
<a href="#the-type-field-has-been-renamed-to-types-in-the-json-output-including-a-platform-release" class="md-nav__link">
2641+
The type field has been renamed to types in the JSON output including a platform release.
2642+
</a>
2643+
26162644
</li>
26172645

26182646
<li class="md-nav__item">
@@ -3985,6 +4013,31 @@ <h3 id="golang-importing-arduino-cli-as-a-library-now-requires-the-creation-of-a
39854013
</code></pre></div>
39864014
<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>
39874015
<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>
4016+
<h3 id="grpc-the-type-field-has-been-renamed-to-types-in-the-ccarduinoclicommandsv1platformrelease-message">gRPC: The <code>type</code> field has been renamed to <code>types</code> in the <code>cc.arduino.cli.commands.v1.PlatformRelease</code> message.<a class="headerlink" href="#grpc-the-type-field-has-been-renamed-to-types-in-the-ccarduinoclicommandsv1platformrelease-message" title="Permanent link">&para;</a></h3>
4017+
<p>Rebuilding the gRPC bindings from the proto files requires to rename all access to <code>type</code> field as <code>types</code>.</p>
4018+
<p>By the way, the wire protocol is not affected by this change, existing clients should work fine without modification.</p>
4019+
<h3 id="the-type-field-has-been-renamed-to-types-in-the-json-output-including-a-platform-release">The <code>type</code> field has been renamed to <code>types</code> in the JSON output including a platform release.<a class="headerlink" href="#the-type-field-has-been-renamed-to-types-in-the-json-output-including-a-platform-release" title="Permanent link">&para;</a></h3>
4020+
<p>Since the <code>type</code> field may contain multiple values has been renamed to <code>types</code> to better express this aspect.</p>
4021+
<p>Previously:</p>
4022+
<div class="highlight"><pre><span></span><code>$ arduino-cli core list --json | jq &#39;.platforms[4].releases.&quot;1.8.13&quot;&#39;
4023+
{
4024+
&quot;name&quot;: &quot;Arduino SAMD (32-bits ARM Cortex-M0+) Boards&quot;,
4025+
&quot;version&quot;: &quot;1.8.13&quot;,
4026+
&quot;type&quot;: [
4027+
&quot;Arduino&quot;
4028+
],
4029+
...
4030+
</code></pre></div>
4031+
<p>Now:</p>
4032+
<div class="highlight"><pre><span></span><code>$ arduino-cli core list --json | jq &#39;.platforms[4].releases.&quot;1.8.13&quot;&#39;
4033+
{
4034+
&quot;name&quot;: &quot;Arduino SAMD (32-bits ARM Cortex-M0+) Boards&quot;,
4035+
&quot;version&quot;: &quot;1.8.13&quot;,
4036+
&quot;types&quot;: [
4037+
&quot;Arduino&quot;
4038+
],
4039+
...
4040+
</code></pre></div>
39884041
<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>
39894042
<p>Previously the field <code>export_binaries</code> was a <code>google.protobuf.BoolValue</code>. We used this type because it expresses this
39904043
field's optional nature (that is, it could be <code>true</code>, <code>false</code>, and <code>null</code> if not set).</p>

dev/rpc/commands/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6773,7 +6773,7 @@ <h3 id="platformrelease">PlatformRelease<a class="headerlink" href="#platformrel
67736773
<td>Version of the platform release</td>
67746774
</tr>
67756775
<tr>
6776-
<td>type</td>
6776+
<td>types</td>
67776777
<td><a href="#string">string</a></td>
67786778
<td>repeated</td>
67796779
<td>Type of the platform.</td>

dev/search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)