From cdfb48dac61ed0bedaef26817ba48b37bac2d75c Mon Sep 17 00:00:00 2001 From: patacongo Date: Sat, 8 Sep 2007 15:26:55 +0000 Subject: [PATCH] Documentation update git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@333 42af7a65-404d-4744-a932-0658087f49c3 --- ChangeLog | 2 + Documentation/NuttX.html | 3 +- Documentation/NuttxPortingGuide.html | 65 +++- Documentation/NuttxUserGuide.html | 538 ++++++++++++++++++++++++++- net/bind.c | 8 +- net/connect.c | 12 +- net/recvfrom.c | 2 +- netutils/README | 2 +- 8 files changed, 595 insertions(+), 37 deletions(-) diff --git a/ChangeLog b/ChangeLog index 45713cb170..41cdae7574 100644 --- a/ChangeLog +++ b/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. + diff --git a/Documentation/NuttX.html b/Documentation/NuttX.html index 1f21193459..bd511e9407 100644 --- a/Documentation/NuttX.html +++ b/Documentation/NuttX.html @@ -8,7 +8,7 @@

NuttX RTOS

-

Last Updated: July 2, 2007

+

Last Updated: September 8, 2007

@@ -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. diff --git a/Documentation/NuttxPortingGuide.html b/Documentation/NuttxPortingGuide.html index 03e76cd079..5b83352329 100644 --- a/Documentation/NuttxPortingGuide.html +++ b/Documentation/NuttxPortingGuide.html @@ -16,7 +16,7 @@

by

Gregory Nutt

-

Last Update: May 26, 2007

+

Last Update: September 8, 2007

Table of Contents

@@ -46,9 +46,11 @@
  • 2.7 include/
  • 2.8 lib/
  • 2.9 mm/
    • -
  • 2.10 sched/
    • -
  • 2.11 tools/
    • -
  • 2.12 Makefile
    • +
  • 2.10 net
    • +
  • 2.11 netutils
    • +
  • 2.12 sched/
    • +
  • 2.13 tools/
    • +
  • 2.14 Makefile
  • 3.0 Configuring and Building
  • @@ -612,7 +613,7 @@ Compatible with the POSIX interface of the same name.

    Returned Values: On success, sched_setparam() returns 0 (OK). - On error, -1 (ERROR) is returned, and errno is set appropriately. + On error, -1 (ERROR) is returned, anderrnois set appropriately.

    • + + + + +
    +
  • bind
  • clock_getres
  • clock_gettime
  • Clocks
  • clock_settime
    • +
  • connect
  • Data structures
  • Directory operations
  • Driver operations
  • exit
  • Filesystem interfaces
  • getpid
    • +
  • getsockopt
  • gmtime_r
  • Introduction
  • kill
    • @@ -5997,6 +6498,7 @@ notify a task when a message is available on a queue.
  • mq_timedreceive
  • mq_timedsend
  • mq_unlink
    • +
  • Network Interfaces
  • OS Interfaces
  • Pthread Interfaces
  • pthread_attr_destroy
    • @@ -6040,6 +6542,8 @@ notify a task when a message is available on a queue.
  • pthread_mutexattr_setpshared
  • pthread_mutex_destroy
  • pthread_mutex_init
    • +
  • pthread_mutex_lock
  • pthread_mutex_trylock
  • pthread_mutex_unlock
    • @@ -6052,6 +6556,8 @@ notify a task when a message is available on a queue.
  • pthread_sigmask
  • pthread_testcancelstate
  • pthread_yield
    • +
  • recv
    • +
  • recvfrom
  • sched_getparam
  • sched_get_priority_max
  • sched_get_priority_min
    • @@ -6073,6 +6579,9 @@ notify a task when a message is available on a queue.
  • sem_unlink
  • sem_wait
  • sched_getscheduler
    • +
  • send
    • +
  • sendto
    • +
  • setsockopt
  • sigaction
  • sigaddset
  • sigdelset
    • @@ -6086,6 +6595,7 @@ notify a task when a message is available on a queue.
  • sigsuspend
  • sigtimedwait
  • sigwaitinfo
    • +
  • socket
  • Standard I/O
  • task_activate
  • Task Control Interfaces @@ -6107,7 +6617,9 @@ notify a task when a message is available on a queue.
  • wd_delete
  • wd_gettime
  • wd_start
    • - +
    diff --git a/net/bind.c b/net/bind.c index 97ff479b4e..118d1d82f4 100644 --- a/net/bind.c +++ b/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 diff --git a/net/connect.c b/net/connect.c index bbc112f19d..32f962ec09 100644 --- a/net/connect.c +++ b/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 diff --git a/net/recvfrom.c b/net/recvfrom.c index ac1f5f2bb0..735f767f17 100644 --- a/net/recvfrom.c +++ b/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. diff --git a/netutils/README b/netutils/README index 9f6969b5f1..443b0636e5 100644 --- a/netutils/README +++ b/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." \ No newline at end of file +As the uIP apps/README says, these applications "are not all heavily tested."