Skip to content

Commit 720d688

Browse files
committed
Built documentation
1 parent 8480c17 commit 720d688

20 files changed

+216
-251
lines changed

site/404.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
<a href="/index.html" class="icon icon-home"> Arm Keil Studio for VS Code
2828
</a>
2929
<div class="version">
30-
1.64.0
30+
1.66.0
3131
</div><div role="search">
3232
<form id ="rtd-search-form" class="wy-form" action="//search.html" method="get">
3333
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
@@ -81,7 +81,7 @@
8181
</li>
8282
</ul>
8383
<ul>
84-
<li class="toctree-l1"><a class="reference internal" href="/read_further.html">Read further</a>
84+
<li class="toctree-l1"><a class="reference internal" href="/reldocs.html">Related documentation</a>
8585
</li>
8686
</ul>
8787
<ul>

site/build_run.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
<a href="index.html" class="icon icon-home"> Arm Keil Studio for VS Code
3535
</a>
3636
<div class="version">
37-
1.64.0
37+
1.66.0
3838
</div><div role="search">
3939
<form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
4040
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
@@ -102,7 +102,7 @@
102102
</li>
103103
</ul>
104104
<ul>
105-
<li class="toctree-l1"><a class="reference internal" href="read_further.html">Read further</a>
105+
<li class="toctree-l1"><a class="reference internal" href="reldocs.html">Related documentation</a>
106106
</li>
107107
</ul>
108108
<ul>

site/create_app.html

