Update documentation for branch main

ARM-software · Oct 9, 2024 · 3e1dd82 · 3e1dd82
1 parent 2cdb063
commit 3e1dd82
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 9 deletions.
diff --git a/main/FileSystem/create_app.html b/main/FileSystem/create_app.html
@@ -276,7 +276,7 @@ <h1><a class="anchor" id="system_configuration"></a>
 System Resource Configuration</h1>
 <p>For proper operation, the File System Component requires some system configuration settings. The requirements are:</p>
 <ul>
-<li>Minimum <b>heap size of 512 + 96 Bytes for each opened file</b>. If you want to be able to have three files open at the same time, you need to set a heap size of at least 3 * (512+96) Bytes = 1824 Bytes. This can be configured in the device's <code>startup_device.s</code> file (<code>Heap_Size</code>).</li>
+<li>Minimum <b>heap size of 512 + 96 Bytes for each opened file</b>. If you want to be able to have three files open at the same time, you need to set a heap size of at least 3 * (512+96) Bytes = 1824 Bytes. This can be configured in the device's <code>startup_device.s</code> file (<code>Heap_Size</code>) or <code>linker script</code>.</li>
 <li>As the File System Component is not creating any additional threads, you need to add thread stack size to the calling thread. This calling thread can be the main thread, a thread with a default stack size or a thread with a user provided stack size. Changing the size for these threads can be done in the  <script>link_ext('RTX-Conf-CM5');</script> file.</li>
 <li>Each opened file is protected with a mutex in order to ensure thread-safe operation. When working with file functions from the standard C library, you need to ensure enough mutex objects available for the file stream operations in the standard library system. File System component's <a class="el" href="resource_requirements.html">Resource Requirements</a> section explains how to determine the right setting in detail. Adjusting the number of mutex objects available for standard library system can be done in the  <script>link_ext('RTX-Conf-CM5');</script> file.</li>
 </ul>

diff --git a/main/FileSystem/footer.js b/main/FileSystem/footer.js
@@ -3,5 +3,5 @@ function writeHeader() {
 };
 
 function writeFooter()  {
-    document.write('Generated on Wed Oct  9 2024 20:43:03 for File System Component 8.0.0. Copyright &copy; 2024 Arm Limited (or its affiliates). All rights reserved.');
+    document.write('Generated on Wed Oct  9 2024 21:22:24 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-dev231');
+    document.write('Version 8.0.0-dev232');
 };
 
 function writeFooter()  {
-    document.write('Generated on Wed Oct  9 2024 20:43:03 for MDK-Middleware 8.0.0-dev231+g5cb5b34. Copyright &copy; 2024 Arm Limited (or its affiliates). All rights reserved.');
+    document.write('Generated on Wed Oct  9 2024 21:22:24 for MDK-Middleware 8.0.0-dev232+gc17ceef. Copyright &copy; 2024 Arm Limited (or its affiliates). All rights reserved.');
 };
diff --git a/main/General/mw_using.html b/main/General/mw_using.html
@@ -159,7 +159,7 @@ <h2><a class="anchor" id="add_sw_comp"></a>
     <h2><a class="anchor" id="conf_mw"></a>
 Configure Middleware</h2>
 <p>Every middleware component has specific configuration files that need to be adapted to the needs of the application. Depending on the component, more than one file might need to be adapted. For example, the <b>File System</b> component needs to be configured for the amount of files that can be opened simultaneously.</p>
-<p>In addition, you need to set drive specific settings in the **FS_Config_<em>Drive</em>_0.h** file, such as page and block sizes for Flash memories, general disk sizes for a RAM drive, and the hardware driver number for connecting the drive to the appropriate hardware peripheral driver.</p>
+<p>In addition, you need to set drive specific settings in the <b>FS_Config_<em>Drive</em>_0.h</b> file, such as page and block sizes for Flash memories, general disk sizes for a RAM drive, and the hardware driver number for connecting the drive to the appropriate hardware peripheral driver.</p>
 <div class="image">
 <img src="file_system_conf.png" alt=""/>
 <div class="caption">
@@ -173,7 +173,7 @@ <h2><a class="anchor" id="conf_drivers"></a>
 RTE_Device.h File for Driver Configuration</div></div>
     <h2><a class="anchor" id="conf_sys_req"></a>
 Configure System Resources</h2>
-<p>Every software component has resource requirements for stack, heap, and memory. Configuration files such as **startup_<em>device</em>.s** and  <script>link_ext('RTX-Conf-CM5');</script> file need to be adapted to these requirements. Every middleware component has a section that explains the resource requirements and gives examples on how to calculate the resulting values for adaption of the configuration files. The section <a class="el" href="mw_using.html#mw_using_stack_and_heap">Stack, Heap and RTOS Configuration</a> gives you more information about the background and the configuration files that need to be touched.</p>
+<p>Every software component has resource requirements for stack, heap, and memory. Configuration files such as <b>startup_<em>device</em>.s</b> and  <script>link_ext('RTX-Conf-CM5');</script> file need to be adapted to these requirements. Every middleware component has a section that explains the resource requirements and gives examples on how to calculate the resulting values for adaption of the configuration files. The section <a class="el" href="mw_using.html#mw_using_stack_and_heap">Stack, Heap and RTOS Configuration</a> gives you more information about the background and the configuration files that need to be touched.</p>
 <div class="image">
 <img src="rtx_startup.png" alt=""/>
 <div class="caption">

diff --git a/main/Network/footer.js b/main/Network/footer.js
@@ -3,5 +3,5 @@ function writeHeader() {
 };
 
 function writeFooter()  {
-    document.write('Generated on Wed Oct  9 2024 20:43:04 for Network Component 8.0.0. Copyright &copy; 2024 Arm Limited (or its affiliates). All rights reserved.');
+    document.write('Generated on Wed Oct  9 2024 21:22:25 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 Wed Oct  9 2024 20:43:05 for USB Component 8.0.0. Copyright &copy; 2024 Arm Limited (or its affiliates). All rights reserved.');
+    document.write('Generated on Wed Oct  9 2024 21:22:26 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-dev231",
+        "latest": "8.0.0-dev232",
         "doc_usb": "8.0.0-dev211"
     },
     "FileSystem": {