From e6ba3ccff8154f4e6c25e33c4492ef6b15f602b5 Mon Sep 17 00:00:00 2001 From: Gregory Nutt Date: Fri, 9 Aug 2019 08:40:22 -0600 Subject: [PATCH] Update comments, README's, etc. to reflect changes to nuttx/boards directory reorganization. --- examples/README.txt | 10 +++++----- examples/watchdog/Kconfig | 2 +- nshlib/Kconfig | 2 +- nshlib/README.txt | 8 ++++---- nshlib/nsh.h | 4 ++-- system/usbmsc/README.txt | 4 ++-- system/zmodem/README.txt | 20 ++++++++++---------- testing/README.txt | 3 ++- tools/mkkconfig.bat | 2 +- 9 files changed, 28 insertions(+), 27 deletions(-) diff --git a/examples/README.txt b/examples/README.txt index 4b892967e..7e643d4df 100644 --- a/examples/README.txt +++ b/examples/README.txt @@ -5,9 +5,9 @@ examples The examples directory contains several sample applications that can be linked with NuttX. The specific example is selected in the - boards//configs//defconfig file via thei - CONFIG_EXAMPLES_xyz setting where xyz is the name of the example. - For example, + boards////configs//defconfig + file via the CONFIG_EXAMPLES_xyz setting where xyz is the name of the + example. For example, CONFIG_EXAMPLES_HELLO=y @@ -412,7 +412,7 @@ examples/ft80x This examples has ports of several FTDI demos for the FTDI/BridgeTek FT80x GUI chip. As an example configuration, see - nuttx/boards/viewtool-stm32f107/configs/ft80x/defconfig. + nuttx/boards/arm/stm32/viewtool-stm32f107/configs/ft80x/defconfig. examples/ftpc ^^^^^^^^^^^^^ @@ -1889,7 +1889,7 @@ examples/unionfs CONFIG_EXAMPLES_UNIONFS_RAMDEVNO_B - ROMFS file system 2 RAM disk device number CONFIG_EXAMPLES_UNIONFS_SECTORSIZE - ROM disk sector size. - See the README.txt file at nuttx/boards/sim/README.txt for a walk-through of + See the README.txt file at nuttx/boards/sim/sim/sim/README.txt for a walk-through of the output of this text. examples/usbserial diff --git a/examples/watchdog/Kconfig b/examples/watchdog/Kconfig index 05c1fb4ab..31fbc1c69 100644 --- a/examples/watchdog/Kconfig +++ b/examples/watchdog/Kconfig @@ -11,7 +11,7 @@ config EXAMPLES_WATCHDOG In order to use this example, board specific logic must register the watchdog timer driver. That would be in the board bring-up logic - in the boards//src directory for the board. + in the boards///src directory for the board. The way that this is done depends on the underlying MCU architecture. For STM32, this would be done like: diff --git a/nshlib/Kconfig b/nshlib/Kconfig index 6d2ae2e22..e365e8a7b 100644 --- a/nshlib/Kconfig +++ b/nshlib/Kconfig @@ -806,7 +806,7 @@ config NSH_ARCHROMFS ---help--- Enable this option to provide an architecture-specific ROMFS header at arch//nsh_romfsimg.h. Note that this header - will be linked (or copied) from nuttx/boards//include + will be linked (or copied) from nuttx/boards////include and should be stored at that location in the nuttx boards/ sub-directory. diff --git a/nshlib/README.txt b/nshlib/README.txt index 3371ad000..8d8cec1ee 100644 --- a/nshlib/README.txt +++ b/nshlib/README.txt @@ -252,9 +252,9 @@ NOTE: apps/nshlib/rcS.template generates the standard, default nsh_romfsimg.h file. If CONFIG_NSH_ARCHROMFS is defined in the NuttX configuration file, then a custom, board-specific - nsh_romfsimg.h file residing in boards//include will be - used. NOTE when the OS is configured, include/arch/board will - be linked to boards//include. + nsh_romfsimg.h file residing in boards////include + will be used. NOTE when the OS is configured, include/arch/board will + be linked to boards////include. All of the startup-behavior is contained in rcS.template. The role of mkromfsimg.sh is to (1) apply the specific configuration @@ -1544,7 +1544,7 @@ NSH-Specific Configuration Settings ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The behavior of NSH can be modified with the following settings in - the boards//configs//defconfig file: + the boards////configs//defconfig file: * CONFIG_NSH_READLINE Selects the minimal implementation of readline(). This minimal diff --git a/nshlib/nsh.h b/nshlib/nsh.h index 88f21d8cc..3147dd6cd 100644 --- a/nshlib/nsh.h +++ b/nshlib/nsh.h @@ -517,8 +517,8 @@ #endif /* The size of the I/O buffer may be specified in the - * boards//configs/defconfig file -- provided that it is - * at least as large as PATH_MAX. + * boards////configs/defconfig file -- provided + * that it is at least as large as PATH_MAX. */ #define NSH_HAVE_IOBUFFER 1 diff --git a/system/usbmsc/README.txt b/system/usbmsc/README.txt index 1ec8d02c4..6cd5647d3 100644 --- a/system/usbmsc/README.txt +++ b/system/usbmsc/README.txt @@ -11,8 +11,8 @@ system/usbmsc boarctl BOARDIOC_USBDEV_CONTROL command in order to do the actual registration of the block device drivers. For examples of the implementation of board_usbmsc_initialize() see - boards/mcu123-lpc124x/src/up_usbmsc.c or - boards/stm3210e-eval/src/usbmsc.c + boards/arm/lpc214x/mcu123-lpc214x/src/up_usbmsc.c or + boards/arm/stm32/stm3210e-eval/src/usbmsc.c Configuration options: diff --git a/system/zmodem/README.txt b/system/zmodem/README.txt index 847b256ec..4fa6dfceb 100644 --- a/system/zmodem/README.txt +++ b/system/zmodem/README.txt @@ -210,16 +210,16 @@ Status ====== 2013-7-15: Testing against the Linux rz/sz commands. - I have tested with the boards/olimex-lpc1766stk configuration. I - have been able to send large and small files with the target sz - command. I have been able to receive small files, but there are - problems receiving large files using the Linux sz command: The - Linux sz does not obey the buffering limits and continues to send - data while rz is writing the previously received data to the file - and the serial driver's RX buffer is overrun by a few bytes while - the write is in progress. As a result, when it reads the next - buffer of data, a few bytes may be missing. The symptom of this - missing data is a CRC check failure. + I have tested with the boards/arm/lpc17xx_40xx/olimex-lpc1766stk + configuration. I have been able to send large and small files with + the target sz command. I have been able to receive small files, but + there are problems receiving large files using the Linux sz command: + The Linux sz does not obey the buffering limits and continues to send + data while rz is writing the previously received data to the file and + the serial driver's RX buffer is overrun by a few bytes while the + write is in progress. As a result, when it reads the next buffer of + data, a few bytes may be missing. The symptom of this missing data is + a CRC check failure. Either (1) we need a more courteous host application, or (2) we need to greatly improve the target side buffering capability! diff --git a/testing/README.txt b/testing/README.txt index 6baccfb82..4eb2aa2c0 100644 --- a/testing/README.txt +++ b/testing/README.txt @@ -81,7 +81,8 @@ testing/ostest as of this writing, but it is used to qualify each NuttX release. The behavior of the ostest can be modified with the following - settings in the boards//configs//defconfig file: + settings in the boards////configs//defconfig + file: * CONFIG_NSH_BUILTIN_APPS Build the OS test example as an NSH built-in application. diff --git a/tools/mkkconfig.bat b/tools/mkkconfig.bat index 61dffcada..9863d17a4 100755 --- a/tools/mkkconfig.bat +++ b/tools/mkkconfig.bat @@ -119,7 +119,7 @@ Echo Menu description Echo -o ^: Echo Identifies the specific configuratin for the selected ^. Echo This must correspond to a sub-directory under the board directory at -Echo under nuttx/boards/^/. +Echo under nuttx/boards/^/^/^/. Echo ^<-h^>: Echo Prints this message and exits.