Skip to content

Commit f271170

Browse files
committed
Deployed b0cc1a9 to dev with MkDocs 1.3.0 and mike 1.1.2
1 parent 84eabc4 commit f271170

File tree

5 files changed

+442
-76
lines changed

5 files changed

+442
-76
lines changed

dev/UPGRADING/index.html

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -317,6 +317,13 @@
317317
The gRPC cc.arduino.cli.commands.v1.CompileRequest.export_binaries changed type.
318318
</a>
319319

320+
</li>
321+
322+
<li class="md-nav__item">
323+
<a href="#some-grpc-responses-messages-now-uses-the-oneof-clause" class="md-nav__link">
324+
Some gRPC responses messages now uses the oneof clause.
325+
</a>
326+
320327
</li>
321328

322329
<li class="md-nav__item">
@@ -2599,6 +2606,13 @@
25992606
The gRPC cc.arduino.cli.commands.v1.CompileRequest.export_binaries changed type.
26002607
</a>
26012608

2609+
</li>
2610+
2611+
<li class="md-nav__item">
2612+
<a href="#some-grpc-responses-messages-now-uses-the-oneof-clause" class="md-nav__link">
2613+
Some gRPC responses messages now uses the oneof clause.
2614+
</a>
2615+
26022616
</li>
26032617

26042618
<li class="md-nav__item">
@@ -3957,6 +3971,48 @@ <h3 id="the-grpc-ccarduinoclicommandsv1compilerequestexport_binaries-changed-typ
39573971
<p>Previously the field <code>export_binaries</code> was a <code>google.protobuf.BoolValue</code>. We used this type because it expresses this
39583972
field's optional nature (that is, it could be <code>true</code>, <code>false</code>, and <code>null</code> if not set).</p>
39593973
<p>Now the field is an <code>optional bool</code>, since the latest protobuf protocol changes now allows optional fields.</p>
3974+
<h3 id="some-grpc-responses-messages-now-uses-the-oneof-clause">Some gRPC responses messages now uses the <code>oneof</code> clause.<a class="headerlink" href="#some-grpc-responses-messages-now-uses-the-oneof-clause" title="Permanent link">&para;</a></h3>
3975+
<p>The following responses message:</p>
3976+
<ul>
3977+
<li><code>cc.arduino.cli.commands.v1.PlatformInstallResponse</code></li>
3978+
<li><code>cc.arduino.cli.commands.v1.PlatformDownloadResponse</code></li>
3979+
<li><code>cc.arduino.cli.commands.v1.PlatformUninstallResponse</code></li>
3980+
<li><code>cc.arduino.cli.commands.v1.PlatformUpgradeResponse</code></li>
3981+
<li><code>cc.arduino.cli.commands.v1.DebugResponse</code></li>
3982+
<li><code>cc.arduino.cli.commands.v1.LibraryDownloadResponse</code></li>
3983+
<li><code>cc.arduino.cli.commands.v1.LibraryInstallResponse</code></li>
3984+
<li><code>cc.arduino.cli.commands.v1.LibraryUpgradeResponse</code></li>
3985+
<li><code>cc.arduino.cli.commands.v1.LibraryUninstallResponse</code></li>
3986+
<li><code>cc.arduino.cli.commands.v1.LibraryUpgradeAllResponse</code></li>
3987+
<li><code>cc.arduino.cli.commands.v1.ZipLibraryInstallResponse</code></li>
3988+
<li><code>cc.arduino.cli.commands.v1.GitLibraryInstallResponse</code></li>
3989+
<li><code>cc.arduino.cli.commands.v1.MonitorResponse</code></li>
3990+
</ul>
3991+
<p>now use the <code>oneof</code> clause to make the stream nature of the message more explicit. Just to give an example, the
3992+
<code>PlatformInstallResponse</code> message has been changed from:</p>
3993+
<div class="highlight"><pre><span></span><code><span class="kd">message</span><span class="w"> </span><span class="nc">PlatformInstallResponse</span><span class="w"> </span><span class="p">{</span>
3994+
<span class="w"> </span><span class="c1">// Progress of the downloads of the platform and tool files.</span>
3995+
<span class="w"> </span><span class="n">DownloadProgress</span><span class="w"> </span><span class="na">progress</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span>
3996+
<span class="w"> </span><span class="c1">// Description of the current stage of the installation.</span>
3997+
<span class="w"> </span><span class="n">TaskProgress</span><span class="w"> </span><span class="na">task_progress</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span>
3998+
<span class="p">}</span>
3999+
</code></pre></div>
4000+
<p>to:</p>
4001+
<div class="highlight"><pre><span></span><code><span class="kd">message</span><span class="w"> </span><span class="nc">PlatformInstallResponse</span><span class="w"> </span><span class="p">{</span>
4002+
<span class="w"> </span><span class="kd">message</span><span class="w"> </span><span class="nc">Result</span><span class="w"> </span><span class="p">{</span>
4003+
<span class="w"> </span><span class="c1">// Empty message, reserved for future expansion.</span>
4004+
<span class="w"> </span><span class="p">}</span>
4005+
<span class="w"> </span><span class="k">oneof</span><span class="w"> </span><span class="kd">message</span><span class="w"> </span><span class="p">{</span>
4006+
<span class="w"> </span><span class="c1">// Progress of the downloads of the platform and tool files.</span>
4007+
<span class="w"> </span><span class="n">DownloadProgress</span><span class="w"> </span><span class="na">progress</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span>
4008+
<span class="w"> </span><span class="c1">// Description of the current stage of the installation.</span>
4009+
<span class="w"> </span><span class="n">TaskProgress</span><span class="w"> </span><span class="na">task_progress</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span>
4010+
<span class="w"> </span><span class="c1">// The installation result.</span>
4011+
<span class="w"> </span><span class="n">Result</span><span class="w"> </span><span class="na">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span>
4012+
<span class="w"> </span><span class="p">}</span>
4013+
<span class="p">}</span>
4014+
</code></pre></div>
4015+
<p>The other messages have been changed in a similar way.</p>
39604016
<h3 id="the-grpc-ccarduinoclicommandsv1updateindexresponse-and-updatelibrariesindexresponse-have-changed">The gRPC <code>cc.arduino.cli.commands.v1.UpdateIndexResponse</code> and <code>UpdateLibrariesIndexResponse</code> have changed.<a class="headerlink" href="#the-grpc-ccarduinoclicommandsv1updateindexresponse-and-updatelibrariesindexresponse-have-changed" title="Permanent link">&para;</a></h3>
39614017
<p>The responses coming from the update index commands:</p>
39624018
<div class="highlight"><pre><span></span><code><span class="kd">message</span><span class="w"> </span><span class="nc">UpdateIndexResponse</span><span class="w"> </span><span class="p">{</span>

0 commit comments

Comments
 (0)