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

Change name configs/ to boards/ in comments, Documentation, Tools, etc.

Browse Source
This commit is contained in:
Gregory Nutt 2019-08-05 07:33:16 -06:00
parent eef399b369
commit 2a8dccb75d
10 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.txt
View File

@ -168,9 +168,9 @@ A: Here are three:
You can copy any pieces that you like from the old apps/directory You can copy any pieces that you like from the old apps/directory
to your custom apps directory as necessary. to your custom apps directory as necessary.
This is documented in NuttX/configs/README.txt and This is documented in NuttX/boards/README.txt and
nuttx/Documentation/NuttxPortingGuide.html (Online at nuttx/Documentation/NuttxPortingGuide.html (Online at
https://bitbucket.org/nuttx/documentation/src/master/NuttxPortingGuide.html#apndxconfigs https://bitbucket.org/nuttx/nuttx/src/master/Documentation/NuttxPortingGuide.html#apndxconfigs
under Build options). And in the apps/README.txt file. under Build options). And in the apps/README.txt file.
3) If you like the random collection of stuff in the apps/ directory 3) If you like the random collection of stuff in the apps/ directory
@ -212,7 +212,7 @@ A: Here are three:
installs a custom application, configuration, and board specific installs a custom application, configuration, and board specific
directory: directory:
a) Copy 'MyBoard' directory to configs/MyBoard. a) Copy 'MyBoard' directory to boards/MyBoard.
b) Add a symbolic link to MyApplication at apps/external b) Add a symbolic link to MyApplication at apps/external
c) Configure NuttX (usually by: c) Configure NuttX (usually by:

8
examples/README.txt
View File

@ -5,7 +5,7 @@ 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
configs/<board-name>/defconfig file via the CONFIG_EXAMPLES_xyz boards/<board-name>/defconfig file via the CONFIG_EXAMPLES_xyz
setting where xyz is the name of the example. For example, setting where xyz is the name of the example. For example,
CONFIG_EXAMPLES_HELLO=y CONFIG_EXAMPLES_HELLO=y
@ -411,7 +411,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/configs/viewtool-stm32f107/ft80x/defconfig. nuttx/boards/viewtool-stm32f107/ft80x/defconfig.
examples/ftpc examples/ftpc
^^^^^^^^^^^^^ ^^^^^^^^^^^^^
@ -1738,7 +1738,7 @@ examples/thttpd
^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^
An example that builds netutils/thttpd with some simple NXFLAT An example that builds netutils/thttpd with some simple NXFLAT
CGI programs. see configs/README.txt for most THTTPD settings. CGI programs. see boards/README.txt for most THTTPD settings.
In addition to those, this example accepts: In addition to those, this example accepts:
CONFIG_EXAMPLES_THTTPD_NOMAC - (May be defined to use software assigned MAC) CONFIG_EXAMPLES_THTTPD_NOMAC - (May be defined to use software assigned MAC)
@ -1888,7 +1888,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/configs/sim/README.txt for a walk-through of See the README.txt file at nuttx/boards/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 configs/<board>/src directory for the board. in the boards/<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:

4
nshlib/Kconfig
View File

@ -806,8 +806,8 @@ 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/configs/<boardname>/include will be linked (or copied) from nuttx/boards/<boardname>/include
and should be stored at that location in the nuttx configs/ and should be stored at that location in the nuttx boards/
sub-directory. sub-directory.
config NSH_CUSTOMROMFS config NSH_CUSTOMROMFS

6
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 configs/<board>/include will be nsh_romfsimg.h file residing in boards/<board>/include will be
used. NOTE when the OS is configured, include/arch/board will used. NOTE when the OS is configured, include/arch/board will
be linked to configs/<board>/include. be linked to boards/<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 configs/<board-name>/defconfig file: the boards/<board-name>/defconfig file:
* CONFIG_NSH_READLINE * CONFIG_NSH_READLINE
Selects the minimal implementation of readline(). This minimal Selects the minimal implementation of readline(). This minimal

2
nshlib/nsh.h
View File

@ -517,7 +517,7 @@
#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
* configs/<board-name>defconfig file -- provided that it is at least as * boards/<board-name>defconfig file -- provided that it is at least as
* large as PATH_MAX. * large as PATH_MAX.
*/ */

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
configs/mcu123-lpc124x/src/up_usbmsc.c or boards/mcu123-lpc124x/src/up_usbmsc.c or
configs/stm3210e-eval/src/usbmsc.c boards/stm3210e-eval/src/usbmsc.c
Configuration options: Configuration options:

2
system/zmodem/README.txt
View File

@ -210,7 +210,7 @@ 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 configs/olimex-lpc1766stk configuration. I I have tested with the boards/olimex-lpc1766stk configuration. I
have been able to send large and small files with the target sz 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 command. I have been able to receive small files, but there are
problems receiving large files using the Linux sz command: The problems receiving large files using the Linux sz command: The

2
testing/README.txt
View File

@ -81,7 +81,7 @@ 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 configs/<board-name>/defconfig file: settings in the boards/<board-name>/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/configs/^<board-name^>/. Echo under nuttx/boards/^<board-name^>/.
Echo ^<-h^>: Echo ^<-h^>:
Echo Prints this message and exits. Echo Prints this message and exits.