summaryrefslogtreecommitdiff
path: root/nuttx/examples/README.txt
diff options
context:
space:
mode:
authorpatacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>2008-11-13 12:59:51 +0000
committerpatacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>2008-11-13 12:59:51 +0000
commit390e792605b53d8b9524d911f1aa36f8ca0f604f (patch)
tree5a96c4a3e0a29319da0d6b7c011db603444f12b6 /nuttx/examples/README.txt
parente35530659c659d813461c97ff6bf38781c47821b (diff)
downloadpx4-nuttx-390e792605b53d8b9524d911f1aa36f8ca0f604f.tar.gz
px4-nuttx-390e792605b53d8b9524d911f1aa36f8ca0f604f.tar.bz2
px4-nuttx-390e792605b53d8b9524d911f1aa36f8ca0f604f.zip
updated
git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@1217 42af7a65-404d-4744-a932-0658087f49c3
Diffstat (limited to 'nuttx/examples/README.txt')
-rw-r--r--nuttx/examples/README.txt128
1 files changed, 67 insertions, 61 deletions
diff --git a/nuttx/examples/README.txt b/nuttx/examples/README.txt
index 8d07a6768..180cb0907 100644
--- a/nuttx/examples/README.txt
+++ b/nuttx/examples/README.txt
@@ -10,6 +10,56 @@ examples
Selects the examples/ostest example.
+examples/hello
+^^^^^^^^^^^^^^
+
+ This is the mandatory, "Hello, World!!" example. It is little more
+ than examples/null with a single printf statement. Again useful only
+ for bringing up new NuttX architectures.
+
+examples/mount
+^^^^^^^^^^^^^^
+
+ This contains a simple test of filesystem mountpoints.
+
+ * CONFIG_EXAMPLES_MOUNT_DEVNAME
+ The name of the user-provided block device to mount.
+ If CONFIG_EXAMPLES_MOUNT_DEVNAME is not provided, then
+ a RAM disk will be configured.
+
+ * CONFIG_EXAMPLES_MOUNT_NSECTORS
+ The number of "sectors" in the RAM disk used when
+ CONFIG_EXAMPLES_MOUNT_DEVNAME is not defined.
+
+ * CONFIG_EXAMPLES_MOUNT_SECTORSIZE
+ The size of each sectors in the RAM disk used when
+ CONFIG_EXAMPLES_MOUNT_DEVNAME is not defined.
+
+ * CONFIG_EXAMPLES_MOUNT_RAMDEVNO
+ The RAM device minor number used to mount the RAM disk used
+ when CONFIG_EXAMPLES_MOUNT_DEVNAME is not defined. The
+ default is zero (meaning that "/dev/ram0" will be used).
+
+examples/netttest
+^^^^^^^^^^^^^^^^^
+
+ This is a simple network test for verifying client- and server-
+ functionality in a TCP/IP connection.
+
+examples/nsh
+^^^^^^^^^^^^
+
+ This directory contains the NuttShell (NSH). This is a simple
+ shell application. With some additional development, NSH will
+ someday be a great NuttX application debugger. NSH is described
+ in its own README located at examples/nsh/README.txt
+
+examples/null
+^^^^^^^^^^^^^
+
+ This is the do nothing application. It is only used for bringing
+ up new NuttX architectures in the most minimal of environments.
+
examples/ostest
^^^^^^^^^^^^^^^
@@ -31,36 +81,19 @@ examples/ostest
test. The default is 8 but a smaller number may be needed on
systems without sufficient memory to start so many threads.
-examples/nsh
-^^^^^^^^^^^^
-
- This directory contains the NuttShell (NSH). This is a simple
- shell application. With some additional development, NSH will
- someday be a great NuttX application debugger. NSH is described
- in its own README located at examples/nsh/README.txt
-
-examples/mount
-^^^^^^^^^^^^^^
-
- This contains a simple test of filesystem mountpoints.
+examples/pashello
+^^^^^^^^^^^^^^^^^
- * CONFIG_EXAMPLES_MOUNT_DEVNAME
- The name of the user-provided block device to mount.
- If CONFIG_EXAMPLES_MOUNT_DEVNAME is not provided, then
- a RAM disk will be configured.
+ This is "Hello, World" implemented via the Pascal P-Code interpreter
- * CONFIG_EXAMPLES_MOUNT_NSECTORS
- The number of "sectors" in the RAM disk used when
- CONFIG_EXAMPLES_MOUNT_DEVNAME is not defined.
+examples/pipe
+^^^^^^^^^^^^^
- * CONFIG_EXAMPLES_MOUNT_SECTORSIZE
- The size of each sectors in the RAM disk used when
- CONFIG_EXAMPLES_MOUNT_DEVNAME is not defined.
+ A test of the mkfifo() and pipe() APIs.
- * CONFIG_EXAMPLES_MOUNT_RAMDEVNO
- The RAM device minor number used to mount the RAM disk used
- when CONFIG_EXAMPLES_MOUNT_DEVNAME is not defined. The
- default is zero (meaning that "/dev/ram0" will be used).
+ * CONFIG_EXAMPLES_PIPE_STACKSIZE
+ Sets the size of the stack to use when creating the child tasks.
+ The default size is 1024.
examples/romfs
^^^^^^^^^^^^^^
@@ -78,18 +111,17 @@ examples/romfs
* CONFIG_EXAMPLES_ROMFS_MOUNTPOINT
The location to mount the ROM disk. Deafault: "/usr/local/share"
-examples/null
-^^^^^^^^^^^^^
+examples/serloop
+^^^^^^^^^^^^^^^^
- This is the do nothing application. It is only used for bringing
- up new NuttX architectures.
+ This is a mindlessly simple loopback test on the console. Useful
+ for testing new serial drivers.
-examples/hello
-^^^^^^^^^^^^^^
+examples/udp
+^^^^^^^^^^^^
- This is the mandatory, "Hello, World!!" example. It is little more
- than examples/null with a single printf statement. Again useful only
- for bringing up new NuttX architectures.
+ This is a simple network test for verifying client- and server-
+ functionality over UDP.
examples/uip
^^^^^^^^^^^^
@@ -98,32 +130,6 @@ examples/uip
conditionally compiled logic to exercise the uIP webserver,
webclient, telnet, smtp, dncpc, and resolver.
-examples/netttest
-^^^^^^^^^^^^^^^^^
-
- This is a simple network test for verifying client- and server-
- functionality in a TCP/IP connection.
-
-examples/udp
-^^^^^^^^^^^^
-
- This is a simple network test for verifying client- and server-
- functionality over UDP.
-
-examples/pashello
-^^^^^^^^^^^^^^^^^
-
- This is "Hello, World" implemented via the Pascal P-Code interpreter
-
-examples/pipe
-^^^^^^^^^^^^^
-
- A test of the mkfifo() and pipe() APIs.
-
- * CONFIG_EXAMPLES_PIPE_STACKSIZE
- Sets the size of the stack to use when creating the child tasks.
- The default size is 1024.
-
examples/usbserial
^^^^^^^^^^^^^^^^^^