Update documentation for branch main

ARM-software · Oct 11, 2024 · a4193b4 · a4193b4
1 parent 39c4fc5
commit a4193b4
Show file tree

Hide file tree

Showing 12 changed files with 24 additions and 17 deletions.
diff --git a/main/FileSystem/footer.js b/main/FileSystem/footer.js
@@ -3,5 +3,5 @@ function writeHeader() {
 };
 
 function writeFooter()  {
-    document.write('Generated on Thu Oct 10 2024 11:59:47 for File System Component 8.0.0. Copyright &copy; 2024 Arm Limited (or its affiliates). All rights reserved.');
+    document.write('Generated on Fri Oct 11 2024 05:03:17 for File System Component 8.0.0. Copyright &copy; 2024 Arm Limited (or its affiliates). All rights reserved.');
 };
diff --git a/main/General/footer.js b/main/General/footer.js
@@ -1,7 +1,7 @@
 function writeHeader() {
-    document.write('Version 8.0.0-dev233');
+    document.write('Version 8.0.0-dev234');
 };
 
 function writeFooter()  {
-    document.write('Generated on Thu Oct 10 2024 11:59:47 for MDK-Middleware 8.0.0-dev233+g65b82f6. Copyright &copy; 2024 Arm Limited (or its affiliates). All rights reserved.');
+    document.write('Generated on Fri Oct 11 2024 05:03:17 for MDK-Middleware 8.0.0-dev234+gfb30da5. Copyright &copy; 2024 Arm Limited (or its affiliates). All rights reserved.');
 };
diff --git a/main/General/index.html b/main/General/index.html
@@ -128,7 +128,7 @@
   <div class="headertitle"><div class="title">Overview </div></div>
 </div><!--header-->
 <div class="contents">
-<div class="textblock"><p><a class="anchor" id="mainpage"></a> The free-to-use <b>MDK-Middleware</b> contains software components for IPv4 and IPv6 networking, USB Host and Device communication, and file system for data storage. The components can for example be used by the user's application, IoT connectors for cloud connectivity, or the  <script>link_ext('SDS');</script>.</p>
+<div class="textblock"><p><a class="anchor" id="mainpage"></a> The <b>MDK-Middleware</b> contains software components for IPv4 and IPv6 networking, USB Host and Device communication, and file system for data storage. The components can for example be used by the user's application, IoT connectors for cloud connectivity, or the  <script>link_ext('SDS');</script>.</p>
 <div class="image">
 <object type="image/svg+xml" data="MDK-Middleware.svg" style="pointer-events: none;"></object>
 <div class="caption">
@@ -161,10 +161,11 @@ <h1><a class="anchor" id="gen_supported_toolchains"></a>
 <p>MDK-Middleware components are available as source code and will work with all major toolchains including Arm Compiler 6, GCC and IAR.</p>
 <h1><a class="anchor" id="mw_using_mw"></a>
 Documentation Structure</h1>
-<p>This user's guide contains the following chapters:</p>
+<p>This chapter contains the following sections:</p>
 <ul>
-<li><a class="el" href="mw_using.html#mw_using_generic_steps">Generic Steps</a> explains the necessary steps to create from scratch a project containing a Middleware component.</li>
-<li><a class="el" href="mw_using.html#mw_using_stack_and_heap">Stack, Heap and RTOS Configuration</a> describes how to configure a project to meet the resource requirements of the Middleware.</li>
+<li><a class="el" href="rev_hist.html#md_src_revision_history">Revision History</a> contains an overview of the revisions.</li>
+<li><a class="el" href="mw_using.html#md_src_using_mw">Using Middleware</a> explains the steps to create from scratch a project containing a Middleware component and how configure resources.</li>
+<li><a class="el" href="working_with_examples.html#md_src_work_with_examples">Working with Examples</a> explains how to run the device-agnostic middleware reference applications on boards.</li>
 </ul>
 <p>Every middleware component has a section on the following topics to explain how to create an application:</p>
 <ul>

diff --git a/main/General/navtreedata.js b/main/General/navtreedata.js
@@ -41,7 +41,7 @@ var NAVTREE =
         [ "Configuring CMSIS-RTOS2 using RTX_Config.h", "mw_using.html#mw_using_rtx_conf", null ]
       ] ]
     ] ],
