Documentation update

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@333 42af7a65-404d-4744-a932-0658087f49c3

ChangeLog

@@ -208,3 +208,5 @@
 	* Added send() and sendto(); integrate write() and close() with socket descriptors.
         * Added recv() and recvfrom().
 	* Added getsockopt() and setsockopt()
+	* Documentation updated to address socket interfaces.
+

Documentation/NuttX.html

@@ -8,7 +8,7 @@
   <tr align="center" bgcolor="#e4e4e4">
     <td>
       <h1><big><font color="#3c34ec"><i>NuttX RTOS</i></font></big></h1>
-      <p>Last Updated: July 2, 2007</p>
+      <p>Last Updated: September 8, 2007</p>
     </td>
   </tr>
 </table>
@@ -641,6 +641,7 @@ Other memory:
 	* Added send() and sendto(); integrate write() and close() with socket descriptors.
         * Added recv() and recvfrom().
 	* Added getsockopt() and setsockopt()
+	* Documentation updated to address socket interfaces.
 </pre></ul>
 
 <table width ="100%">

Documentation/NuttxPortingGuide.html

@@ -16,7 +16,7 @@
   </b></big>
   <p><small>by</small></p>
   <p>Gregory Nutt</p>
-  <p><small>Last Update: May 26, 2007</small></p>
+  <p><small>Last Update: September 8, 2007</small></p>
 </center>
 
 <center><h1>Table of Contents</h1></center>
@@ -46,9 +46,11 @@
   <li><a href="#DirStructInclude">2.7 include/</a></li>
   <li><a href="#DirStructLib">2.8 lib/</a></li>
   <li><a href="#DirStructMm">2.9 mm/</a></li>
-  <li><a href="#DirStructSched">2.10 sched/</a></li>
-  <li><a href="#DirStructTools">2.11 tools/</a></li>
-  <li><a href="#topmakefile">2.12 Makefile</a></li>
+  <li><a href="#DirStructNet">2.10 net</a></li>
+  <li><a href="#DirStructNetUtils">2.11 netutils</a></li>
+  <li><a href="#DirStructSched">2.12 sched/</a></li>
+  <li><a href="#DirStructTools">2.13 tools/</a></li>
+  <li><a href="#topmakefile">2.14 Makefile</a></li>
 </ul>
 <li><a href="#configandbuild">3.0 Configuring and Building</a></li>
 <ul>
@@ -139,8 +141,8 @@
 |   |   |  `-- <i>(board-specific source files)</i>
 |   |   `-- <i>(board-specific configuration files)</i>
 |   `-- <i>&lt;other-boards&gt;</i>/
-|-- <a href="#DirStructDrivers">drivers</a>
-|   |-- Makefile/
+|-- <a href="#DirStructDrivers">drivers</a>/
+|   |-- Makefile
 |   `-- <i>(common driver source files)</i>
 |-- <a href="#DirStructExamples">examples</a>/
 |   `-- <i>(example)</i>/
@@ -148,9 +150,16 @@
 |       `-- <i>(example source files)</i>
 |-- <a href="#DirStructFs">fs</a>/
 |   |-- Makefile
-|   `-- <i>(fs source files)</i>
+|   `-- <i>(common file system source files)</i>
 |-- <a href="#DirStructInclude">include</a>/
 |   |-- <i>(standard header files)</i>
+|   |-- arpa/
+|   |   `-- <i>(standard header files)</i>
+|   |-- net/
+|   |   `-- uip/
+|   |       `-- <i>(uIP specific header files)</i>
+|   |-- netinet/
+|   |   `-- <i>(standard header files)</i>
 |   |-- nuttx/
 |   |   `-- <i>(nuttx specific header files)</i>
 |   `- sys/
@@ -160,7 +169,29 @@
 |   `-- <i>(lib source files)</i>
 |-- <a href="#DirStructMm">mm</a>/
 |   |-- Makefile
-|   `-- <i>(mm source files)</i>
+|   `-- <i>(memory management source files)</i>
+|-- <a href="#DirStructNet">net</a>/
+|   |-- Makefile
+|   |-- uip/
+|   |   `-- <i>(uip source files)</i>
+|   `-- <i>(socket source files)</i>
+|-- <a href="#DirStructNetUtils">netutils</a>/
+|   |-- dhcp/
+|   |   `-- <i>(dhcp source files)</i>
+|   |-- resolv/
+|   |   `-- <i>(resolv source files)</i>
+|   |-- smtp/
+|   |   `-- <i>(smtp source files)</i>
+|   |-- telnetd/
+|   |   `-- <i>(telnetd source files)</i>
+|   |-- uiplib/
+|   |   `-- <i>(uiplib source files)</i>
+|   |-- weblclient/
+|   |   `-- <i>(webclient source files)</i>
+|   |-- webserver/
+|   |   `-- <i>(webserver source files)</i>
+|   |-- Makefile
+|   `-- <i>(fs source files)</i>
 |-- <a href="#DirStructSched">sched</a>/
 |   |-- Makefile
 |   `-- <i>(sched source files)</i>
