Skip to content

Commit 2d0a65c

Browse files
authored
Merge pull request #35 from MDK-Packs/final_1_66_edits
Final changes + built docs
2 parents ae8a69a + b80d6a5 commit 2d0a65c

File tree

6 files changed

+27
-8
lines changed

6 files changed

+27
-8
lines changed

docs/create_app.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,8 @@ You can:
321321
322322
1. Switch between [*components*](#software-components-view) and *software packs*.
323323
2. View only software packs that are *part of the csolution* or view *all installed packs*.
324-
3. Select the scope for which the software pack selection applies (solution/project/layer).
324+
3. Using the drop down, select the cproject/clayer scope. It always shows all packs but "highlights" (greyed) the packs
325+
specified in "scope".
325326
4. Examine on which level the packs are references (csolution/cproject/clayer).
326327
5. [*Manage software packs*](#manage-software-packs).
327328
6. Open *related documentation*.
@@ -337,7 +338,7 @@ In the **Current References** section, you can:
337338
- Set the specific
338339
[version](https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/pdsc_package_pg.html#VersionType) for a
339340
pack to be used on the csolution/cproject/clayer level. Use these version specifiers:
340-
- `Unspecified`: use the latest installed version of a pack
341+
- `Unspecified`: use the latest installed version of a pack and the `cbuild-pack.yml` for locked versions.
341342
- `@`: exact version
342343
- `@>=`: equal or higher
343344
- `@^`: equal or higher with same major version
@@ -346,4 +347,8 @@ In the **Current References** section, you can:
346347

347348
Below that, the *used pack* version is shown. It is computed from the requirements above.
348349

349-
In the **Update Pack** section, you can see the latest installed version and check for updates.
350+
In the **Update Pack** section, you can see the latest installed version and check for updates. The button on the left
351+
is enabled when there is a more recent version of a pack installed, but the `cbuild-pack.yml` locks it to a
352+
smaller version. When pressing the button, the `cbuild-pack.yml` entry will be removed on save and the latest installed
353+
pack version will be set and used. The button to the right opens the version page of a public pack on
354+
[keil.arm.com](https://www.keil.arm.com/packs) which then also shows you the latest available pack version.

docs/debug.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -467,6 +467,10 @@ files in solution's `.vscode/launch.json.d/` and `.vscode/tasks.json.d/` directo
467467
active solution applying the same rules as above. This can be used to include solution specific content into the
468468
workspace configuration based on the currently used solution.
469469

470+
!!! Note
471+
To trigger an update of the `launch.json` and `tasks.json` files, press `Ctrl/Cmd+Shift+p` and select
472+
**Update Debug Tasks and Launch Configurations**.
473+
470474
### pyOCD
471475

472476
In the [Manage Solution](./manage_settings.md) dialog, select the one of the debug adapters named **xyz@pyOCD**:

site/create_app.html

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -468,7 +468,8 @@ <h3 id="software-packs">Software packs</h3>
468468
<ol>
469469
<li>Switch between <a href="#software-components-view"><em>components</em></a> and <em>software packs</em>.</li>
470470
<li>View only software packs that are <em>part of the csolution</em> or view <em>all installed packs</em>.</li>
471-
<li>Select the scope for which the software pack selection applies (solution/project/layer).</li>
471+
<li>Using the drop down, select the cproject/clayer scope. It always shows all packs but "highlights" (greyed) the packs
472+
specified in "scope".</li>
472473
<li>Examine on which level the packs are references (csolution/cproject/clayer).</li>
473474
<li><a href="#manage-software-packs"><em>Manage software packs</em></a>.</li>
474475
<li>Open <em>related documentation</em>.</li>
@@ -481,7 +482,7 @@ <h4 id="manage-software-packs">Manage software packs</h4>
481482
<li>Set the specific
482483
<a href="https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/pdsc_package_pg.html#VersionType">version</a> for a
483484
pack to be used on the csolution/cproject/clayer level. Use these version specifiers:<ul>
484-
<li><code>Unspecified</code>: use the latest installed version of a pack</li>
485+
<li><code>Unspecified</code>: use the latest installed version of a pack and the <code>cbuild-pack.yml</code> for locked versions.</li>
485486
<li><code>@</code>: exact version</li>
486487
<li><code>@&gt;=</code>: equal or higher</li>
487488
<li><code>@^</code>: equal or higher with same major version</li>
@@ -491,7 +492,11 @@ <h4 id="manage-software-packs">Manage software packs</h4>
491492
<li>Add a pack to a csolution/cproject/clayer.</li>
492493
</ul>
493494
<p>Below that, the <em>used pack</em> version is shown. It is computed from the requirements above.</p>
494-
<p>In the <strong>Update Pack</strong> section, you can see the latest installed version and check for updates.</p>
495+
<p>In the <strong>Update Pack</strong> section, you can see the latest installed version and check for updates. The button on the left
496+
is enabled when there is a more recent version of a pack installed, but the <code>cbuild-pack.yml</code> locks it to a
497+
smaller version. When pressing the button, the <code>cbuild-pack.yml</code> entry will be removed on save and the latest installed
498+
pack version will be set and used. The button to the right opens the version page of a public pack on
499+
<a href="https://www.keil.arm.com/packs">keil.arm.com</a> which then also shows you the latest available pack version.</p>
495500

496501
</div>
497502
</div><footer>

site/debug.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -673,6 +673,11 @@ <h3 id="custom-launchjson-and-tasksjson-settings">Custom <code>launch.json</code
673673
files in solution's <code>.vscode/launch.json.d/</code> and <code>.vscode/tasks.json.d/</code> directories are included for the
674674
active solution applying the same rules as above. This can be used to include solution specific content into the
675675
workspace configuration based on the currently used solution.</p>
676+
<div class="admonition note">
677+
<p class="admonition-title">Note</p>
678+
<p>To trigger an update of the <code>launch.json</code> and <code>tasks.json</code> files, press <code>Ctrl/Cmd+Shift+p</code> and select
679+
<strong>Update Debug Tasks and Launch Configurations</strong>.</p>
680+
</div>
676681
<h3 id="pyocd">pyOCD</h3>
677682
<p>In the <a href="manage_settings.html">Manage Solution</a> dialog, select the one of the debug adapters named <strong>xyz@pyOCD</strong>:</p>
678683
<p>For the <strong>Debug Interface</strong>, you can:</p>

site/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -272,5 +272,5 @@ <h2 id="revision-history">Revision history</h2>
272272

273273
<!--
274274
MkDocs version : 1.6.1
275-
Build Date UTC : 2026-02-11 10:15:03.229320+00:00
275+
Build Date UTC : 2026-02-11 13:42:43.964232+00:00
276276
-->

site/search/search_index.json

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

0 commit comments

Comments
 (0)