Lines changed: 49 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
<a href="index.html" class="icon icon-home"> Arm Keil Studio for VS Code
3535
</a>
3636
<div class="version">
37-
1.64.0
37+
1.66.0
3838
</div><div role="search">
3939
<form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
4040
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
@@ -72,15 +72,21 @@
7272
</li>
7373
<li class="toctree-l2"><a class="reference internal" href="#configure-a-solution">Configure a solution</a>
7474
</li>
75-
<li class="toctree-l2"><a class="reference internal" href="#software-components">Software components</a>
75+
<li class="toctree-l2"><a class="reference internal" href="#software-components-and-packs">Software components and packs</a>
7676
<ul>
7777
<li class="toctree-l3"><a class="reference internal" href="#software-components-view">Software Components view</a>
7878
<ul>
7979
<li class="toctree-l4"><a class="reference internal" href="#validation">Validation</a>
8080
</li>
8181
</ul>
8282
</li>
83-
<li class="toctree-l3"><a class="reference internal" href="#rtos-example">RTOS Example</a>
83+
<li class="toctree-l3"><a class="reference internal" href="#rtos-example">RTOS example</a>
84+
</li>
85+
<li class="toctree-l3"><a class="reference internal" href="#software-packs">Software packs</a>
86+
<ul>
87+
<li class="toctree-l4"><a class="reference internal" href="#manage-software-packs">Manage software packs</a>
88+
</li>
89+
</ul>
8490
</li>
8591
</ul>
8692
</li>
@@ -116,7 +122,7 @@
116122
</li>
117123
</ul>
118124
<ul>
119-
<li class="toctree-l1"><a class="reference internal" href="read_further.html">Read further</a>
125+
<li class="toctree-l1"><a class="reference internal" href="reldocs.html">Related documentation</a>
120126
</li>
121127
</ul>
122128
<ul>
@@ -301,7 +307,7 @@ <h2 id="templates">Templates</h2>
301307
!!! CAUTION
302308
If you see this warning:
303309
![Task errors output](./images/task-errors.png)
304-
Click **Show output** to configure the solution. You can add board, shield, or socket layers to your reference
310+
Click **Show output** to¬ configure the solution. You can add board, shield, or socket layers to your reference
305311
application. You can also select a compiler for reference applications and other solution types.
306312
307313
Depending on the selected example, you might need to [configure the solution](./configuration.md#configure-a-solution)
@@ -368,27 +374,19 @@ <h2 id="configure-a-solution">Configure a solution</h2>
368374
connections are detailed.</li>
369375
</ul>
370376
</div>
371-
<h2 id="software-components">Software components</h2>
377+
<h2 id="software-components-and-packs">Software components and packs</h2>
372378
<p>A <a href="https://open-cmsis-pack.github.io/cmsis-toolbox/CreateApplications/#software-components">software component</a>
373-
encapsulates a set of related functions. The <strong>Software Components</strong> view shows all the software components selected in
374-
the active project of a solution.</p>
375-
<p>You can:</p>
376-
<ul>
377-
<li>
378-
<p>Modify the software components of the project.</p>
379-
</li>
380-
<li>
381-
<p>Manage the dependencies between components for each target type defined in your solution, or for all the target types at
382-
once.</p>
383-
</li>
384-
</ul>
379+
encapsulates a set of related functions and is delivered in a
380+
<a href="https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/index.html">software pack</a>. The
381+
<strong>Software Components</strong> view enables you to manage the software components and software packs selected in the active
382+
project of a solution.</p>
385383
<h3 id="software-components-view">Software Components view</h3>
386384
<p>Open the <strong>CMSIS view</strong> and click <img alt="Manage software components" src="images/software-components-icon.png" /> to open the
387385
<strong>Software Components</strong> view:</p>
388-
<p><img alt="The 'Software Components' " src="images/software-components-view.png" /></p>
386+
<p><img alt="The 'Software Components' view" src="images/software-components-view.png" /></p>
389387
<p>You can:</p>
390388
<ol>
391-
<li>Switch between <em>components</em> and <em>software packs</em>.</li>
389+
<li>Switch between <em>components</em> and <a href="#software-packs"><em>software packs</em></a>.</li>
392390
<li>View only components that are <em>part of the csolution</em> or components from <em>all installed packs</em>.</li>
393391
<li>Set the <em>context</em> for which the component selection applies (including layers).</li>
394392
<li><em>Select/remove</em> software components.</li>
@@ -439,7 +437,7 @@ <h4 id="validation">Validation</h4>
439437
components available).</li>
440438
</ol>
441439
<p>When done, don't forget to <strong>Save</strong> the changes!</p>
442-
<h3 id="rtos-example">RTOS Example</h3>
440+
<h3 id="rtos-example">RTOS example</h3>
443441
<p>This example shows how to add a real-time operating systems (RTOS), such as Keil RTX5.</p>
444442
<p>Before adding the component, add the CMSIS-RTX pack to your local installation. In a Terminal, run:</p>
445443
<pre><code class="language-sh">cpackget add ARM::CMSIS-RTX
@@ -464,6 +462,36 @@ <h3 id="rtos-example">RTOS Example</h3>
464462
# CMSIS-Pack containing the RTOS component added:
465463
- pack: ARM::CMSIS-RTX
466464
</code></pre>
465+
<h3 id="software-packs">Software packs</h3>
466+
<p><img alt="The 'Software Components - Software packs' view" src="images/software-packs.png" /></p>
467+
<p>You can:</p>
468+
<ol>
469+
<li>Switch between <a href="#software-components-view"><em>components</em></a> and <em>software packs</em>.</li>
470+
<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>
472+
<li>Examine on which level the packs are references (csolution/cproject/clayer).</li>
473+
<li><a href="#manage-software-packs"><em>Manage software packs</em></a>.</li>
474+
<li>Open <em>related documentation</em>.</li>
475+
</ol>
476+
<h4 id="manage-software-packs">Manage software packs</h4>
477+
<p>Click on either icon: <img alt="Manage software packs" src="images/manage-packs.png" /> to open the <strong>Manage Pack</strong> dialog:</p>
478+
<p><img alt="Manage Pack dialog" src="images/manage-pack-dialog.png" /></p>
479+
<p>In the <strong>Current References</strong> section, you can:</p>
480+
<ul>
481+
<li>Set the specific
482+
<a href="https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/pdsc_package_pg.html#VersionType">version</a> for a
483+
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>@</code>: exact version</li>
486+
<li><code>@&gt;=</code>: equal or higher</li>
487+
<li><code>@^</code>: equal or higher with same major version</li>
488+
<li><code>@~</code>: Equal or higher with same major <em>and</em> minor version</li>
489+
</ul>
490+
</li>
491+
<li>Add a pack to a csolution/cproject/clayer.</li>
492+
</ul>
493+
<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>
467495

