From 093fa23743cfc4e6bd82fe17c459bcd66ce79a6e Mon Sep 17 00:00:00 2001 From: lucianomartin Date: Fri, 3 Nov 2023 08:03:24 +0000 Subject: [PATCH] Remove double underscores --- .../tutorials/application_design.rst | 4 +-- .../tutorials/bsp_config.rst | 4 +-- doc/shared/legal.rst | 35 +++++++++---------- test/README.rst | 2 +- 4 files changed, 22 insertions(+), 23 deletions(-) diff --git a/doc/programming_guide/tutorials/application_design.rst b/doc/programming_guide/tutorials/application_design.rst index d0ca87049..35b7798a8 100644 --- 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 `__ provide the mapping of ports, pins, and links +- `.xn files `_ 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 index 92467094a..ecf0bb71d 100644 --- 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 `__ provide the mapping of ports, pins, and links +- `.xn files `_ 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 index b0b45b002..bde0605ea 100644 --- a/doc/shared/legal.rst +++ b/doc/shared/legal.rst @@ -4,11 +4,11 @@ Copyright & Disclaimer ====================== - + |XMOS copyright| - + |XMOS disclaimer| - + |XMOS trademarks| @@ -32,19 +32,18 @@ Additional third party code is included under the following copyrights and licen * - Module - Copyright & License - * - `Argtable3 `__ - - Copyright (C) 1998-2001,2003-2011,2013 Stewart Heitmann, licensed under `LICENSE `__ - * - `FatFS `__ - - Copyright (C) 2017 ChaN, licensed under a `BSD-style license `__ - * - `FreeRTOS `__ - - Copyright (c) 2017 Amazon.com, Inc., licensed under the `MIT License `__ + * - `Argtable3 `_ + - Copyright (C) 1998-2001,2003-2011,2013 Stewart Heitmann, licensed under `LICENSE `_ + - Copyright (C) 2017 ChaN, licensed under a `BSD-style license `_ + * - `FreeRTOS `_ + - Copyright (c) 2017 Amazon.com, Inc., licensed under the `MIT License `_ * - HTTP Parser - - Copyright (c) Joyent, Inc. and other Node contributors, licensed under the `MIT license `__ - * - `JSMN JSON Parser `__ - - Copyright (c) 2010 Serge A. Zaitsev, licensed under the `MIT license `__ - * - `Mbed TLS library `__ - - Copyright (c) 2006-2018 ARM Limited, licensed under the `Apache License 2.0 `__ - * - `Paho MQTT C/C++ client for Embedded platforms `__ - - Copyright (c) 2020 The TensorFlow Authors, licensed under the `Apache License `__ - * - `TinyUSB `__ - - Copyright (c) 2018 hathach (tinyusb.org), licensed under the `MIT license `__ + - Copyright (c) Joyent, Inc. and other Node contributors, licensed under the `MIT license `_ + * - `JSMN JSON Parser `_ + - Copyright (c) 2010 Serge A. Zaitsev, licensed under the `MIT license `_ + * - `Mbed TLS library `_ + - Copyright (c) 2006-2018 ARM Limited, licensed under the `Apache License 2.0 `_ + * - `Paho MQTT C/C++ client for Embedded platforms `_ + - Copyright (c) 2020 The TensorFlow Authors, licensed under the `Apache License `_ + * - `TinyUSB `_ + - Copyright (c) 2018 hathach (tinyusb.org), licensed under the `MIT license `_ diff --git a/test/README.rst b/test/README.rst index c9c35898d..800c67096 100644 --- a/test/README.rst +++ b/test/README.rst @@ -9,7 +9,7 @@ Requirements The following software is required for running tests. * Linux, MacOS, or Windows Subsystem for Linux -* `Python 3.8 `__ +* `Python 3.8 `_ Python Virtual Environment ==========================