From 4f5690d3d6998fb19bf42d952728fb5f7d5bc68d Mon Sep 17 00:00:00 2001 From: patacongo Date: Sun, 23 Dec 2012 20:22:41 +0000 Subject: [PATCH] Rename namedapp as simply builtin git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@5454 42af7a65-404d-4744-a932-0658087f49c3 --- Documentation/NuttShell.html | 81 ++++++++++++++++++------------------ 1 file changed, 40 insertions(+), 41 deletions(-) diff --git a/Documentation/NuttShell.html b/Documentation/NuttShell.html index 0b5f7aa11b..cc3f078ddf 100644 --- a/Documentation/NuttShell.html +++ b/Documentation/NuttShell.html @@ -2515,7 +2515,7 @@ nsh> CONFIG_NSH_BUILTIN_APPS - Support external registered, "named" applications that can be + Support external registered, "builtin" applications that can be executed from the NSH command line (see apps/README.txt for more information). @@ -3239,48 +3239,48 @@ Builtin Apps: Note that no detailed help information beyond the name of the built-in application is provided.

-

4.3.1 Named Applications

+

4.3.1 Built-In Applications

Overview. - The underlying logic that supports the NSH built-in applications is called "Named Applications". - The named application logic can be found at apps/namedapp. + The underlying logic that supports the NSH built-in applications is called "Built-In Applications". + The builtin application logic can be found at apps/builtin. This logic simply does the following:

  1. - It supports registration mechanism so that named applications can dynamically register themselves at build time, and + It supports registration mechanism so that builtin applications can dynamically register themselves at build time, and

  2. - Utility functions to look up, list, and execute the named applications. + Utility functions to look up, list, and execute the builtin applications.

- Named Application Utility Functions. - The utility functions exported by the named application logic are prototyped in apps/include/apps.h. + Built-In Application Utility Functions. + The utility functions exported by the builtin application logic are prototyped in apps/include/apps.h. These utility functions include:

@@ -3292,23 +3292,23 @@ Builtin Apps:

  1. - apps/namedapp/namedapp_proto.h: + apps/builtin/builtin_proto.h: Prototypes of application task entry points.

  2. - apps/namedapp/namedapp_list.h: + apps/builtin/builtin_list.h: Application specific information and start-up requirements

- Registration of Named Applications. + Registration of Built-In Applications. The NuttX build occurs in several phases as different build targets are executed: (1) context when the configuration is established, (2) depend when target dependencies are generated, and (3) default (all) when the normal compilation and link operations are performed. - Named application information is collected during the make context build phase. + Built-in application information is collected during the make context build phase.

@@ -3376,7 +3376,7 @@ make apps_distclean

- Logic for the context target in apps/examples/hello/Makefile registers the hello_main() application in the namedapp's namedapp_proto.hand namedapp_list.h files. + Logic for the context target in apps/examples/hello/Makefile registers the hello_main() application in the builtin's builtin_proto.hand builtin_list.h files. That logic that does that in apps/examples/hello/Makefile is abstracted below:

    @@ -3388,13 +3388,13 @@ make apps_distclean include $(APPDIR)/Make.defs

    - This defines a macro called REGISTER that adds data to the namedapp header files: + This defines a macro called REGISTER that adds data to the builtin header files:

    @@ -3412,7 +3412,7 @@ STACKSIZE = 2048

  1. - And finally, the Makefile invokes the REGISTER macro to added the hello_main() named application. + And finally, the Makefile invokes the REGISTER macro to added the hello_main() builtin application. Then, when the system build completes, the hello command can be executed from the NSH command line. When the hello command is executed, it will start the task with entry point hello_main() with the default priority and with a stack size of 2K.

    @@ -3424,16 +3424,16 @@ STACKSIZE = 2048

- Other Uses of Named Application. - The primary purpose of named applications is to support command line execution of applications from NSH. - However, there are two other uses of named applications that should be mentioned. + Other Uses of Built-In Application. + The primary purpose of builtin applications is to support command line execution of applications from NSH. + However, there are two other uses of builtin applications that should be mentioned.

  1. - Named Application Start-Up main() function. - A named application can even be used as the main, start-up entry point into your embedded software. + Built-In Application Start-Up main() function. + A builtin application can even be used as the main, start-up entry point into your embedded software. When the user defines this option in the NuttX configuration file: 

      @@ -3451,11 +3451,11 @@ CONFIG_BUILTIN_APP_START=<application name>
 
   
    • 
     
      binfs.
-    binfs is a tiny file system located at apps/namedapp/binfs.c.
-     This provides an alternative what of visualizing installed named applications.
-     Without binfs, you can see the installed named applications using the NSH help command.
+    binfs is a tiny file system located at apps/builtin/binfs.c.
+     This provides an alternative what of visualizing installed builtin applications.
+     Without binfs, you can see the installed builtin applications using the NSH help command.
      binfs will create a tiny pseudo-file system mounted at /bin.
-     Using binfs, you can see the available named applications by listing the contents of  /bin directory.
+     Using binfs, you can see the available builtin applications by listing the contents of  /bin directory.
      This gives some superficial Unix compatibility, but does not really add any new functionality.
@@ -3762,7 +3762,12 @@ mount -t vfat /dev/ram1 /tmp
  • Background command priority
  • binfs
  • Built-In applications
    • +
  • Built-In application start-up main()
  • Built-in variables
    • +
  • builtin_getname()
    • +
  • builtin_isavail()
    • +
  • builtin_list.h
    • +
  • builtin_proto.h
  • base64dec
  • base64enc
  • cat
    • @@ -3827,12 +3832,12 @@ mount -t vfat /dev/ram1 /tmp
  • echo
  • Environment Variables
  • /etc/init.d/rcS -
  • exec
    • -
  • exec_namedapp()
    • -
  • exit
    • -
  • free
    • +
  • exec
    • +
  • exec_builtin()
    • +
  • exit
    • +
  • free
  • g_cmdmap
  • genromfs
  • get
    • @@ -3858,12 +3863,6 @@ mount -t vfat /dev/ram1 /tmp
  • mkromfsimg.sh
  • mount
  • mv
    • -
  • Named application start-up main()
    • -
  • Named applications
    • -
  • namedapp_getname()
    • -
  • namedapp_isavail()
    • -
  • namedapp_list.h
    • -
  • namedapp_proto.h
  • nfsmount
  • nice
  • NSH library (nshlib)
    • @@ -3887,7 +3886,7 @@ mount -t vfat /dev/ram1 /tmp
  • PWD
  • rcS.template
  • Re-directed commands
    • -
  • Registration of named applications
    • +
  • Registration of builtin applications
  • rm
  • rmdir
  • ROMFS, Modifying the ROMFS image