@@ -604,18 +635,30 @@
   This is the NuttX memory manager.
 </p>
 
-<h2>2.10 <a name="DirStructSched">sched</a></h2>
+<h2>2.10 <a name="DirStructNet">net</a></h2>
+<p>
+  This directory contains the implementation of the socket APIs.
+  The subdirectory, <code>uip</code> contians the uIP port.
+</P>
+
+<h2>2.11 <a name="DirStructNetUtils">netutils</a></h2>
+<p>
+  This directory contains most of the network applications contained under the uIP-1.0 apps directory.
+  As the uIP apps/README says, these applications "are not all heavily tested."
+</p>
+
+<h2>2.12 <a name="DirStructSched">sched</a></h2>
 <p>
   The files forming core of the NuttX RTOS reside here.
 </p>
 
-<h2>2.11 <a name="DirStructTools">tools</a></h2>
+<h2>2.13 <a name="DirStructTools">tools</a></h2>
 <p>
   This directory holds a collection of tools and scripts to simplify
   configuring and building NuttX.
 </p>
 
-<h2>2.12 <a name="topmakefile">Makefile</a></h2>
+<h2>2.14 <a name="topmakefile">Makefile</a></h2>
 <p>
   The top-level <code>Makefile</code> in the <code>${TOPDIR}</code> directory contains all of the top-level control
   logic to build NuttX.

net/bind.c

@@ -54,15 +54,15 @@
  * Function: bind
  *
  * Description:
- *   bind() gives the socket sockfd the local address my_addr. my_addr is
- *   addrlen bytes long. Traditionally, this is called “assigning a name to
- *   a socket.” When a socket is created with socket(2), it exists in a name
+ *   bind() gives the socket 'sockfd' the local address 'addr'. 'addr' is
+ *   'addrlen' bytes long. Traditionally, this is called “assigning a name to
+ *   a socket.” When a socket is created with socket, it exists in a name
  *   space (address family) but has no name assigned.
  *
  * Parameters:
  *   sockfd   Socket descriptor from socket
  *   addr     Socket local address
- *   addrlen  Length of my_addr
+ *   addrlen  Length of 'addr'
  *
  * Returned Value:
  *   0 on success; -1 on error with errno set appropriately

net/connect.c

@@ -55,15 +55,15 @@
  *
  * Description:
  *   connect() connects the socket referred to by the file descriptor sockfd
- *   to the address specified by serv_addr. The addrlen argument specifies
- *   the size of serv_addr.  The format of the address in serv_addr is
+ *   to the address specified by 'addr'. The addrlen argument specifies
+ *   the size of 'addr'.  The format of the address in 'addr' is
  *   determined by the address space of the socket sockfd.
  *
- *   If the socket sockfd is of type SOCK_DGRAM then serv_addr is the address
+ *   If the socket sockfd is of type SOCK_DGRAM then 'addr' is the address
  *   to which datagrams are sent by default, and the only address from which
  *   datagrams are received. If the socket is of type SOCK_STREAM or
  *   SOCK_SEQPACKET, this call attempts to make a connection to the socket
- *   that is bound to the address specified by serv_addr.
+ *   that is bound to the address specified by 'addr'.
  *
  *   Generally, connection-based protocol sockets may successfully connect()
  *   only once; connectionless protocol sockets may use connect() multiple
@@ -73,8 +73,8 @@
  *
  * Parameters:
  *   sockfd    Socket descriptor returned by socket()
- *   serv_addr Server address (form depends on type of socket)
- *   addrlen   Lenght of actual serv_addr
+ *   addr      Server address (form depends on type of socket)
+ *   addrlen   Length of actual 'addr'
  *
  * Returned Value:
  *   0 on success; -1 on error with errno set appropriately

net/recvfrom.c

@@ -152,7 +152,7 @@ void recvfrom_interrupt(void *private)
  *   EINVAL
  *     Invalid argument passed.
  *   ENOMEM
- *     Could not allocate memory for recvmsg().
+ *     Could not allocate memory.
  *   ENOTCONN
  *     The socket is associated with a connection-oriented protocol and has
  *     not been connected.

netutils/README

@@ -2,4 +2,4 @@ netutils
 ^^^^^^^^
 
 This directory contains most of the network applications contained under the uIP-1.0 apps directory.
-As the uIP apps/README says, there applications "are not all heavily tested."
+As the uIP apps/README says, these applications "are not all heavily tested."