Skip to content

Commit 971b497

Browse files
committedSep 18, 2024·
Deployed 863c1ec to dev with MkDocs 1.3.0 and mike 1.1.2
1 parent c63da92 commit 971b497

File tree

8 files changed

+184
-74
lines changed

8 files changed

+184
-74
lines changed
 

‎dev/UPGRADING/index.html

Lines changed: 110 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,53 @@
276276
</label>
277277
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
278278

279+
<li class="md-nav__item">
280+
<a href="#104" class="md-nav__link">
281+
1.0.4
282+
</a>
283+
284+
<nav class="md-nav" aria-label="1.0.4">
285+
<ul class="md-nav__list">
286+
287+
<li class="md-nav__item">
288+
<a href="#the-build-cache-path-specified-with-compile-build-cache-path-or-build_cachepath-now-affects-also-sketches" class="md-nav__link">
289+
The build cache path specified with compile --build-cache-path or build_cache.path now affects also sketches.
290+
</a>
291+
292+
</li>
293+
294+
<li class="md-nav__item">
295+
<a href="#a-full-build-of-the-sketch-is-performed-if-a-build-path-is-specified-in-compile-build-path" class="md-nav__link">
296+
A full build of the sketch is performed if a build path is specified in compile --build-path ....
297+
</a>
298+
299+
<nav class="md-nav" aria-label="A full build of the sketch is performed if a build path is specified in compile --build-path ....">
300+
<ul class="md-nav__list">
301+
302+
<li class="md-nav__item">
303+
<a href="#compile-build-cache-path-is-deprecated" class="md-nav__link">
304+
compile --build-cache-path is deprecated.
305+
</a>
306+
307+
</li>
308+
309+
</ul>
310+
</nav>
311+
312+
</li>
313+
314+
<li class="md-nav__item">
315+
<a href="#the-default-build_cachepath-has-been-moved-from-the-temp-folder-to-the-users-cache-folder" class="md-nav__link">
316+
The default build_cache.path has been moved from the temp folder to the user's cache folder.
317+
</a>
318+
319+
</li>
320+
321+
</ul>
322+
</nav>
323+
324+
</li>
325+
279326
<li class="md-nav__item">
280327
<a href="#100" class="md-nav__link">
281328
1.0.0
@@ -2593,6 +2640,53 @@
25932640
</label>
25942641
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
25952642

2643+
<li class="md-nav__item">
2644+
<a href="#104" class="md-nav__link">
2645+
1.0.4
2646+
</a>
2647+
2648+
<nav class="md-nav" aria-label="1.0.4">
2649+
<ul class="md-nav__list">
2650+
2651+
<li class="md-nav__item">
2652+
<a href="#the-build-cache-path-specified-with-compile-build-cache-path-or-build_cachepath-now-affects-also-sketches" class="md-nav__link">
2653+
The build cache path specified with compile --build-cache-path or build_cache.path now affects also sketches.
2654+
</a>
2655+
2656+
</li>
2657+
2658+
<li class="md-nav__item">
2659+
<a href="#a-full-build-of-the-sketch-is-performed-if-a-build-path-is-specified-in-compile-build-path" class="md-nav__link">
2660+
A full build of the sketch is performed if a build path is specified in compile --build-path ....
2661+
</a>
2662+
2663+
<nav class="md-nav" aria-label="A full build of the sketch is performed if a build path is specified in compile --build-path ....">
2664+
<ul class="md-nav__list">
2665+
2666+
<li class="md-nav__item">
2667+
<a href="#compile-build-cache-path-is-deprecated" class="md-nav__link">
2668+
compile --build-cache-path is deprecated.
2669+
</a>
2670+
2671+
</li>
2672+
2673+
</ul>
2674+
</nav>
2675+
2676+
</li>
2677+
2678+
<li class="md-nav__item">
2679+
<a href="#the-default-build_cachepath-has-been-moved-from-the-temp-folder-to-the-users-cache-folder" class="md-nav__link">
2680+
The default build_cache.path has been moved from the temp folder to the user's cache folder.
2681+
</a>
2682+
2683+
</li>
2684+
2685+
</ul>
2686+
</nav>
2687+
2688+
</li>
2689+
25962690
<li class="md-nav__item">
25972691
<a href="#100" class="md-nav__link">
25982692
1.0.0
@@ -3866,7 +3960,22 @@
38663960

38673961

