sergiotarxz/nuttx-apps
sergiotarxz/nuttx-apps
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update comments, README's, etc. to reflect changes to nuttx/boards directory reorganization.

Browse Source
This commit is contained in:
Gregory Nutt 2019-08-09 08:40:22 -06:00
parent b118c96a33
commit e6ba3ccff8
9 changed files with 28 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
examples/README.txt
View File

@ -5,9 +5,9 @@ examples
The examples directory contains several sample applications that The examples directory contains several sample applications that
can be linked with NuttX. The specific example is selected in the can be linked with NuttX. The specific example is selected in the
boards/<board-name>/configs/<config>/defconfig file via thei boards/<arch-name>/<chip-name>/<board-name>/configs/<config>/defconfig
CONFIG_EXAMPLES_xyz setting where xyz is the name of the example. file via the CONFIG_EXAMPLES_xyz setting where xyz is the name of the
For example, example. For example,
CONFIG_EXAMPLES_HELLO=y CONFIG_EXAMPLES_HELLO=y
@ -412,7 +412,7 @@ examples/ft80x
This examples has ports of several FTDI demos for the FTDI/BridgeTek FT80x This examples has ports of several FTDI demos for the FTDI/BridgeTek FT80x
GUI chip. As an example configuration, see 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 examples/ftpc
^^^^^^^^^^^^^ ^^^^^^^^^^^^^
@ -1889,7 +1889,7 @@ examples/unionfs
CONFIG_EXAMPLES_UNIONFS_RAMDEVNO_B - ROMFS file system 2 RAM disk device number CONFIG_EXAMPLES_UNIONFS_RAMDEVNO_B - ROMFS file system 2 RAM disk device number
CONFIG_EXAMPLES_UNIONFS_SECTORSIZE - ROM disk sector size. 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. the output of this text.
examples/usbserial examples/usbserial

2
examples/watchdog/Kconfig
View File

@ -11,7 +11,7 @@ config EXAMPLES_WATCHDOG
In order to use this example, board specific logic must register the In order to use this example, board specific logic must register the
watchdog timer driver. That would be in the board bring-up logic watchdog timer driver. That would be in the board bring-up logic
in the boards/<board>/src directory for the board. in the boards/<arch/<chip>/<board>/src directory for the board.
The way that this is done depends on the underlying MCU architecture. The way that this is done depends on the underlying MCU architecture.
For STM32, this would be done like: For STM32, this would be done like:

2
nshlib/Kconfig
View File

@ -806,7 +806,7 @@ config NSH_ARCHROMFS
---help--- ---help---
Enable this option to provide an architecture-specific ROMFS Enable this option to provide an architecture-specific ROMFS
header at arch/<boardname>/nsh_romfsimg.h. Note that this header header at arch/<boardname>/nsh_romfsimg.h. Note that this header
will be linked (or copied) from nuttx/boards/<boardname>/include will be linked (or copied) from nuttx/boards/<arch>/<chip>/<board>/include
and should be stored at that location in the nuttx boards/ and should be stored at that location in the nuttx boards/
sub-directory. sub-directory.

8
nshlib/README.txt
View File

@ -252,9 +252,9 @@ NOTE:
apps/nshlib/rcS.template generates the standard, default apps/nshlib/rcS.template generates the standard, default
nsh_romfsimg.h file. If CONFIG_NSH_ARCHROMFS is defined nsh_romfsimg.h file. If CONFIG_NSH_ARCHROMFS is defined
in the NuttX configuration file, then a custom, board-specific in the NuttX configuration file, then a custom, board-specific
nsh_romfsimg.h file residing in boards/<board>/include will be nsh_romfsimg.h file residing in boards/<arch>/<chip>/<board>/include
used. NOTE when the OS is configured, include/arch/board will will be used. NOTE when the OS is configured, include/arch/board will
be linked to boards/<board>/include. be linked to boards/<arch>/<chip>/<board>/include.
All of the startup-behavior is contained in rcS.template. The All of the startup-behavior is contained in rcS.template. The
role of mkromfsimg.sh is to (1) apply the specific configuration 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 behavior of NSH can be modified with the following settings in
the boards/<board-name>/configs/<config>/defconfig file: the boards/<arch>/<chip>/<board>/configs/<config>/defconfig file:
* CONFIG_NSH_READLINE * CONFIG_NSH_READLINE
Selects the minimal implementation of readline(). This minimal Selects the minimal implementation of readline(). This minimal

