From a4193b43a1da3f495860c2bf762dbe5a79ef75c6 Mon Sep 17 00:00:00 2001 From: github-actions Date: Fri, 11 Oct 2024 05:04:21 +0000 Subject: [PATCH] Update documentation for branch main --- main/FileSystem/footer.js | 2 +- main/General/footer.js | 4 ++-- main/General/index.html | 9 +++++---- main/General/navtreedata.js | 2 +- main/General/pages.html | 2 +- main/General/rev_hist.html | 8 +++++++- main/General/search/all_3.js | 2 +- main/General/search/pages_3.js | 2 +- main/General/working_with_examples.html | 4 ++-- main/Network/footer.js | 2 +- main/USB/footer.js | 2 +- version.js | 2 +- 12 files changed, 24 insertions(+), 17 deletions(-) diff --git a/main/FileSystem/footer.js b/main/FileSystem/footer.js index 04901b5a..3c28ed1c 100644 --- 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 © 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 © 2024 Arm Limited (or its affiliates). All rights reserved.'); }; diff --git a/main/General/footer.js b/main/General/footer.js index 6c78ec06..8c7a3077 100644 --- 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 © 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 © 2024 Arm Limited (or its affiliates). All rights reserved.'); }; diff --git a/main/General/index.html b/main/General/index.html index 30b477b4..e174a397 100644 --- a/main/General/index.html +++ b/main/General/index.html @@ -128,7 +128,7 @@
Overview
-

The free-to-use MDK-Middleware 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 .

+

The MDK-Middleware 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 .

@@ -161,10 +161,11 @@

MDK-Middleware components are available as source code and will work with all major toolchains including Arm Compiler 6, GCC and IAR.

Documentation Structure

-

This user's guide contains the following chapters:

+

This chapter contains the following sections:

    -
  • Generic Steps explains the necessary steps to create from scratch a project containing a Middleware component.
    • -
  • Stack, Heap and RTOS Configuration describes how to configure a project to meet the resource requirements of the Middleware.
    • +
  • Revision History contains an overview of the revisions.
    • +
  • Using Middleware explains the steps to create from scratch a project containing a Middleware component and how configure resources.
    • +
  • Working with Examples explains how to run the device-agnostic middleware reference applications on boards.

Every middleware component has a section on the following topics to explain how to create an application:

    diff --git a/main/General/navtreedata.js b/main/General/navtreedata.js index c07dbd36..552820f1 100644 --- 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 index 9d22a954..ba0663ab 100644 --- a/main/General/pages.html +++ b/main/General/pages.html @@ -132,7 +132,7 @@ - +
     Revision History
     ►Using Middleware
     ►Working with MDK-Middleware Examples
     ►Working with Examples
diff --git a/main/General/rev_hist.html b/main/General/rev_hist.html index f357b4c3..3b3152c2 100644 --- a/main/General/rev_hist.html +++ b/main/General/rev_hist.html @@ -128,7 +128,13 @@
Revision History
-

+

+

‍Note:

+
    +
  • Refer to Version History of the Software Pack for a detailed list of the changes.
    • +
+
+
diff --git a/main/General/search/all_3.js b/main/General/search/all_3.js index c1f517e4..4426a393 100644 --- 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 index c1f517e4..4426a393 100644 --- 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 index 77968b05..8d916aac 100644 --- a/main/General/working_with_examples.html +++ b/main/General/working_with_examples.html @@ -5,7 +5,7 @@ -MDK-Middleware: Working with MDK-Middleware Examples +MDK-Middleware: Working with Examples @@ -125,7 +125,7 @@
-
Working with MDK-Middleware Examples
+
Working with Examples

The MDK-Middleware examples are implemented as CMSIS-Toolbox Reference Applications that use CMSIS-Driver interfaces. These Reference Applications are hardware agnostic and need to be extended with a compatible board layer to run on a specific hardware target.

diff --git a/main/Network/footer.js b/main/Network/footer.js index cc3faa87..1a089be2 100644 --- 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 © 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 © 2024 Arm Limited (or its affiliates). All rights reserved.'); }; diff --git a/main/USB/footer.js b/main/USB/footer.js index 777295de..fb3139e5 100644 --- 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 © 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 © 2024 Arm Limited (or its affiliates). All rights reserved.'); }; diff --git a/version.js b/version.js index f9ab576e..c1c6d52a 100644 --- 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": {
Version Description