diff --git a/.github/workflows/markdown.yml b/.github/workflows/markdown.yml index 3261977ab..871bcf87d 100644 --- a/.github/workflows/markdown.yml +++ b/.github/workflows/markdown.yml @@ -7,9 +7,9 @@ on: - '.github/markdownlint.jsonc' - '**/*.md' jobs: - markdown-lint: + linter: name: Lint markdown files - runs-on: ubuntu-22.04 + runs-on: ubuntu-latest steps: - name: Harden Runner if: ${{ !github.event.repository.private }} @@ -36,11 +36,19 @@ jobs: run: | echo "::remove-matcher owner=markdownlint::" - - uses: gaurav-nelson/github-action-markdown-link-check@1b916f2cf6c36510a6059943104e3c42ce6c16bc # master - if: always() + check-links: + name: Check markdown links + runs-on: ubuntu-latest + steps: + - name: Checkout devtools + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + + - name: Check links + uses: gaurav-nelson/github-action-markdown-link-check@1b916f2cf6c36510a6059943104e3c42ce6c16bc # master + # Checks all Markdown files, including those in subfolders, + # as the PR may involve removing referenced Markdown files. with: use-quiet-mode: 'yes' use-verbose-mode: 'yes' - check-modified-files-only: 'yes' base-branch: ${{ github.base_ref }} config-file: '.github/markdown-link-check.jsonc' diff --git a/README.md b/README.md index eaee5f518..74243c6af 100644 --- a/README.md +++ b/README.md @@ -302,7 +302,7 @@ One can directly run the tests from command line. ### Note -- On running the tests, all [required packs](https://github.com/Open-CMSIS-Pack/devtools/blob/main/tools/buildmgr/test/scripts/download_packs.sh#L48-L51) shall get downloaded automatically by [test scripts](https://github.com/Arm-Debug/devtools-external/blob/main/tools/buildmgr/test/scripts/download_packs.sh)\ +- On running the tests, all [required packs](https://github.com/Open-CMSIS-Pack/devtools/blob/main/tools/buildmgr/test/scripts/download_packs.sh#L48-L51) shall get downloaded automatically by [test scripts](https://github.com/Open-CMSIS-Pack/devtools/blob/main/tools/buildmgr/test/scripts/download_packs.sh)\ under configured pack repository. - By default, few special tests are skipped from execution as they are dependent on specific\ environment configuration @@ -325,7 +325,7 @@ One can directly run the tests from command line. ## Code coverage -Users can generate coverage reports locally using a GNU tool [**lcov**](http://ltp.sourceforge.net/coverage/lcov.php). +Users can generate coverage reports locally using a GNU tool [**lcov**](https://wiki.documentfoundation.org/Development/Lcov). ### Prerequisite diff --git a/tools/projmgr/OutofScope.md b/tools/projmgr/OutofScope.md index 640144d9e..0412f8f06 100644 --- a/tools/projmgr/OutofScope.md +++ b/tools/projmgr/OutofScope.md @@ -46,7 +46,7 @@ In a later version of the CMSIS-Toolbox, ASM specific controls may be added. ## Linker Script -In CMSIS-Toolbox 2.0 the [Linker Script Management](Linker-Script-Management.md) will be implemented. +In CMSIS-Toolbox 2.0 the [Linker Script Management](https://open-cmsis-pack.github.io/cmsis-toolbox/build-overview/#linker-script-management) will be implemented. In a later iteration of the tools it should be possible to generate the `regions_.h` with a workflow that is similar to "CMSIS-Zone" or "DeviceTree". @@ -61,7 +61,7 @@ The **csolution - CMSIS Project Manager** integrates an extended version of the - [`phases:`](#phases) defines the execution phases may be used to assign a life-time to memory or peripheral resources in the project zones. - [`project-zones:`](#project-zones) collect and configure the memory or peripheral resources that are available to - individual projects. These zones are assigned to the [`projects:`](YML-Input-Format.md#projects) of a `*.csolution.yml` file. + individual projects. These zones are assigned to the [`projects:`](https://open-cmsis-pack.github.io/cmsis-toolbox/YML-Input-Format/#projects) of a `*.csolution.yml` file. - [`requires:`](#requires) allows to specify additional resources at the level of a `*.cproject.yml` or `*.clayer.yml` file that are added to the related zone of the project. @@ -199,10 +199,10 @@ requires: **(Proposal)** Out-of-scope (review if this is really required) -The default RTE directory structure can be modified with [`rte-dirs:`](YML-Input-Format.md#rte-dirs). +The default RTE directory structure can be modified with [`rte-dirs:`](https://open-cmsis-pack.github.io/cmsis-toolbox/YML-Input-Format/#rte-dirs). This list node allows to specify for each software component `Cclass` the directory that should be used to partly share a common configuration across a `project:` or `layer:`. -The `rte-dirs:` list allows to control the location of configuration files for each [component `Cclass`](YML-Input-Format.md#component-name-conventions). A list of `Cclass` names can be assigned to specific directories that store the related configuration files. +The `rte-dirs:` list allows to control the location of configuration files for each [component `Cclass`](https://open-cmsis-pack.github.io/cmsis-toolbox/YML-Input-Format/#component-name-conventions). A list of `Cclass` names can be assigned to specific directories that store the related configuration files. **Example:** @@ -215,7 +215,7 @@ The `rte-dirs:` list allows to control the location of configuration files for e for-context: .Debug ``` -- With [RTE directory settings](./YML-Input-Format.md#rte-dirs) that are specific to software component `Cclass` names it is possible partly share a common configuration across layers. +- With [RTE directory settings](https://open-cmsis-pack.github.io/cmsis-toolbox/YML-Input-Format/#rte-dirs) that are specific to software component `Cclass` names it is possible partly share a common configuration across layers. ## CMSIS-Zone Integration diff --git a/tools/svdconv/Test/CONTENT.md b/tools/svdconv/Test/CONTENT.md index 1dd3cc661..5d311113f 100644 --- a/tools/svdconv/Test/CONTENT.md +++ b/tools/svdconv/Test/CONTENT.md @@ -19,10 +19,10 @@ test input extensions should be placed under this directory. [integtests](./integtests) directory contains all the sources containing integration tests and compiles into an executable. The tests make use of test -input SVD files from [test](./test/data/) directory containing the +input SVD files from [test](./data/) directory containing the example SVD. ## Unit Tests -[unittests](./unittests) holds the sources accommodating all the unit tests and +[unittests](./UnitTests) holds the sources accommodating all the unit tests and compiles into an executable. These unit tests uses **gtest** as a test framework.