4
nshlib/nsh.h
View File

@ -517,8 +517,8 @@
#endif #endif
/* The size of the I/O buffer may be specified in the /* The size of the I/O buffer may be specified in the
* boards/<board-name>/configs/<config>defconfig file -- provided that it is * boards/<arch>/<chip>/<board>/configs/<config>defconfig file -- provided
* at least as large as PATH_MAX. * that it is at least as large as PATH_MAX.
*/ */
#define NSH_HAVE_IOBUFFER 1 #define NSH_HAVE_IOBUFFER 1

4
system/usbmsc/README.txt
View File

@ -11,8 +11,8 @@ system/usbmsc
boarctl BOARDIOC_USBDEV_CONTROL command in order to do the actual boarctl BOARDIOC_USBDEV_CONTROL command in order to do the actual
registration of the block device drivers. For examples of the registration of the block device drivers. For examples of the
implementation of board_usbmsc_initialize() see implementation of board_usbmsc_initialize() see
boards/mcu123-lpc124x/src/up_usbmsc.c or boards/arm/lpc214x/mcu123-lpc214x/src/up_usbmsc.c or
boards/stm3210e-eval/src/usbmsc.c boards/arm/stm32/stm3210e-eval/src/usbmsc.c
Configuration options: Configuration options:

20
system/zmodem/README.txt
View File

@ -210,16 +210,16 @@ Status
====== ======
2013-7-15: Testing against the Linux rz/sz commands. 2013-7-15: Testing against the Linux rz/sz commands.
I have tested with the boards/olimex-lpc1766stk configuration. I I have tested with the boards/arm/lpc17xx_40xx/olimex-lpc1766stk
have been able to send large and small files with the target sz configuration. I have been able to send large and small files with
command. I have been able to receive small files, but there are the target sz command. I have been able to receive small files, but
problems receiving large files using the Linux sz command: The there are problems receiving large files using the Linux sz command:
Linux sz does not obey the buffering limits and continues to send 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 data while rz is writing the previously received data to the file and
and the serial driver's RX buffer is overrun by a few bytes while the serial driver's RX buffer is overrun by a few bytes while the
the write is in progress. As a result, when it reads the next write is in progress. As a result, when it reads the next buffer of
buffer of data, a few bytes may be missing. The symptom of this data, a few bytes may be missing. The symptom of this missing data is
missing data is a CRC check failure. a CRC check failure.
Either (1) we need a more courteous host application, or (2) we Either (1) we need a more courteous host application, or (2) we
need to greatly improve the target side buffering capability! need to greatly improve the target side buffering capability!

3
testing/README.txt
View File

@ -81,7 +81,8 @@ testing/ostest
as of this writing, but it is used to qualify each NuttX release. as of this writing, but it is used to qualify each NuttX release.
The behavior of the ostest can be modified with the following The behavior of the ostest can be modified with the following
settings in the boards/<board-name>/configs/<config>/defconfig file: settings in the boards/<arch>/<chip>/<board>/configs/<config>/defconfig
file:
* CONFIG_NSH_BUILTIN_APPS * CONFIG_NSH_BUILTIN_APPS
Build the OS test example as an NSH built-in application. Build the OS test example as an NSH built-in application.

2
tools/mkkconfig.bat
View File

@ -119,7 +119,7 @@ Echo Menu description
Echo -o ^<kconfig-file^>: Echo -o ^<kconfig-file^>:
Echo Identifies the specific configuratin for the selected ^<board-name^>. Echo Identifies the specific configuratin for the selected ^<board-name^>.
Echo This must correspond to a sub-directory under the board directory at Echo This must correspond to a sub-directory under the board directory at
Echo under nuttx/boards/^<board-name^>/. Echo under nuttx/boards/^<arch^>/^<chip^>/^<board^>/.
Echo ^<-h^>: Echo ^<-h^>:
Echo Prints this message and exits. Echo Prints this message and exits.