Fix to athttpd docs

Fix to athttpd docs

[Øyvind Harboe]

[-- Attachment #1: Type: text/plain, Size: 158 bytes --]

Minor doc fix. It's nice if the two line example works as copied and pasted :-)

-- 
Øyvind Harboe
http://www.zylin.com - eCos ARM & FPGA  developer kit

[-- Attachment #2: docfix.txt --]
[-- Type: text/plain, Size: 2621 bytes --]

### Eclipse Workspace Patch 1.0
#P ecos
Index: net/athttpd/current/doc/athttpd.sgml
===================================================================
RCS file: /cvs/ecos/ecos-opt/net/net/athttpd/current/doc/athttpd.sgml,v
retrieving revision 1.4
diff -u -r1.4 athttpd.sgml
--- net/athttpd/current/doc/athttpd.sgml	27 Nov 2006 15:41:56 -0000	1.4
+++ net/athttpd/current/doc/athttpd.sgml	12 Nov 2007 10:46:26 -0000
@@ -146,11 +146,12 @@
 url_string       : a string with the extension url that will be appended to the
                    default directory.
 callback         : a function with a prototype:
-                   cyg_int32 callback_function(CYG_HTTPS_STATE*);
+                   cyg_int32 callback_function(CYG_HTTPD_STATE*); 
+                   Return value is ignored - just return 0.
 </programlisting></para>
 
 <para>
-<command>CYG_HTTPS_STATE*</command> is a pointer to a structure that
+<command>CYG_HTTPD_STATE*</command> is a pointer to a structure that
 contains, among others, a buffer (outbuffer) that can be used to send data
 out. The definitions of the structure is in http.h.</para>
 
@@ -167,7 +168,7 @@
 and somewhere in the source tree there is a function:</para>
 
 <programlisting>
-cyg_int32 myForm(CYG_HTTPS_STATE* p)
+cyg_int32 myForm(CYG_HTTPD_STATE* p)
 {
    cyg_httpd_start_chunked("html");
    strcpy(p->outbuffer, "eCos Web Server");
@@ -276,11 +277,11 @@
 and tries to execute a function inside the library with the following prototype:
 </para>
 
-<programlisting width=72>void exec_cgi(CYG_HTTPS_STATE *)
+<programlisting width=72>void exec_cgi(CYG_HTTPD_STATE *)
 </programlisting>
 
 <para>
-The pointer <command>CYG_HTTPS_STATE*</command> gives access to the socket 
+The pointer <command>CYG_HTTPD_STATE*</command> gives access to the socket 
 data: The user will use this pointer to access the 'outbuffer' and use it to
 copy data to send data out.
 </para>
Index: net/athttpd/current/ChangeLog
===================================================================
RCS file: /cvs/ecos/ecos-opt/net/net/athttpd/current/ChangeLog,v
retrieving revision 1.6
diff -u -r1.6 ChangeLog
--- net/athttpd/current/ChangeLog	4 Dec 2006 20:35:30 -0000	1.6
+++ net/athttpd/current/ChangeLog	12 Nov 2007 10:46:26 -0000
@@ -1,3 +1,8 @@
+2007-11-12  Oyvind Harboe  <oyvind.harboe@zylin.com>
+
+	* doc/athttpd.cdl: Fixed typos in doc. Return value from handler is not 
+	used, recommend returning 0 in doc.
+
 2006-12-03  Anthony Tonizzo  <atonizzo@gmail.com>
 
 	* cdl/httpd.cdl: Corrected a CDL error in the requirements of

Re: Fix to athttpd docs

[Jonathan Larmour]

Øyvind Harboe wrote:
> Minor doc fix. It's nice if the two line example works as copied and pasted :-)

Perfect. Applied, thanks.

Jifl
-- 
eCosCentric Limited      http://www.eCosCentric.com/     The eCos experts
Barnwell House, Barnwell Drive, Cambridge, UK.       Tel: +44 1223 245571
Registered in England and Wales: Reg No 4422071.
------["Si fractum non sit, noli id reficere"]------       Opinions==mine