summaryrefslogtreecommitdiffstats
path: root/apps/README.txt
diff options
context:
space:
mode:
authorpatacongo <patacongo@7fd9a85b-ad96-42d3-883c-3090e2eb8679>2011-03-18 18:31:26 +0000
committerpatacongo <patacongo@7fd9a85b-ad96-42d3-883c-3090e2eb8679>2011-03-18 18:31:26 +0000
commit86db7fb9f3a4ceb3b09e196d355c8d67a7f52d3f (patch)
tree2ef2e0911d89b06813b81aa21360cf2e20e24ca3 /apps/README.txt
parentbfb40b397d3762951b30cfb2a2acad25b9f2f9a1 (diff)
apps/ update from Uros
git-svn-id: https://nuttx.svn.sourceforge.net/svnroot/nuttx/trunk@3392 7fd9a85b-ad96-42d3-883c-3090e2eb8679
Diffstat (limited to 'apps/README.txt')
-rw-r--r--apps/README.txt34
1 files changed, 24 insertions, 10 deletions
diff --git a/apps/README.txt b/apps/README.txt
index 1eda70f9a4..272addcb17 100644
--- a/apps/README.txt
+++ b/apps/README.txt
@@ -1,4 +1,3 @@
-
Application Folder
==================
@@ -6,27 +5,42 @@ This folder provides various applications found in sub-directories.
Application entry points with their requirements are gathered together in
in two files:
+
- exec_nuttapp_proto.h Entry points, prototype function
- exec_nuttapp_list.h Application specific information and requirements
Information is collected during the make .depend process.
To execute an application function:
- exec_nuttapp() is defined in the include/nuttx/nuttapp.h
+
+ exec_nuttapp() is defined in the nuttx/include/apps/apps.h
NuttShell provides transparent method of invoking the command, when the
following option is enabled:
+
CONFIG_EXAMPLES_NSH_BUILTIN_APPS=y
-To select which application to be included in the build process set your
-preferences in the nuttx/.config file as:
+in the NuttX configuration.
+
+A special configuration file is used to configure which applications
+are to be included in the build. This file is configs/<board>/<configuration>/appconfig.
+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
+NuttX is configured. .config is included in the toplevel apps/Makefile.
+As a minimum, this configuration file must define files to add to the
+CONFIGURED_APPS list like:
+
+ CONFIGURED_APPS += hello/.built_always poweroff/.built_always jvm/.built_always
+
+The form of each entry is <dir>/<dependency> when:
+
+ <dir> is the name of a subdirectory in the apps directory, and
+
+ <dependency> is a make dependency. This will be "touch"-ed each time
+ that the sub-directory is rebuilt.
-To include applications under the nuttx apps directory:
- CONFIG_BUILTIN_APPS_NUTTX=y/n
-
-where each application can be controlled as:
- CONFIG_BUILTIN_APPS_<NAME>=y/n
-
When the user defines an option:
CONFIG_BUILTIN_APP_START=<application name>