Skip to content

Commit

Permalink
Update main documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Oct 17, 2024
1 parent fb369e7 commit c9c043e
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion main/examples/html/footer.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
function writeFooter() {
document.write('Generated on Thu Oct 17 2024 09:01:30 for Examples Version 2.1.0 by Arm Ltd. All rights reserved.');
document.write('Generated on Thu Oct 17 2024 09:48:34 for Examples Version 2.1.0 by Arm Ltd. All rights reserved.');
};
4 changes: 2 additions & 2 deletions main/infrastructure/html/avh_desktop.html
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@
</div><!--header-->
<div class="contents">
<div class="textblock"><p><a class="anchor" id="md_src_avh_desktop"></a> You can use Arm Virtual Hardware FVP models with embedded projects locally on your machine.</p>
<p><b>Use in command line interface:</b></p><ul>
<li>Section <a class="el" href="avh_fvp_artifactory.html">AVH FVPs in Arm Tools Artifactory</a> explains how to download the AVH FVPs to your local machine. While section <a href="../../simulation/html/using.html">Simulation - Using AVH FVPs</a> gives an overview on how to use AVH FVPs in a command-line interface (CLI).</li>
<p><b>Use in command line interface (CLI):</b></p><ul>
<li>Section <a class="el" href="avh_fvp_artifactory.html">AVH FVPs in Arm Tools Artifactory</a> explains how to download the AVH FVPs to your local machine. For an overview about program execution using CLI see section <a href="../../simulation/html/using.html">Simulation - Using AVH FVPs</a>.</li>
</ul>
<p><b>Use in IDEs:</b></p><ul>
<li><a class="el" href="run_mdk_vscode.html">Use with Keil Studio</a> explains how to use AVH FVPs in Keil MDK for VS Code running on a Linux/Windows/MacOs machine.</li>
Expand Down
10 changes: 5 additions & 5 deletions main/infrastructure/html/avh_gh_actions.html
Original file line number Diff line number Diff line change
Expand Up @@ -150,18 +150,18 @@ <h1><a class="anchor" id="arm_cmsis_actions"></a>
<h1><a class="anchor" id="avh_gh_run"></a>
Program Execution</h1>
<p>After AVH FVPs and other tools are installed and activated on the GitHub Runner (see <a class="el" href="avh_gh_actions.html#arm_cmsis_actions">Setup with CMSIS-Actions</a>) you can use the command line interface for building your project (e.g with <code>cbuild</code> utility) and run the firmware on an AVH FVP target (see <a href="../../simulation/html/using.html#Execution">Running User Applications in CLI</a>).</p>
<p>For example, the code snippet below adds to a GitHub Actions workflow a step with program execution on Cortex-M3 FVP target:</p>
<p>For example, the code snippet below adds to a GitHub Actions workflow a step with program execution on Corstone-320 FVP target:</p>
<div class="fragment"><div class="line">name: Execute</div>
<div class="line"> run: |</div>
<div class="line"> echo &quot;Running get started example ...&quot;</div>
<div class="line"> FVP_MPS2_Cortex-M3 --simlimit 10 -f fvp_config.txt -a Project.axf | tee Project.avh.log</div>
<div class="line"> echo &quot;Running project example ...&quot;</div>
<div class="line"> FVP_Corstone_SSE-320 -f fvp_config.txt -a Project.axf | tee Project.avh.log</div>
</div><!-- fragment --><p>Also see <a href="../../simulation/html/hints.html#ci_frameworks">Execution in CI frameworks</a> for useful hints about running FVPs in CI workflows.</p>
<h1><a class="anchor" id="avh_gh_matrix"></a>
Running multiple configurations</h1>
<p>Software often needs to be tested in multiple configurations, with different toolchains and on different platforms. To simplify job definition for such variations you can use <a href="https://docs.github.com/en/actions/using-jobs/using-a-matrix-for-your-jobs">matrix strategy in GitHub Action</a>.</p>
<p>For example the code snapshot below defines a two-dimensional matrix for Corsone-315/310/300 targets with Arm Compiler 6, GCC and Clang:</p>
<p>For example the code snapshot below defines a two-dimensional matrix for Corstone-320/315/310/300 targets with Arm Compiler 6, GCC and Clang:</p>
<div class="fragment"><div class="line">matrix:</div>
<div class="line"> target: [CS315, CS310, CS300]</div>
<div class="line"> target: [CS320, CS315, CS310, CS300]</div>
<div class="line"> compiler: [AC6, GCC, Clang]</div>
</div><!-- fragment --><p>And then in your job descriptions you can use <code>${{ matrix.target }}</code> and <code>${{ matrix.compiler }}</code> variables, that GitHub Actions will automatically iterate over for you.</p>
<p>See <a href="https://github.com/Arm-Examples/AVH-Hello">AVH-Hello</a> as a simple example where such matrix strategy is implemented for building the program with different toolchains and for different AVH FVP targets.</p>
Expand Down
2 changes: 1 addition & 1 deletion main/infrastructure/html/footer.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
function writeFooter() {
document.write('Generated on Thu Oct 17 2024 09:01:30 for Infrastructure Version 2.1.0 by Arm Ltd. All rights reserved.');
document.write('Generated on Thu Oct 17 2024 09:48:34 for Infrastructure Version 2.1.0 by Arm Ltd. All rights reserved.');
};
2 changes: 1 addition & 1 deletion main/overview/html/footer.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
function writeFooter() {
document.write('Generated on Thu Oct 17 2024 09:01:30 for Overview Version 2.1.0 by Arm Ltd. All rights reserved.');
document.write('Generated on Thu Oct 17 2024 09:48:34 for Overview Version 2.1.0 by Arm Ltd. All rights reserved.');
};
2 changes: 1 addition & 1 deletion main/simulation/html/footer.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
function writeFooter() {
document.write('Generated on Thu Oct 17 2024 09:01:36 for AVH FVP models Version 2.1.0 by Arm Ltd. All rights reserved.');
document.write('Generated on Thu Oct 17 2024 09:48:37 for AVH FVP models Version 2.1.0 by Arm Ltd. All rights reserved.');
};

0 comments on commit c9c043e

Please sign in to comment.