From 89fed628142384da93481edbf1d8f3fd809cc8b3 Mon Sep 17 00:00:00 2001 From: GuentherMartin Date: Tue, 6 Jun 2023 16:13:27 +0200 Subject: [PATCH] align doxygen files with CMSIS_RTX --- ARM.CMSIS.pdsc | 2 +- CMSIS/DoxyGen/Core/Core.dxy.in | 4 ++-- CMSIS/DoxyGen/Core_A/Core_A.dxy.in | 2 +- CMSIS/DoxyGen/Driver/Driver.dxy.in | 2 +- CMSIS/DoxyGen/General/General.dxy.in | 2 +- CMSIS/DoxyGen/General/src/introduction.md | 4 ++-- CMSIS/DoxyGen/RTOS2/RTOS2.dxy.in | 2 +- CMSIS/DoxyGen/gen_doc.sh | 8 +++++--- LICENSE.txt => LICENSE | 0 README.md | 2 +- gen_pack.sh | 4 ++-- 11 files changed, 17 insertions(+), 15 deletions(-) rename LICENSE.txt => LICENSE (100%) diff --git a/ARM.CMSIS.pdsc b/ARM.CMSIS.pdsc index ec316dab2..8a168da33 100644 --- a/ARM.CMSIS.pdsc +++ b/ARM.CMSIS.pdsc @@ -4,7 +4,7 @@ CMSIS CMSIS (Common Microcontroller Software Interface Standard) ARM - + LICENSE https://www.keil.com/pack/ diff --git a/CMSIS/DoxyGen/Core/Core.dxy.in b/CMSIS/DoxyGen/Core/Core.dxy.in index cc750e1b1..e330fba08 100644 --- a/CMSIS/DoxyGen/Core/Core.dxy.in +++ b/CMSIS/DoxyGen/Core/Core.dxy.in @@ -1076,7 +1076,7 @@ EXCLUDE_SYMBOLS = # that contain example code fragments that are included (see the \include # command). -EXAMPLE_PATH = +EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and @@ -1414,7 +1414,7 @@ HTML_EXTRA_FILES = ../Doxygen_Templates/tabs.css \ ../Doxygen_Templates/printComponentTabs.js \ ../Doxygen_Templates/darkmode_toggle.js \ ../Doxygen_Templates/navtree.js \ - ../Doxygen_Templates/dropdown.png \ + ../Doxygen_Templates/dropdown.png # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output # should be rendered with a dark or light theme. diff --git a/CMSIS/DoxyGen/Core_A/Core_A.dxy.in b/CMSIS/DoxyGen/Core_A/Core_A.dxy.in index 77920afe4..438e56146 100644 --- a/CMSIS/DoxyGen/Core_A/Core_A.dxy.in +++ b/CMSIS/DoxyGen/Core_A/Core_A.dxy.in @@ -1406,7 +1406,7 @@ HTML_EXTRA_FILES = ../Doxygen_Templates/tabs.css \ ../Doxygen_Templates/printComponentTabs.js \ ../Doxygen_Templates/darkmode_toggle.js \ ../Doxygen_Templates/navtree.js \ - ../Doxygen_Templates/dropdown.png \ + ../Doxygen_Templates/dropdown.png # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output # should be rendered with a dark or light theme. diff --git a/CMSIS/DoxyGen/Driver/Driver.dxy.in b/CMSIS/DoxyGen/Driver/Driver.dxy.in index 8d2fbe9ae..7a10d8550 100644 --- a/CMSIS/DoxyGen/Driver/Driver.dxy.in +++ b/CMSIS/DoxyGen/Driver/Driver.dxy.in @@ -1427,7 +1427,7 @@ HTML_EXTRA_FILES = ../Doxygen_Templates/tabs.css \ ../Doxygen_Templates/printComponentTabs.js \ ../Doxygen_Templates/darkmode_toggle.js \ ../Doxygen_Templates/navtree.js \ - ../Doxygen_Templates/dropdown.png \ + ../Doxygen_Templates/dropdown.png # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output # should be rendered with a dark or light theme. diff --git a/CMSIS/DoxyGen/General/General.dxy.in b/CMSIS/DoxyGen/General/General.dxy.in index ee02e272d..0b78f5c8b 100644 --- a/CMSIS/DoxyGen/General/General.dxy.in +++ b/CMSIS/DoxyGen/General/General.dxy.in @@ -1388,7 +1388,7 @@ HTML_EXTRA_FILES = ../Doxygen_Templates/tabs.css \ ../Doxygen_Templates/printComponentTabs.js \ ../Doxygen_Templates/darkmode_toggle.js \ ../Doxygen_Templates/navtree.js \ - ../Doxygen_Templates/dropdown.png \ + ../Doxygen_Templates/dropdown.png # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output # should be rendered with a dark or light theme. diff --git a/CMSIS/DoxyGen/General/src/introduction.md b/CMSIS/DoxyGen/General/src/introduction.md index 6a05431c4..e0593b874 100644 --- a/CMSIS/DoxyGen/General/src/introduction.md +++ b/CMSIS/DoxyGen/General/src/introduction.md @@ -132,7 +132,7 @@ with C language standards, specifically warnings that may be generated by the va License {#License} ======= -CMSIS is provided free of charge by Arm under the Apache 2.0 License. +CMSIS is provided free of charge by Arm under the Apache 2.0 License. CMSIS Software Pack {#CMSIS_Pack} =================== @@ -143,7 +143,7 @@ the following: File/Directory |Content :------------------|:------------------- **ARM.CMSIS.pdsc** |Package description file in CMSIS-Pack format. -**LICENSE.txt** |CMSIS License Agreement (Apache 2.0) +**LICENSE** |CMSIS License Agreement (Apache 2.0) **CMSIS** |\ref cmsis_components "CMSIS components" (see also table below) **Device** |CMSIS reference implementations of Arm Cortex processor based devices diff --git a/CMSIS/DoxyGen/RTOS2/RTOS2.dxy.in b/CMSIS/DoxyGen/RTOS2/RTOS2.dxy.in index ac330684c..fd804813f 100644 --- a/CMSIS/DoxyGen/RTOS2/RTOS2.dxy.in +++ b/CMSIS/DoxyGen/RTOS2/RTOS2.dxy.in @@ -1418,7 +1418,7 @@ HTML_EXTRA_FILES = ../Doxygen_Templates/tabs.css \ ../Doxygen_Templates/printComponentTabs.js \ ../Doxygen_Templates/darkmode_toggle.js \ ../Doxygen_Templates/navtree.js \ - ../Doxygen_Templates/dropdown.png \ + ../Doxygen_Templates/dropdown.png # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output # should be rendered with a dark or light theme. diff --git a/CMSIS/DoxyGen/gen_doc.sh b/CMSIS/DoxyGen/gen_doc.sh index 96add180b..244334b3f 100755 --- a/CMSIS/DoxyGen/gen_doc.sh +++ b/CMSIS/DoxyGen/gen_doc.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash -# Version: 2.2 -# Date: 2023-05-23 -# This bash script generates CMSIS-View documentation +# Version: 2.3 +# Date: 2023-06-06 +# This bash script generates CMSIS-Core documentation # # Pre-requisites: # - bash shell (for Windows: install git for Windows) @@ -11,6 +11,8 @@ set -o pipefail # Set version of gen pack library +# For available versions see https://github.com/Open-CMSIS-Pack/gen-pack/tags. +# Use the tag name without the prefix "v", e.g., 0.7.0 REQUIRED_GEN_PACK_LIB="0.8.3" DIRNAME=$(dirname $(readlink -f $0)) diff --git a/LICENSE.txt b/LICENSE similarity index 100% rename from LICENSE.txt rename to LICENSE diff --git a/README.md b/README.md index 223afc9ba..286d1ec98 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # CMSIS Version 6 - Preview (Work in Progres) -[![Version](https://img.shields.io/github/v/release/arm-software/CMSIS_6)](https://github.com/ARM-software/CMSIS_6/releases/latest) [![License](https://img.shields.io/github/license/arm-software/CMSIS_6)](https://arm-software.github.io/CMSIS_6/General/html/LICENSE.txt) +[![Version](https://img.shields.io/github/v/release/arm-software/CMSIS_6)](https://github.com/ARM-software/CMSIS_6/releases/latest) [![License](https://img.shields.io/github/license/arm-software/CMSIS_6)](https://arm-software.github.io/CMSIS_6/General/html/LICENSE) The branch *main* of this GitHub repository contains ![Version](https://img.shields.io/github/v/release/arm-software/CMSIS_6?display_name=release&label=%20&sort=semver). diff --git a/gen_pack.sh b/gen_pack.sh index 3882faec0..6e491be74 100755 --- a/gen_pack.sh +++ b/gen_pack.sh @@ -1,6 +1,6 @@ #!/usr/bin/env bash # Version: 2.7 -# Date: 2023-05-23 +# Date: 2023-06-06 # This bash script generates a CMSIS Software Pack: # @@ -40,7 +40,7 @@ PACK_DIRS=" # Default: empty # PACK_BASE_FILES=" - LICENSE.txt + LICENSE " # Specify file names to be deleted from pack build directory