38683962
<h1 id="upgrading">Upgrading<a class="headerlink" href="#upgrading" title="Permanent link">&para;</a></h1>
3869-
<p>Here you can find a list of migration guides to handle breaking changes between releases of the CLI.</p>
3963+
<p>Here you can find a list of migration guides to handle breaking changes, deprecations, and bugfixes that may cause
3964+
problems between releases of the CLI.</p>
3965+
<h2 id="104">1.0.4<a class="headerlink" href="#104" title="Permanent link">&para;</a></h2>
3966+
<h3 id="the-build-cache-path-specified-with-compile-build-cache-path-or-build_cachepath-now-affects-also-sketches">The build cache path specified with <code>compile --build-cache-path</code> or <code>build_cache.path</code> now affects also sketches.<a class="headerlink" href="#the-build-cache-path-specified-with-compile-build-cache-path-or-build_cachepath-now-affects-also-sketches" title="Permanent link">&para;</a></h3>
3967+
<p>Previously the specified build cache path only affected cores and it was ignored for sketches. This is now fixed and
3968+
both cores and sketches are cached in the given directory.</p>
3969+
<h3 id="a-full-build-of-the-sketch-is-performed-if-a-build-path-is-specified-in-compile-build-path">A full build of the sketch is performed if a build path is specified in <code>compile --build-path ...</code>.<a class="headerlink" href="#a-full-build-of-the-sketch-is-performed-if-a-build-path-is-specified-in-compile-build-path" title="Permanent link">&para;</a></h3>
3970+
<p>Previously if a build path was specified a cached core could have been used from the global build cache path resulting
3971+
in a partial build inside the given build path.</p>
3972+
<p>Now if a build path is specified, the global build cache path is ignored and the full build is done in the given build
3973+
path.</p>
3974+
<h4 id="compile-build-cache-path-is-deprecated"><code>compile --build-cache-path</code> is deprecated.<a class="headerlink" href="#compile-build-cache-path-is-deprecated" title="Permanent link">&para;</a></h4>
3975+
<p>The change above, makes the <code>compile --build-cache-path</code> flag useless. It is kept just for backward compatibility.</p>
3976+
<h3 id="the-default-build_cachepath-has-been-moved-from-the-temp-folder-to-the-users-cache-folder">The default <code>build_cache.path</code> has been moved from the temp folder to the user's cache folder.<a class="headerlink" href="#the-default-build_cachepath-has-been-moved-from-the-temp-folder-to-the-users-cache-folder" title="Permanent link">&para;</a></h3>
3977+
<p>Previously the <code>build_cache.path</code> was in <code>$TMP/arduino</code>. Now it has been moved to the specific OS user's cache folder,
3978+
for example in Linux it happens to be <code>$HOME/.cache/arduino</code>.</p>
38703979
<h2 id="100">1.0.0<a class="headerlink" href="#100" title="Permanent link">&para;</a></h2>
38713980
<h3 id="compile-build-cache-path-slightly-changed-directory-format"><code>compile --build-cache-path</code> slightly changed directory format<a class="headerlink" href="#compile-build-cache-path-slightly-changed-directory-format" title="Permanent link">&para;</a></h3>
38723981
<p>Now compiled cores are cached under the <code>cores</code> subdir of the path specified in <code>--build-cache-path</code>, previously it was

‎dev/commands/arduino-cli_compile/index.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1463,7 +1463,6 @@ <h3 id="examples">Examples<a class="headerlink" href="#examples" title="Permanen
14631463
</code></pre></div>
14641464
<h3 id="options">Options<a class="headerlink" href="#options" title="Permanent link">&para;</a></h3>
14651465
<div class="highlight"><pre><span></span><code> --board-options strings List of board options separated by commas. Or can be used multiple times for multiple options.
1466-
--build-cache-path string Builds of &#39;core.a&#39; are saved into this path to be cached and reused.
14671466
--build-path string Path where to save compiled files. If omitted, a directory will be created in the default temporary path of your OS.
14681467
--build-property stringArray Override a build property with a custom value. Can be used multiple times for multiple properties.
14691468
--clean Optional, cleanup the build folder and do not use any cached build.

‎dev/commands/arduino-cli_debug/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1460,6 +1460,7 @@ <h3 id="examples">Examples<a class="headerlink" href="#examples" title="Permanen
14601460
</code></pre></div>
14611461
<h3 id="options">Options<a class="headerlink" href="#options" title="Permanent link">&para;</a></h3>
14621462
<div class="highlight"><pre><span></span><code> --board-options strings List of board options separated by commas. Or can be used multiple times for multiple options.
1463+
--build-path string Directory containing binaries for debug.
14631464
--debug-property stringArray Override an debug property with a custom value. Can be used multiple times for multiple properties.
14641465
--discovery-timeout duration Max time to wait for port discovery, e.g.: 30s, 1m (default 1s)
14651466
-b, --fqbn string Fully Qualified Board Name, e.g.: arduino:avr:uno

‎dev/commands/arduino-cli_upload/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1461,6 +1461,7 @@ <h3 id="examples">Examples<a class="headerlink" href="#examples" title="Permanen
14611461
</code></pre></div>
14621462
<h3 id="options">Options<a class="headerlink" href="#options" title="Permanent link">&para;</a></h3>
14631463
<div class="highlight"><pre><span></span><code> --board-options strings List of board options separated by commas. Or can be used multiple times for multiple options.
1464+
--build-path string Directory containing binaries to upload.
14641465
--discovery-timeout duration Max time to wait for port discovery, e.g.: 30s, 1m (default 1s)
14651466
-b, --fqbn string Fully Qualified Board Name, e.g.: arduino:avr:uno
14661467
-h, --help help for upload

‎dev/rpc/commands/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7302,7 +7302,7 @@ <h3 id="compilerequest">CompileRequest<a class="headerlink" href="#compilereques
73027302
<td>build_cache_path</td>
73037303
<td><a href="#string">string</a></td>
73047304
<td></td>
7305-
<td>Builds of &#39;core.a&#39; are saved into this path to be cached and reused.</td>
7305+
<td><strong>Deprecated.</strong> Builds of core and sketches are saved into this path to be cached and reused.</td>
73067306
</tr>
73077307
<tr>
73087308
<td>build_path</td>

‎dev/search/search_index.json

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

0 commit comments

Comments
 (0)
Please sign in to comment.