Merge pull request #214 from lucianomartin/feature/docs

Address review comments
xmos · Nov 3, 2023 · 5fad254 · 5fad254
2 parents 0a21867 + 25c1ad2
commit 5fad254
Show file tree

Hide file tree

Showing 15 changed files with 24 additions and 25 deletions.
diff --git a/doc/README.rst b/doc/README.rst
@@ -2,7 +2,9 @@
 Documentation Source
 ####################
 
-This folder contains source files for the documentation. The sources do not render well in GitHub or an RST viewer.
+This folder contains source files for the documentation and is intended for XMOS users. Pre-built documentation is published on https://www.xmos.com.
+
+The sources do not render well in GitHub or an RST viewer.
 In addition, some information is not visible at all and some links will not be functional.
 
 **********************

diff --git a/doc/exclude_patterns.inc b/doc/exclude_patterns.inc
@@ -3,11 +3,11 @@ tools
 projects
 test
 xmos_cmake_toolchain
-modules/drivers
+modules/**/thirdparty
 modules/FreeRTOS
 modules/sw_services
 build
 build_*
-CHANGELOG.rst
-LICENSE.rst
-**README* 
+**CHANGELOG*
+**LICENSE*
+**README*
diff --git a/doc/programming_guide/tutorials/application_design.rst b/doc/programming_guide/tutorials/application_design.rst
@@ -62,7 +62,7 @@ Board Support Configurations
 
 xcore leverages its architecture to provide a flexible chip where many typically silicon based peripherals are found in software. This allows a chip to be reconfigured in a way that provides the specific IO required for a given application, thus resulting in a low cost yet incredibly silicon efficient solution. Board support configurations (bsp_configs) are the description for the hardware IO that exists in a given board. The bsp_configs provide the application programmer with an API to initialize and start the hardware configuration, as well as the supported RTOS driver contexts. The programming model in this FreeRTOS architecture is:
 
-- `.xn files <https://www.xmos.ai/documentation/XM-014363-PC-LATEST/html/tools-guide/tools-ref/formats/xn-spec/xn-spec.html?highlight=xn>`__ provide the mapping of ports, pins, and links
+- `.xn files <https://www.xmos.ai/documentation/XM-014363-PC-LATEST/html/tools-guide/tools-ref/formats/xn-spec/xn-spec.html?highlight=xn>`_ provide the mapping of ports, pins, and links
 - bsp_configs specify, setup, and start hardware IO and provide the application with RTOS driver contexts
 - applications use the bsp_config init/start code as well as RTOS driver contexts, similar to conventional microcontroller programming models.
 
@@ -77,7 +77,7 @@ Creating Custom bsp_configs
 To enable hardware portability, a minimal bsp_config should contain the following:
 
 .. code-block:: console
-  
+
   custom_config/
     platform/
       driver_instances.c

diff --git a/doc/programming_guide/tutorials/bsp_config.rst b/doc/programming_guide/tutorials/bsp_config.rst
@@ -5,7 +5,7 @@ Board Support Configurations
 
 xcore leverages its architecture to provide a flexible chip where many typically silicon based peripherals are found in software. This allows a chip to be reconfigured in a way that provides the specific IO required for a given application, thus resulting in a low cost yet incredibly silicon efficient solution. Board support configurations (bsp_configs) are the description for the hardware IO that exists in a given board. The bsp_configs provide the application programmer with an API to initialize and start the hardware configuration, as well as the supported RTOS driver contexts. The programming model in this FreeRTOS architecture is:
 
-- `.xn files <https://www.xmos.ai/documentation/XM-014363-PC-LATEST/html/tools-guide/tools-ref/formats/xn-spec/xn-spec.html?highlight=xn>`__ provide the mapping of ports, pins, and links
+- `.xn files <https://www.xmos.ai/documentation/XM-014363-PC-LATEST/html/tools-guide/tools-ref/formats/xn-spec/xn-spec.html?highlight=xn>`_ provide the mapping of ports, pins, and links
 - bsp_configs specify, setup, and start hardware IO and provide the application with RTOS driver contexts
 - applications use the bsp_config init/start code as well as RTOS driver contexts, similar to conventional microcontroller programming models.
 
@@ -20,7 +20,7 @@ Creating Custom bsp_configs
 To enable hardware portability, a minimal ``bsp_config`` should contain the following:
 
 .. code-block:: console
-  
+
   custom_config/
     platform/
       driver_instances.c

diff --git a/doc/shared/legal.rst b/doc/shared/legal.rst
@@ -4,11 +4,11 @@
 
     Copyright & Disclaimer
     ======================