468496
</div>
469497
</div><footer>

site/debug.html

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
<a href="index.html" class="icon icon-home"> Arm Keil Studio for VS Code
3535
</a>
3636
<div class="version">
37-
1.64.0
37+
1.66.0
3838
</div><div role="search">
3939
<form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
4040
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
@@ -122,6 +122,8 @@
122122
</li>
123123
<li class="toctree-l2"><a class="reference internal" href="#configure-run-and-debug">Configure run and debug</a>
124124
<ul>
125+
<li class="toctree-l3"><a class="reference internal" href="#custom-launchjson-and-tasksjson-settings">Custom launch.json and tasks.json settings</a>
126+
</li>
125127
<li class="toctree-l3"><a class="reference internal" href="#pyocd">pyOCD</a>
126128
</li>
127129
<li class="toctree-l3"><a class="reference internal" href="#j-link-server">J-Link Server</a>
@@ -170,7 +172,7 @@
170172
</li>
171173
</ul>
172174
<ul>
173-
<li class="toctree-l1"><a class="reference internal" href="read_further.html">Read further</a>
175+
<li class="toctree-l1"><a class="reference internal" href="reldocs.html">Related documentation</a>
174176
</li>
175177
</ul>
176178
<ul>
@@ -645,6 +647,32 @@ <h2 id="configure-run-and-debug">Configure run and debug</h2>
645647
various debug adapters from the <a href="https://github.com/Open-CMSIS-Pack/debug-adapter-registry">Debug Adapter Registry</a> and
646648
taking the user inputs into account, the <strong>CMSIS Solution</strong> extension then generates the <code>launch.json</code> and <code>tasks.json</code>
647649
files.</p>
650+
<h3 id="custom-launchjson-and-tasksjson-settings">Custom <code>launch.json</code> and <code>tasks.json</code> settings</h3>
651+
<p>User defined launch configurations and tasks can be added directly into the workspace files. When updating these
652+
files custom or modified entries are kept untouched if detected:</p>
653+
<ul>
654+
<li><code>.vscode/launch.json</code>
655+
Each auto-generated configuration has an additional property <code>cmsis.updateConfiguration="auto"</code>. By either removing
656+
this property, or by setting it to <code>manual</code> will exclude it from further automatic updates.</li>
657+
<li><code>.vscode/tasks.json</code>
658+
All auto-generated tasks have labels starting with <code>CMSIS</code>. Such tasks are removed on updates. Custom tasks
659+
must assure they use names not starting with <code>CMSIS</code>.</li>
660+
</ul>
661+
<p>Instead of adding custom content into these automatically updated files causing version system modifications all the
662+
time, one can extract those into configuration subfolders and only keep these under version control:</p>
663+
<ul>
664+
<li><code>.vscode/launch.json.d/*.json</code>
665+
Each JSON file must respect the <code>launch.json</code> schema. All contained <code>configurations</code> are merged into the workspace
666+
<code>.vscode/launch.json</code> file by <code>name</code> property. Auto-generated configurations can be overwritten if required without
667+
attention to the <code>cmsis.updateConfiguration</code> property.</li>
668+
<li><code>.vscode/tasks.json.d/*.json</code>
669+
Each JSON file must respect the <code>tasks.json</code> schema. All contained <code>tasks</code> are merged into the workspace
670+
<code>.vscode/tasks.json</code> file by <code>label</code> property. Auto-generated <code>CMSIS</code> tasks can be overwritten if required.</li>
671+
</ul>
672+
<p>For multi-solution workspaces, i.e., having multiple <code>.csolution.yml</code> files in subfolders, solution-specific
673+
files in solution's <code>.vscode/launch.json.d/</code> and <code>.vscode/tasks.json.d/</code> directories are included for the
674+
active solution applying the same rules as above. This can be used to include solution specific content into the
675+
workspace configuration based on the currently used solution.</p>
648676
<h3 id="pyocd">pyOCD</h3>
649677
<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>
650678
<p>For the <strong>Debug Interface</strong>, you can:</p>

0 commit comments

Comments
 (0)