Skip to content

Commit

Permalink
Fixed broken links and improved descriptiona
Browse files Browse the repository at this point in the history
  • Loading branch information
vovamarch committed Aug 13, 2024
1 parent 2c23fa5 commit bb9da50
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
4 changes: 3 additions & 1 deletion DoxyGen/infrastructure/src/avh_gh_actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ name: Execute
FVP_MPS2_Cortex-M3 --simlimit 10 -f fvp_config.txt -a Project.axf | tee Project.avh.log
```

Also see [Execution in CI frameworks](../../simulation/html/hints.html#ci_frameworks) for useful hints about running FVPs in CI workflows.

## Running multiple configurations {#avh_gh_matrix}

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 [matrix strategy in GitHub Action](https://docs.github.com/en/actions/using-jobs/using-a-matrix-for-your-jobs).
Expand All @@ -66,4 +68,4 @@ Note that use of [csolution project format](https://github.com/Open-CMSIS-Pack/c

## Examples {#avh_ci_template}

See chapter [Examples](../../examples/index.html) for reference implementations that use \ref arm_cmsis_actions "CMSIS-Actions" for environment setup and subsequently perform project build and program execution on AVH FVP targets. Refer to the project's `./github/workflows/` directory for the implemented GitHub Actions workflows.
See chapter [Examples](../../examples/html/index.html) for reference implementations that use \ref arm_cmsis_actions "CMSIS-Actions" for environment setup and subsequently perform project build and program execution on AVH FVP targets. Refer to the project's `./github/workflows/` directory for the implemented GitHub Actions workflows.
6 changes: 3 additions & 3 deletions DoxyGen/simulation/src/hints_and_tips.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Useful Hints and Tips {#Hints}
# Useful Hints and Tips {#hints}

Below are some useful tips for using FVP models in common AVH scenarios:

Expand Down Expand Up @@ -64,12 +64,12 @@ Semihosting is also required for the following use cases:

Chapter [Infrastructure](./../../infrastructure/html/index.html) explains how AVH FVPs and other related tools can be programatiically installed into various Continuous Integraion (CI) frameworks, such as GitHub. To execute your programs on AVH FVPs in such workflows following is important:

- Disable GUI visualisation, as it often is not supported by a host and not needed in CI testing. Fot this following is required:
- Disable GUI visualisation, as it often is not supported by a host and not needed in CI testing:
- Set FVP configuration parameter `<board>.visualisation.disable-visualisation=1` for the board instance on the target FVP. For example for Corstone-315 FVP it should be `mps4_board.visualisation.disable-visualisation=1`.
- For targets with HDLCD such as Corstone-315 FVP, additionally disable the visualisation for HDLCD as `vis_hdlcd.disable_visualisation=1`.
- Redirect the console outputs to a log file as explained in \ref console.
- Ensure the program execution is exited when required by the test. \ref stop explains options for such exit.
- For faster execution and simpler implementation you can run. See for example [Running multiple configurations with GitHub Actions](./../../infrastructure/html/avh_gh_actions.html#avh_gh_matrix).
- For simpler implementation a matrix-style job configuration configuration can be used. See for example [Running multiple configurations with GitHub Actions](./../../infrastructure/html/avh_gh_actions.html#avh_gh_matrix).


## Execution timing {#timing}
Expand Down

0 comments on commit bb9da50

Please sign in to comment.