-    
+
     |XMOS copyright|
-    
+
     |XMOS disclaimer|
-    
+
     |XMOS trademarks|
 
 
@@ -18,7 +18,7 @@ Licenses
 XMOS
 ^^^^
 
-All original source code is licensed under the `XMOS License <https://github.com/xmos/sln_voice/blob/develop/LICENSE.rst>`_.
+All original source code is licensed under the `XMOS License <https://github.com/xmos/sln_voice/blob/develop/LICENSE.rst>`__.
 
 Third-Party
 ^^^^^^^^^^^

diff --git a/index.rst b/index.rst
@@ -16,4 +16,4 @@ Framework of FreeRTOS kernel, RTOS drivers, and software service libraries for X
 Licensing
 *********
 
-This Software is subject to the terms of the `XMOS Public Licence: Version 1 <https://github.com/xmos/sln_voice/blob/develop/LICENSE.rst>`_. Copyrights and licenses for third party components can be found in :ref:`fwk_rtos_copyright`.
+This Software is subject to the terms of the `XMOS Public Licence: Version 1 <https://github.com/xmos/sln_voice/blob/develop/LICENSE.rst>`_. Copyrights and licenses for third party components can be found at the end of each guide.
diff --git a/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_host.c b/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_host.c
@@ -1,7 +1,6 @@
-// Copyright 2020 XMOS LIMITED. This Software is subject to the terms of the 
+// Copyright 2020-2023 XMOS LIMITED.
 // This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
-
 #include <stdlib.h>
 #include <string.h>
 

diff --git a/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_host.h b/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_host.h
@@ -1,4 +1,4 @@
-// Copyright 2021 XMOS LIMITED. This Software is subject to the terms of the
+// Copyright 2021-2023 XMOS LIMITED.
 // This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 #ifndef SL_WFX_HOST_H_

diff --git a/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_host_spi.c b/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_host_spi.c
@@ -1,4 +1,4 @@
-// Copyright 2020 XMOS LIMITED. This Software is subject to the terms of the
+// Copyright 2020-2023 XMOS LIMITED.
 // This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 #include <string.h>

diff --git a/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_host_task.c b/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_host_task.c
@@ -1,4 +1,4 @@
-// Copyright 2020 XMOS LIMITED. This Software is subject to the terms of the 
+// Copyright 2020-2023 XMOS LIMITED.
 // This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 #include <string.h>

diff --git a/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_iot_wifi.c b/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_iot_wifi.c
@@ -1,4 +1,4 @@
-// Copyright 2019 XMOS LIMITED. This Software is subject to the terms of the 
+// Copyright 2019-2023 XMOS LIMITED.
 // This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 #define DEBUG_UNIT IOT_WIFI

diff --git a/modules/sw_services/wifi_manager/FreeRTOS/heapsort.h b/modules/sw_services/wifi_manager/FreeRTOS/heapsort.h
@@ -1,7 +1,6 @@
 // Copyright 2020-2023 XMOS LIMITED.
 // This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
-
 #ifndef HEAPSORT_H_
 #define HEAPSORT_H_
 

diff --git a/test/rtos_drivers/hil/README.rst b/test/rtos_drivers/hil/README.rst
@@ -63,7 +63,7 @@ To build the test application firmware, run the following command from the top o
 
     bash tools/ci/build_rtos_tests.sh
 
-The ``build_rtos_tests.sh``` script will copy the test applications to the ``dist`` folder.
+The ``build_rtos_tests.sh`` script will copy the test applications to the ``dist`` folder.
 
 Run the test with the following command from the top of the repository:
 

diff --git a/test/rtos_drivers/usb/README.rst b/test/rtos_drivers/usb/README.rst
@@ -52,7 +52,7 @@ run the following command from the root of this repository:
 
     bash tools/ci/build_rtos_tests.sh
 
-The ``build_rtos_tests.sh``` script will copy the test applications to the ``dist`` folder.
+The ``build_rtos_tests.sh`` script will copy the test applications to the ``dist`` folder.
 
 *************
 Running Tests

diff --git a/test/rtos_drivers/usb/serial_send_receive.py b/test/rtos_drivers/usb/serial_send_receive.py
@@ -6,7 +6,6 @@
 import serial
 import serial.tools.list_ports
 import argparse
-import time
 
 # USB VID:PID for test application
 vid=0x20B1
@@ -86,4 +85,4 @@ def main(if0, if1, of0, of1):
 if __name__ == "__main__":
     args = parse_arguments()
 
-    main(args.if0, args.if1, args.of0, args.of1)
+    main(args.if0, args.if1, args.of0, args.of1)