-    [ "Working with MDK-Middleware Examples", "working_with_examples.html", [
+    [ "Working with Examples", "working_with_examples.html", [
       [ "Available examples", "working_with_examples.html#autotoc_md0", null ],
       [ "Using VS Code", "working_with_examples.html#autotoc_md1", [
         [ "Explore MDK-Middleware Examples", "working_with_examples.html#autotoc_md2", null ],

diff --git a/main/General/pages.html b/main/General/pages.html
@@ -132,7 +132,7 @@
 <table class="directory">
 <tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="rev_hist.html" target="_self">Revision History</a></td><td class="desc"></td></tr>
 <tr id="row_1_" class="odd"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">&#9658;</span><a class="el" href="mw_using.html" target="_self">Using Middleware</a></td><td class="desc"></td></tr>
-<tr id="row_2_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_2_" class="arrow" onclick="toggleFolder('2_')">&#9658;</span><a class="el" href="working_with_examples.html" target="_self">Working with MDK-Middleware Examples</a></td><td class="desc"></td></tr>
+<tr id="row_2_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_2_" class="arrow" onclick="toggleFolder('2_')">&#9658;</span><a class="el" href="working_with_examples.html" target="_self">Working with Examples</a></td><td class="desc"></td></tr>
 </table>
 </div><!-- directory -->
 </div><!-- contents -->

diff --git a/main/General/rev_hist.html b/main/General/rev_hist.html
@@ -128,7 +128,13 @@
   <div class="headertitle"><div class="title">Revision History </div></div>
 </div><!--header-->
 <div class="contents">
-<div class="textblock"><p><a class="anchor" id="md_src_revision_history"></a> </p><table class="cmtable" summary="Revision History">
+<div class="textblock"><p><a class="anchor" id="md_src_revision_history"></a> </p><blockquote class="doxtable">
+<p>&zwj;<b>Note:</b></p>
+<ul>
+<li>Refer to <a href="https://www.keil.arm.com/packs/mdk-middleware-keil/versions/">Version History</a> of the Software Pack for a detailed list of the changes. </li>
+</ul>
+</blockquote>
+<table class="cmtable" summary="Revision History">
 <tr>
 <th>Version </th><th>Description  </th></tr>
 <tr>

diff --git a/main/General/search/all_3.js b/main/General/search/all_3.js
@@ -1,4 +1,4 @@
 var searchData=
 [
-  ['working_20with_20mdk_2dmiddleware_20examples_0',['Working with MDK-Middleware Examples',['../working_with_examples.html',1,'']]]
+  ['working_20with_20examples_0',['Working with Examples',['../working_with_examples.html',1,'']]]
 ];
diff --git a/main/General/search/pages_3.js b/main/General/search/pages_3.js
@@ -1,4 +1,4 @@
 var searchData=
 [
-  ['working_20with_20mdk_2dmiddleware_20examples_0',['Working with MDK-Middleware Examples',['../working_with_examples.html',1,'']]]
+  ['working_20with_20examples_0',['Working with Examples',['../working_with_examples.html',1,'']]]
 ];
diff --git a/main/General/working_with_examples.html b/main/General/working_with_examples.html
@@ -5,7 +5,7 @@
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>MDK-Middleware: Working with MDK-Middleware Examples</title>
+<title>MDK-Middleware: Working with Examples</title>
 <link href="doxygen.css" rel="stylesheet" type="text/css" />
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>
@@ -125,7 +125,7 @@
 </div>
 
 <div><div class="header">
-  <div class="headertitle"><div class="title">Working with MDK-Middleware Examples </div></div>
+  <div class="headertitle"><div class="title">Working with Examples </div></div>
 </div><!--header-->
 <div class="contents">
 <div class="textblock"><p><a class="anchor" id="md_src_work_with_examples"></a> The MDK-Middleware examples are implemented as <a href="https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/ReferenceApplications.md">CMSIS-Toolbox Reference Applications</a> that use <a href="https://arm-software.github.io/CMSIS_6/latest/Driver/index.html">CMSIS-Driver</a> interfaces. These Reference Applications are hardware agnostic and need to be extended with a compatible <a href="https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/ReferenceApplications.md#board-layer">board layer</a> to run on a specific hardware target.</p>

diff --git a/main/Network/footer.js b/main/Network/footer.js
@@ -3,5 +3,5 @@ function writeHeader() {
 };
 
 function writeFooter()  {
-    document.write('Generated on Thu Oct 10 2024 11:59:47 for Network Component 8.0.0. Copyright &copy; 2024 Arm Limited (or its affiliates). All rights reserved.');
+    document.write('Generated on Fri Oct 11 2024 05:03:18 for Network Component 8.0.0. Copyright &copy; 2024 Arm Limited (or its affiliates). All rights reserved.');
 };
diff --git a/main/USB/footer.js b/main/USB/footer.js
@@ -3,5 +3,5 @@ function writeHeader() {
 };
 
 function writeFooter()  {
-    document.write('Generated on Thu Oct 10 2024 11:59:48 for USB Component 8.0.0. Copyright &copy; 2024 Arm Limited (or its affiliates). All rights reserved.');
+    document.write('Generated on Fri Oct 11 2024 05:03:19 for USB Component 8.0.0. Copyright &copy; 2024 Arm Limited (or its affiliates). All rights reserved.');
 };
diff --git a/version.js b/version.js
@@ -1,7 +1,7 @@
 //--- list of versions‚ ---
 const versions = {
     "General": {
-        "latest": "8.0.0-dev233",
+        "latest": "8.0.0-dev234",
         "doc_usb": "8.0.0-dev211"
     },
     "FileSystem": {