Skip to content
Snippets Groups Projects
Commit b673cbeb authored by Gregory Nutt's avatar Gregory Nutt
Browse files

Updates to README files

parent 8ecaf62d
No related branches found
No related tags found
No related merge requests found
......@@ -33,7 +33,7 @@ NuttX directory. Like:
`- apps
If all of the above conditions are TRUE, then NuttX will be able to
find the application directory. If your application directory has a
find the application directory. If your application directory has a
different name or is location at a different position, then you will
have to inform the NuttX build system of that location. There are several
ways to do that:
......@@ -61,7 +61,7 @@ collected during the make context build phase.
To execute an application function:
exec_builtin() is defined in the nuttx/include/apps/builtin.h
exec_builtin() is defined in the nuttx/include/apps/builtin.h
NuttShell (NSH) Built-In Commands
---------------------------------
......@@ -98,7 +98,7 @@ Application Configuration File
The old-style NuttX configuration uses a special configuration file is
used to configure which applications are to be included in the build.
The source for this file is configs/<board>/<configuration>/appconfig.
The existence of the appconfig file in the board configuration directory\
The existence of the appconfig file in the board configuration directory
is sufficient to enable building of applications.
The appconfig file is copied into the apps/ directory as .config when
......@@ -250,12 +250,13 @@ A: Here are four:
a) Copy 'MyBoard' directory to configs/MyBoard.
b) Add a symbolic link to MyApplication at apps/external
c) Configure NuttX (usually by:
tools/configure.sh MyBoard/MyConfiguration
or simply by copying defconfig->nutt/.config,
setenv.sh->nuttx/setenv.sh, Make.defs->nuttx/Make.defs,
appconfig->apps/.config
setenv.sh->nuttx/setenv.sh, and Make.defs->nuttx/Make.defs
(and appconfig->apps/.config for the old-style, deprecated
configuration files).
Using the 'external' link makes it especially easy to add a
'built-in' application an existing configuration.
......
This diff is collapsed.
......@@ -83,7 +83,7 @@ $(COBJS): %$(OBJEXT): %.c
$(call ARCHIVE, $(BIN), $(OBJS))
@touch .built
ifeq ($(CONFIG_EXAMPLES_TOUCHSCREEN_BUILTIN),y)
ifeq ($(CONFIG_NSH_BUILTIN_APPS),y)
$(BUILTIN_REGISTRY)$(DELIM)$(APPNAME)_main.bdat: $(DEPCONFIG) Makefile
$(call REGISTER,$(APPNAME),$(PRIORITY),$(STACKSIZE),$(APPNAME)_main)
......
......@@ -33,7 +33,7 @@ pcode
sub-directory.
Example:
./INSTALL.sh -16 $PWD/../../../apps/interpreters
After installation, the NuttX apps/interpresters directory will contain
......@@ -52,11 +52,18 @@ pcode
`-- model-specific source files
pashello
There is a simple Pascal example at apps/examples/pashello. This is the
standard "Hello, World!" example written in Pascal and interpreted from
Pascal P-Code at runtime. To use this example, place the following in
your appconfig file"
your defonfig file:
CONFIG_EXAMPLES_PASHELLO=y
CONFIG_INTERPRETERS_PCODE=y
Old Style (deprecated). In the older configuration files, you would have
used an appconfig file containing the following definitions in order to
accomplish the same thing:
# Path to example in apps/examples containing the passhello_main entry point
......
......@@ -29,12 +29,17 @@ information as "recommendations" -- not necessarily proven instructions.
For example, './configure.sh ficl-4.1.0' will leave the Makefile
fragment 'Make.srcs' in the ficl build directory.
5. Create your NuttX configuration. The appconfig file should include
(1) the path to your application code, and (2) the path to the Ficl
build directory. That latter would appear as the following line in
your appconfig file:
5. Create your NuttX configuration. Using the 'make menuconfig', you
should select:
CONFIGURED_APPS += interpreters/ficl
CONFIG_INTERPRETERS_FICL=y
Deprecated: In the older style configuration, you would have used
an appconfig file to include (1) the path to your application code,
and (2) the path to the Ficl build directory. That latter would
have appeared as the following line in your appconfig file:
CONFIGURED_APPS += interpreters/ficl
6. Configure and build NuttX. On successful completion, the Ficl objects
will be available in apps/libapps.a and that NuttX binary will be
......
......@@ -69,11 +69,13 @@ highly influenced by uIP) include:
See http://acme.com/software/thttpd/ for general THTTPD
information. See apps/include/netutils/thttpd.h
for interface information. Applications using this thttpd
will need to provide an appconfig file in the configuration
directory with instruction to build applications like:
will need to provide the following definitions in the
defconfig file to select the appropriate netutils
libraries:
CONFIG_NETUTILS_UIPLIB=y
CONFIG_NETUTILS_THTTPD=y
CONFIGURED_APPS += uiplib
CONFIGURED_APPS += thttpd
xmlrpc - The Embeddable Lightweight XML-RPC Server discussed at
http://www.drdobbs.com/web-development/an-embeddable-lightweight-xml-rpc-server/184405364
......@@ -85,16 +87,16 @@ Telnetd in NuttX is to support the NuttShell (NSH) Telnet front end. See
apps/include/netutils/telnetd.h for information about how to incorporate
Telnetd into your custom applications.
To enable and link the Telnetd daemon, you need to include the following in
in your appconfig (apps/.config) file:
To enable and link the Telnetd daemon, you need to include the following in
in your defconfig file:
CONFIGURED_APPS += uiplib
CONFIGURED_APPS += netutils/telnetd
CONFIG_NETUTILS_UIPLIB=y
CONFIG_NETUTILS_TELNETD=y
Also if the Telnet console is enabled, make sure that you have the following
set in the NuttX configuration file or else the performance will be very bad
(because there will be only one character per TCP transfer):
CONFIG_STDIO_BUFFER_SIZE Some value >= 64
CONFIG_STDIO_LINEBUFFER=y Since Telnetd is line oriented, line buffering
is optimal.
......
......@@ -273,7 +273,7 @@ o date [-s "MMM DD HH:MM:SS YYYY"]
Only one format is used both on display and when setting the date/time:
MMM DD HH:MM:SS YYYY. For example,
data -s "Sep 1 11:30:00 2011"
24-hour time format is assumed.
......@@ -326,7 +326,7 @@ o df
Size Blocks Used Available Mounted on
64 6 6 0 /etc
512 985 2 983 /tmp
nsh>
nsh>
o echo [<string|$name> [<string|$name>...]]
......@@ -757,7 +757,7 @@ o rmdir <dir-path>
Recall that NuttX uses a pseudo filesystem for its root file system. The
rmdir command can only be used to remove directories from volumes set up
with the mount command; it cannot be used to remove directories from the
pseudo filesystem.
pseudo filesystem.
Example:
^^^^^^^^
......@@ -808,7 +808,7 @@ o unset <name>
nsh>
o urldecode [-f] <string or filepath>
o urlencode [-f] <string or filepath>
o usleep <usec>
......@@ -844,7 +844,7 @@ NSH Configuration Settings
^^^^^^^^^^^^^^^^^^^^^^^^^^
The availability of the above commands depends upon features that
may or may not be enabled in the NuttX configuration file. The
may or may not be enabled in the NuttX configuration file. The
following table indicates the dependency of each command on NuttX
configuration settings. General configuration settings are discussed
in the NuttX Porting Guide. Configuration settings specific to NSH
......@@ -948,7 +948,7 @@ NSH-Specific Configuration Settings
Support external registered, "builtin" applications that can be
executed from the NSH command line (see apps/README.txt for
more information).
* CONFIG_NSH_FILEIOSIZE
Size of a static I/O buffer used for file access (ignored if
there is no filesystem). Default is 1024.
......@@ -1099,7 +1099,7 @@ NSH-Specific Configuration Settings
* CONFIG_NET=y
Of course, networking must be enabled
* CONFIG_NSOCKET_DESCRIPTORS
And, of course, you must allocate some socket descriptors.
......@@ -1137,7 +1137,7 @@ NSH-Specific Configuration Settings
* CONFIG_NET=y
Of course, networking must be enabled
* CONFIG_NSOCKET_DESCRIPTORS
And, of course, you must allocate some socket descriptors.
......@@ -1147,7 +1147,7 @@ NSH-Specific Configuration Settings
* CONFIG_NET_BROADCAST=y
UDP broadcast support is needed.
* CONFIG_NET_BUFSIZE=650 (or larger)
Per RFC2131 (p. 9), the DHCP client must be prepared to receive DHCP
messages of up to 576 bytes (excluding Ethernet, IP, or UDP headers and FCS).
......@@ -1166,7 +1166,7 @@ NSH-Specific Configuration Settings
start with '/'.
* CONFIG_NSH_ROMFSDEVNO
This is the minor number of the ROMFS block device. The default is
This is the minor number of the ROMFS block device. The default is
'0' corresponding to /dev/ram0.
* CONFIG_NSH_ROMFSSECTSIZE
......@@ -1180,7 +1180,7 @@ NSH-Specific Configuration Settings
describe that FAT FS.
* CONFIG_NSH_FATDEVNO
This is the minor number of the FAT FS block device. The default is
This is the minor number of the FAT FS block device. The default is
'1' corresponding to /dev/ram1.
* CONFIG_NSH_FATSECTSIZE
......@@ -1212,7 +1212,6 @@ Common Problems
Problem:
The function 'readline' is undefined.
Usual Cause:
The following is missing from your appconfig file:
CONFIGURED_APPS += system/readline
The following is missing from your defconfig file:
CONFIG_SYSTEM_READLINE=y
This diff is collapsed.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment