This is an automated email from the ASF dual-hosted git repository. linguini pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/nuttx.git
commit f809985e5b9ea6faa117a75ebcd7427586724dda Author: raiden00pl <[email protected]> AuthorDate: Sat Oct 11 12:58:05 2025 +0200 boards: remove reference to non-existent readme Most references to the readmes have been removed. The removed references didn't make much sense and were inconsistent with other sections of the code. Some sections linked to the readme, others didn't. More importantly, most boards don't have any readme references. Let's not treat developers as fools who need to be reminded at every step to check the readme (which doesn't exit anymore anyway). Signed-off-by: raiden00pl <[email protected]> --- boards/arm/lpc17xx_40xx/lpc4088-devkit/tools/oocd.sh | 3 +-- boards/arm/lpc17xx_40xx/lpc4088-quickstart/tools/oocd.sh | 3 +-- boards/arm/lpc17xx_40xx/lx_cpu/tools/oocd.sh | 3 +-- boards/arm/lpc17xx_40xx/olimex-lpc1766stk/tools/oocd.sh | 3 +-- boards/arm/lpc17xx_40xx/open1788/tools/oocd.sh | 3 +-- boards/arm/lpc214x/zp214xpa/tools/oocd.sh | 3 +-- boards/arm/lpc31xx/olimex-lpc-h3131/tools/oocd.sh | 3 +-- boards/arm/samv7/common/tools/oocd.sh | 2 +- boards/arm/stm32/mikroe-stm32f4/include/board.h | 3 +-- boards/arm/stm32/stm32f429i-disco/include/board.h | 13 +++++++------ boards/arm/stm32/stm32f4discovery/include/board.h | 4 ++-- boards/arm/stm32/stm32f4discovery/src/stm32_ssd1289.c | 2 +- .../arm/stm32/viewtool-stm32f107/src/viewtool_stm32f107.h | 4 ++-- boards/arm/tiva/dk-tm4c129x/tools/oocd.sh | 3 +-- boards/arm/tiva/lm3s6965-ek/tools/oocd.sh | 3 +-- boards/arm/tiva/lm4f120-launchpad/tools/oocd.sh | 3 +-- boards/arm/tiva/tm4c123g-launchpad/tools/oocd.sh | 3 +-- boards/arm/tiva/tm4c1294-launchpad/tools/oocd.sh | 3 +-- boards/arm/tiva/tm4c129e-launchpad/tools/oocd.sh | 3 +-- boards/mips/pic32mx/sure-pic32mx/src/pic32mx_lcd1602.c | 2 +- boards/mips/pic32mx/sure-pic32mx/src/sure-pic32mx.h | 2 +- 21 files changed, 29 insertions(+), 42 deletions(-) diff --git a/boards/arm/lpc17xx_40xx/lpc4088-devkit/tools/oocd.sh b/boards/arm/lpc17xx_40xx/lpc4088-devkit/tools/oocd.sh index 627c576508a..9761a86cd34 100755 --- a/boards/arm/lpc17xx_40xx/lpc4088-devkit/tools/oocd.sh +++ b/boards/arm/lpc17xx_40xx/lpc4088-devkit/tools/oocd.sh @@ -1,7 +1,6 @@ #!/bin/sh # -# See boards/lpc4088-devkit/README.txt for information about -# this file. +# See board documentation page for information about this file. TOPDIR=$1 USAGE="$0 <TOPDIR> [-d]" diff --git a/boards/arm/lpc17xx_40xx/lpc4088-quickstart/tools/oocd.sh b/boards/arm/lpc17xx_40xx/lpc4088-quickstart/tools/oocd.sh index 9d93a5a243d..adec3d8c716 100755 --- a/boards/arm/lpc17xx_40xx/lpc4088-quickstart/tools/oocd.sh +++ b/boards/arm/lpc17xx_40xx/lpc4088-quickstart/tools/oocd.sh @@ -1,7 +1,6 @@ #!/bin/sh # -# See boards/lpc4088-quickstart/README.txt for information about -# this file. +# See board documentation page for information about this file. TOPDIR=$1 USAGE="$0 <TOPDIR> [-d]" diff --git a/boards/arm/lpc17xx_40xx/lx_cpu/tools/oocd.sh b/boards/arm/lpc17xx_40xx/lx_cpu/tools/oocd.sh index dd7b5eb8d13..f4f4520c856 100644 --- a/boards/arm/lpc17xx_40xx/lx_cpu/tools/oocd.sh +++ b/boards/arm/lpc17xx_40xx/lx_cpu/tools/oocd.sh @@ -1,7 +1,6 @@ #!/bin/sh # -# See Documentation/platforms/arm/lpc40xx/boards/lx_cpu/README.txt for information about -# this file. +# See board documentation page for information about this file. TOPDIR=$1 USAGE="$0 <TOPDIR> [-d]" diff --git a/boards/arm/lpc17xx_40xx/olimex-lpc1766stk/tools/oocd.sh b/boards/arm/lpc17xx_40xx/olimex-lpc1766stk/tools/oocd.sh index 250896d6f34..f63e90d300d 100755 --- a/boards/arm/lpc17xx_40xx/olimex-lpc1766stk/tools/oocd.sh +++ b/boards/arm/lpc17xx_40xx/olimex-lpc1766stk/tools/oocd.sh @@ -1,7 +1,6 @@ #!/usr/bin/env bash # -# See boards/olimex-lpc1766stk/README.txt for information about -# this file. +# See board documentation page for information about this file. TOPDIR=$1 USAGE="$0 <TOPDIR> [-d]" diff --git a/boards/arm/lpc17xx_40xx/open1788/tools/oocd.sh b/boards/arm/lpc17xx_40xx/open1788/tools/oocd.sh index e7327649dd6..37989d62d27 100755 --- a/boards/arm/lpc17xx_40xx/open1788/tools/oocd.sh +++ b/boards/arm/lpc17xx_40xx/open1788/tools/oocd.sh @@ -1,7 +1,6 @@ #!/usr/bin/env bash # -# See boards/open1788/README.txt for information about -# this file. +# See board documentation page for information about this file. TOPDIR=$1 USAGE="$0 <TOPDIR> [-d]" diff --git a/boards/arm/lpc214x/zp214xpa/tools/oocd.sh b/boards/arm/lpc214x/zp214xpa/tools/oocd.sh index 0413aca4a55..da7766c792d 100755 --- a/boards/arm/lpc214x/zp214xpa/tools/oocd.sh +++ b/boards/arm/lpc214x/zp214xpa/tools/oocd.sh @@ -1,7 +1,6 @@ #!/usr/bin/env bash # -# See Documentation/platforms/arm/lpc214x/boards/zp214xpa/README.txt for information about -# this file. +# See board documentation page for information about this file. TOPDIR=$1 USAGE="$0 <TOPDIR> [-d]" diff --git a/boards/arm/lpc31xx/olimex-lpc-h3131/tools/oocd.sh b/boards/arm/lpc31xx/olimex-lpc-h3131/tools/oocd.sh index 938c731a0c8..75b251d62da 100755 --- a/boards/arm/lpc31xx/olimex-lpc-h3131/tools/oocd.sh +++ b/boards/arm/lpc31xx/olimex-lpc-h3131/tools/oocd.sh @@ -1,7 +1,6 @@ #!/usr/bin/env bash # -# See Documentation/platforms/arm/lpc31xx/boards/olimex-lpc-h3131/README.txt for information about -# this file. +# See board documentation page for information about this file. TOPDIR=$1 USAGE="$0 <TOPDIR> [-d]" diff --git a/boards/arm/samv7/common/tools/oocd.sh b/boards/arm/samv7/common/tools/oocd.sh index 1199cd57476..f3d188a5a7c 100755 --- a/boards/arm/samv7/common/tools/oocd.sh +++ b/boards/arm/samv7/common/tools/oocd.sh @@ -1,6 +1,6 @@ #!/usr/bin/env bash # -# See boards README.txt for information about this file. +# See board documentation page for information about this file. TOPDIR=$1 USAGE="$0 <TOPDIR> [-d]" diff --git a/boards/arm/stm32/mikroe-stm32f4/include/board.h b/boards/arm/stm32/mikroe-stm32f4/include/board.h index 0c529d9a723..ede5d8ea9e2 100644 --- a/boards/arm/stm32/mikroe-stm32f4/include/board.h +++ b/boards/arm/stm32/mikroe-stm32f4/include/board.h @@ -206,7 +206,6 @@ * * The Mikroe-STM32F4 board has no on-board serial devices, but it brings out * UART2 to the expansion header. - * (See the README.txt file for other options) */ #define GPIO_USART2_RX GPIO_USART2_RX_2 @@ -234,7 +233,7 @@ #define DMACHAN_SPI3_RX DMAMAP_SPI3_RX_2 #define DMACHAN_SPI3_TX DMAMAP_SPI3_TX_2 -/* Timer Inputs/Outputs (see the README.txt file for options) */ +/* Timer Inputs/Outputs */ #define GPIO_TIM2_CH1IN GPIO_TIM2_CH1IN_2 #define GPIO_TIM2_CH2IN GPIO_TIM2_CH2IN_1 diff --git a/boards/arm/stm32/stm32f429i-disco/include/board.h b/boards/arm/stm32/stm32f429i-disco/include/board.h index d97073be828..03e8360b3f9 100644 --- a/boards/arm/stm32/stm32f429i-disco/include/board.h +++ b/boards/arm/stm32/stm32f429i-disco/include/board.h @@ -41,7 +41,7 @@ /* Clocking *****************************************************************/ -/* The STM32F4 Discovery board features a single 8MHz crystal. +/* The STM32F429I-DISCO board features a single 8MHz crystal. * Space is provided for a 32kHz RTC backup crystal, but it is not stuffed. * * This is the canonical configuration: @@ -185,7 +185,7 @@ /* Button definitions *******************************************************/ -/* The STM32F4 Discovery supports one button: */ +/* The STM32F429I-DISCO supports one button: */ #define BUTTON_USER 0 @@ -197,9 +197,9 @@ /* USART1: * - * The STM32F4 Discovery has no on-board serial devices, but the console is + * The STM32F429I-DISCO has no on-board serial devices, but the console is * brought out to PA9 (TX) and PA10 (RX) for connection to an external serial - * device. (See the README.txt file for other options) + * device. */ #define GPIO_USART1_RX GPIO_USART1_RX_1 @@ -209,12 +209,13 @@ #define GPIO_USART3_TX GPIO_USART3_TX_1 /* CAN: */ + #define GPIO_CAN1_RX GPIO_CAN1_RX_2 #define GPIO_CAN1_TX GPIO_CAN1_TX_2 /* PWM * - * The STM32F4 Discovery has no real on-board PWM devices, but the board can + * The STM32F429I-DISCO has no real on-board PWM devices, but the board can * be configured to output a pulse train using TIM4 CH2 on PD13. */ @@ -250,7 +251,7 @@ #define GPIO_FMC_SDNE1 GPIO_FMC_SDNE1_1 #define GPIO_FMC_SDNWE GPIO_FMC_SDNWE_1 -/* Timer Inputs/Outputs (see the README.txt file for options) */ +/* Timer Inputs/Outputs */ #define GPIO_TIM2_CH1IN GPIO_TIM2_CH1IN_2 #define GPIO_TIM2_CH2IN GPIO_TIM2_CH2IN_1 diff --git a/boards/arm/stm32/stm32f4discovery/include/board.h b/boards/arm/stm32/stm32f4discovery/include/board.h index 4dce12316ab..ddc86ddc5fe 100644 --- a/boards/arm/stm32/stm32f4discovery/include/board.h +++ b/boards/arm/stm32/stm32f4discovery/include/board.h @@ -261,7 +261,7 @@ * * The STM32F4 Discovery has no on-board serial devices, but the console is * brought out to PA2 (TX) and PA3 (RX) for connection to an external serial - * device. (See the README.txt file for other options) + * device. * * These pins selections, however, conflict with pin usage on the * STM32F4DIS-BB. @@ -384,7 +384,7 @@ #define GPIO_I2C1_SCL GPIO_I2C1_SCL_1 #define GPIO_I2C1_SDA GPIO_I2C1_SDA_2 -/* Timer Inputs/Outputs (see the README.txt file for options) */ +/* Timer Inputs/Outputs */ #define GPIO_TIM2_CH1IN GPIO_TIM2_CH1IN_2 #define GPIO_TIM2_CH2IN GPIO_TIM2_CH2IN_1 diff --git a/boards/arm/stm32/stm32f4discovery/src/stm32_ssd1289.c b/boards/arm/stm32/stm32f4discovery/src/stm32_ssd1289.c index 97002b0f3f9..5e6fb3aaa59 100644 --- a/boards/arm/stm32/stm32f4discovery/src/stm32_ssd1289.c +++ b/boards/arm/stm32/stm32f4discovery/src/stm32_ssd1289.c @@ -99,7 +99,7 @@ static void stm32_backlight(struct ssd1289_lcd_s *dev, int power); * Private Data ****************************************************************************/ -/* LCD pin mapping (see boards/arm/stm32/stm324discovery/README.txt +/* LCD pin mapping * MAPPING TO STM32 F4: * * ---------------- ------------- ---------------------------------- diff --git a/boards/arm/stm32/viewtool-stm32f107/src/viewtool_stm32f107.h b/boards/arm/stm32/viewtool-stm32f107/src/viewtool_stm32f107.h index fbbbe411d95..2a6dbe12d10 100644 --- a/boards/arm/stm32/viewtool-stm32f107/src/viewtool_stm32f107.h +++ b/boards/arm/stm32/viewtool-stm32f107/src/viewtool_stm32f107.h @@ -298,7 +298,7 @@ #define GPIO_MPL115A_CS (GPIO_OUTPUT | GPIO_CNF_OUTPP | GPIO_MODE_50MHz | \ GPIO_OUTPUT_SET | GPIO_PORTB | GPIO_PIN6) -/* FT80x GUI Discrete I/O (See README.txt for details): +/* FT80x GUI Discrete I/O: * * ------ ----------- -------------------- * NAME VIEWTOOL STM32 @@ -323,7 +323,7 @@ #define GPIO_FT80_PD (GPIO_OUTPUT | GPIO_CNF_OUTPP | GPIO_MODE_50MHz | \ GPIO_OUTPUT_CLEAR | GPIO_PORTC| GPIO_PIN5) -/* MAX3421E USB HOST Discrete I/O (See README.txt for details): +/* MAX3421E USB HOST Discrete I/O: * * ------ ----------- -------------------- * NAME VIEWTOOL STM32 diff --git a/boards/arm/tiva/dk-tm4c129x/tools/oocd.sh b/boards/arm/tiva/dk-tm4c129x/tools/oocd.sh index 45db5429096..512c28626aa 100755 --- a/boards/arm/tiva/dk-tm4c129x/tools/oocd.sh +++ b/boards/arm/tiva/dk-tm4c129x/tools/oocd.sh @@ -1,7 +1,6 @@ #!/usr/bin/env bash # -# See Documentation/platforms/arm/tiva/boards/dk-tm4c129x/README.txt for information about -# this file. +# See board documentation page for information about this file. TOPDIR=$1 USAGE="$0 <TOPDIR> [-d]" diff --git a/boards/arm/tiva/lm3s6965-ek/tools/oocd.sh b/boards/arm/tiva/lm3s6965-ek/tools/oocd.sh index c73c6be4d5c..fb80027dd98 100755 --- a/boards/arm/tiva/lm3s6965-ek/tools/oocd.sh +++ b/boards/arm/tiva/lm3s6965-ek/tools/oocd.sh @@ -1,7 +1,6 @@ #!/usr/bin/env bash # -# See Documentation/platforms/arm/tiva/boards/lm3s6965-ek/README.txt for information about -# this file. +# See board documentation page for information about this file. TOPDIR=$1 USAGE="$0 <TOPDIR> [-d]" diff --git a/boards/arm/tiva/lm4f120-launchpad/tools/oocd.sh b/boards/arm/tiva/lm4f120-launchpad/tools/oocd.sh index c7c57bcde2c..074935a6e31 100755 --- a/boards/arm/tiva/lm4f120-launchpad/tools/oocd.sh +++ b/boards/arm/tiva/lm4f120-launchpad/tools/oocd.sh @@ -1,7 +1,6 @@ #!/usr/bin/env bash # -# See Documentation/platforms/arm/tiva/boards/lm4f120-launchpad/README.txt for information about -# this file. +# See board documentation page for information about this file. TOPDIR=$1 USAGE="$0 <TOPDIR> [-d]" diff --git a/boards/arm/tiva/tm4c123g-launchpad/tools/oocd.sh b/boards/arm/tiva/tm4c123g-launchpad/tools/oocd.sh index c061313edad..be9206d1de3 100755 --- a/boards/arm/tiva/tm4c123g-launchpad/tools/oocd.sh +++ b/boards/arm/tiva/tm4c123g-launchpad/tools/oocd.sh @@ -1,7 +1,6 @@ #!/usr/bin/env bash # -# See Documentation/platforms/arm/tiva/boards/tm4c123g-launchpad/README.txt for information about -# this file. +# See board documentation page for information about this file. TOPDIR=$1 USAGE="$0 <TOPDIR> [-d]" diff --git a/boards/arm/tiva/tm4c1294-launchpad/tools/oocd.sh b/boards/arm/tiva/tm4c1294-launchpad/tools/oocd.sh index 50fac61985c..7d986271aef 100755 --- a/boards/arm/tiva/tm4c1294-launchpad/tools/oocd.sh +++ b/boards/arm/tiva/tm4c1294-launchpad/tools/oocd.sh @@ -1,7 +1,6 @@ #!/usr/bin/env bash # -# See Documentation/platforms/arm/tiva/boards/tm4c1294-launchpad/README.txt for information about -# this file. +# See board documentation page for information about this file. TOPDIR=$1 USAGE="$0 <TOPDIR> [-d]" diff --git a/boards/arm/tiva/tm4c129e-launchpad/tools/oocd.sh b/boards/arm/tiva/tm4c129e-launchpad/tools/oocd.sh index a8c66c0db00..1535dca539d 100755 --- a/boards/arm/tiva/tm4c129e-launchpad/tools/oocd.sh +++ b/boards/arm/tiva/tm4c129e-launchpad/tools/oocd.sh @@ -1,7 +1,6 @@ #!/usr/bin/env bash # -# See Documentation/platforms/arm/tiva/boards/tm4c129e-launchpad/README.txt for information about -# this file. +# See board documentation page for information about this file. TOPDIR=$1 USAGE="$0 <TOPDIR> [-d]" diff --git a/boards/mips/pic32mx/sure-pic32mx/src/pic32mx_lcd1602.c b/boards/mips/pic32mx/sure-pic32mx/src/pic32mx_lcd1602.c index 1566f31d9b6..2c6e7e00b9f 100644 --- a/boards/mips/pic32mx/sure-pic32mx/src/pic32mx_lcd1602.c +++ b/boards/mips/pic32mx/sure-pic32mx/src/pic32mx_lcd1602.c @@ -25,7 +25,7 @@ * controller */ -/* LCD pin mapping (see boards/sure-pic32mx/README.txt) +/* LCD pin mapping * * --------------------- ---------- ---------------------------------- * PIC32 Sure JP1 Sure Signal Description diff --git a/boards/mips/pic32mx/sure-pic32mx/src/sure-pic32mx.h b/boards/mips/pic32mx/sure-pic32mx/src/sure-pic32mx.h index 67daa3c8447..0795ae2e537 100644 --- a/boards/mips/pic32mx/sure-pic32mx/src/sure-pic32mx.h +++ b/boards/mips/pic32mx/sure-pic32mx/src/sure-pic32mx.h @@ -52,7 +52,7 @@ #define GPIO_FLASH_LED (GPIO_OUTPUT | GPIO_VALUE_ONE | GPIO_PORTF | GPIO_PIN0) #define GPIO_ERROR_LED (GPIO_OUTPUT | GPIO_VALUE_ONE | GPIO_PORTF | GPIO_PIN1) -/* LCD pin mapping (see boards/sure-pic32mx/README.txt) +/* LCD pin mapping * * --------------------- ---------- ---------------------------------- * PIC32 Sure JP1 Sure Signal Description
