Doc: Fixes in links

ARM-software · Oct 11, 2023 · 73eb4b0 · 73eb4b0
1 parent a1a4c96
commit 73eb4b0
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 9 deletions.
diff --git a/Documentation/Doxygen/check_links.sh b/Documentation/Doxygen/check_links.sh
@@ -2,14 +2,15 @@
 
 set -o pipefail
 
-DIRNAME=$(dirname $(realpath $0))
-REQUIRED_GEN_PACK_LIB="0.8.4"
+DIRNAME=$(dirname "$(realpath "$0")")
+REQUIRED_GEN_PACK_LIB="0.8.7"
 
 ############ gen-pack library ###########
 
 function install_lib() {
   local URL="https://github.com/Open-CMSIS-Pack/gen-pack/archive/refs/tags/v$1.tar.gz"
-  local STATUS=$(curl -sLI "${URL}" | grep "^HTTP" | tail -n 1 | cut -d' ' -f2 || echo "$((600+$?))")
+  local STATUS
+  STATUS=$(curl -sLI "${URL}" | grep "^HTTP" | tail -n 1 | cut -d' ' -f2 || echo "$((600+$?))")
   if [[ $STATUS -ge 400 ]]; then
     echo "Wrong/unavailable gen-pack lib version '$1'!" >&2
     echo "Check REQUIRED_GEN_PACK_LIB variable."  >&2

diff --git a/Documentation/Doxygen/gen_doc.sh b/Documentation/Doxygen/gen_doc.sh
@@ -84,7 +84,6 @@ echo "\"${UTILITY_DOXYGEN}\" zone.dxy"
 "${UTILITY_DOXYGEN}" zone.dxy
 
 mkdir -p "${DIRNAME}/../html/search/"
-cp -f "${DIRNAME}/Doxygen_Templates/search.css" "${DIRNAME}/../html/search/"
 cp -f "${DIRNAME}/Doxygen_Templates/navtree.js" "${DIRNAME}/../html/"
 
 sed -e "s/{datetime}/${datetime}/" "${DIRNAME}/Doxygen_Templates/footer.js.in" \

diff --git a/Documentation/Doxygen/linkchecker.rc b/Documentation/Doxygen/linkchecker.rc
@@ -0,0 +1,9 @@
+[output]
+ignoreerrors=
+    mag.svg
+    mag_sel.svg
+    mag_d.svg
+    mag_seld.svg
+    ../tab_a.png
+    ../tab_ad.png
+
diff --git a/Documentation/Doxygen/src/examples.txt b/Documentation/Doxygen/src/examples.txt
@@ -191,7 +191,7 @@ the different memory regions.
 
 \note
 If you want to learn more about the general project layout for an Armv8-M project using TrustZone, refer to
-<a href="https://www.keil.com/appnotes/docs/apnt_291.asp" target="_blank">Application Note 291</a>.
+<a href="https://developer.arm.com/documentation/kan291/latest/" target="_blank">Application Note 291</a>.
 
 \subsection zTEM2351_hwsScatter scatter_s.sct
 
@@ -328,7 +328,7 @@ using a preinclude to mem_layout.h to get the information about the different me
 
 \note
 If you want to learn more about the general project layout for an Armv8-M project using TrustZone, refer to
-<a href="https://www.keil.com/appnotes/docs/apnt_291.asp" target="_blank">Application Note 291</a>.
+<a href="https://developer.arm.com/documentation/kan291/latest/" target="_blank">Keil Application Note 291</a>.
 
 \subsection zTELPC55_hwsScatter hello_world_s.sct
 
@@ -464,7 +464,7 @@ The projects use the files generated in CMSIS-Zone as follows:
 | blinky_s.sct               | blinky_s    | Scatter file for secure zone (initally based on generated file). |
 \note
 If you want to learn more about the general project layout for an Armv8-M project using TrustZone, refer to
-<a href="https://www.keil.com/appnotes/docs/apnt_291.asp" target="_blank">Application Note 291</a>.
+<a href="https://developer.arm.com/documentation/kan291/latest/" target="_blank">Keil Application Note 291</a>.
 
 \subsection zTESTM32L5_hwsScatter blinky_s.sct
 

diff --git a/Documentation/Doxygen/src/mainpage.md b/Documentation/Doxygen/src/mainpage.md
@@ -2,7 +2,7 @@
 
 ## Overview {#Overview}
 
-Embedded systems frequently integrate specify hardware for access protection or system isolation. For example, a Cortex-M33 processor based system may incorporate:
+Embedded systems frequently integrate specific hardware for access protection or system isolation. For example, a Cortex-M33 processor based system may incorporate:
  - SAU (Secure Attribute Unit) to create a secure execution partition with controlled access from a non-secure execution partition.
  - MPC (Memory Protection Controller) to control the system-wide access permissions to memory.
  - PPC (Peripheral Protection Controller) to control the system-wide access permissions to peripherals.
@@ -43,6 +43,12 @@ The following SoC diagram exemplifies step 1 and step 2 of this workflow.
 
 ![Hardware partitioning in multiple steps](./images/Partitioning_Hardware.png)
 
+## Acess to CMSIS-Zone {#Access}
+
+CMSIS-Zone examples, templates and documentation are maintained in [**CMSIS-Zone GitHub repository**](https://github.com/ARM-software/CMSIS-Zone) and \ref zoneToolUsage is maintained and released as part of the [CMSIS-Pack Eclipse Plug-ins](https://github.com/ARM-software/cmsis-pack-eclipse/releases/latest).
+
+For an overview of other CMSIS software components, tools and specifications see [CMSIS Documentation](https://arm-software.github.io/CMSIS_6/).
+
 ## Documentation Structure {#ManualSections}
 
 The following sections explain:

diff --git a/Documentation/Doxygen/src/utility.md b/Documentation/Doxygen/src/utility.md
@@ -22,7 +22,7 @@ It is assumed that you are familiar with Eclipse and [Open-CMSIS-Packs](https://
 
 ## Installation {#zTInstall}
 
-The CMSIS-Zone utility is part of the <a href="https://github.com/ARM-software/cmsis-pack-eclipse/releases/latest" target="_blank"><b>CMSIS-Pack Eclipse Plug-ins</b></a>.
+The CMSIS-Zone utility is part of the [CMSIS-Pack Eclipse Plug-ins](https://github.com/ARM-software/cmsis-pack-eclipse/releases/latest).
 
 Follow the instructions on the release page to install the tool.