Towards the end of this email is a list of the man pages which remain unclaimed, and need people to volunteer to document. Please sign up by file name instead of by API name. A number of the man pages contain multiple API's, example: $TOP/aolserver/doc/ns_sock.n.
Also, please make sure you are working from the aolserver_v35_bp branch. We need to get the docs completed for 3.5, then we will tackle 4.0. The goal is to have all of the documentation complete for the 3.6 release, which should be ready early December.
To find out what still needs to be documented:
1. Check out the 3.5 code: cvs co -raolserver_v35_bp aolserver
2. Take a look in $TOP/aolserver/doc for man page files:
- To find which file a particular API is contained within:
- grep <API_NAME> $TOP/aolserver/doc/*
- You may need to create a new man page file if one does not exist:
- <API_NAME>.n = Tcl API's
- <API_NAME>.3 = C API's
3. Check the "Tasks" area on SourceForge to see what's already been taken:
- http://sourceforge.net/pm/task.php?group_project_id=7196&group_id=3152&func=browse
4. Add a new task for the man page file, or send email to [EMAIL PROTECTED] or [EMAIL PROTECTED] with the name of the file and we'll add it for you
5. Once complete, either CVS commit the update to the aolserver_v35_bp, or send the documentation file directly to [EMAIL PROTECTED] or [EMAIL PROTECTED], and we'll commit it for you.
There's been a fair amount of discussion about various ways and formats to use for the documentation. At this point it is more important to simply get the documentation complete and up to date. Therefore the decision was made to go with roff man pages, which is the route the Tcl folks took as well.
Thanks again to everyone who has signed up!
- Nathan
Tcl:
ns_addr.n
ns_at.n
ns_cache.n
ns_checkurl.n
ns_crash.n
ns_env.n
ns_img.n
ns_kill.n
ns_library.n
ns_markfordelete.n
ns_module.n
ns_modulepath.n
ns_parseheader.n
ns_parsequery.n
ns_purgefiles.n
ns_rollfile.n
ns_share.n
ns_shutdown.n
ns_sleep.n
ns_tmp.n
ns_uuencode.n
ns_writefp.n
Binary:
nsd.1
C:
Ns_Adp.3
Ns_Alloc.3
Ns_Auth.3
Ns_Cache.3
Ns_Cond.3
Ns_Config.3
Ns_Conn.3
Ns_ConnCopy.3
Ns_ConnDriver.3
Ns_ConnHeaders.3
Ns_ConnRead.3
Ns_ConnRequest.3
Ns_ConnReturn.3
Ns_ConnSend.3
Ns_ConnWrite.3
Ns_CritSec.3
Ns_DString.3
Ns_Db.3
Ns_DbDriver.3
Ns_DbPool.3
Ns_DbSp.3
Ns_DbUtil.3
Ns_Driver.3
Ns_Encrypt.3
Ns_Exec.3
Ns_ExtDb.3
Ns_Fd.3
Ns_Fetch.3
Ns_Filter.3
Ns_HttpTime.3
Ns_Htuu.3
Ns_Index.3
Ns_InetAddr.3
Ns_Info.3
Ns_IntPrint.3
Ns_List.3
Ns_Location.3
Ns_Log.3
Ns_Master.3
Ns_Mime.3
Ns_Module.3
Ns_Mutex.3
Ns_Nsd.3
Ns_Pathname.3
Ns_Pool.3
Ns_ProcInfo.3
Ns_QuoteHtml.3
Ns_RWLock.3
Ns_Rand.3
Ns_Reentrant.3
Ns_Register.3
Ns_Request.3
Ns_RollFile.3
Ns_Sched.3
Ns_Sema.3
Ns_ServerSpecific.3
Ns_Set.3
Ns_Signal.3
Ns_Sock.3
Ns_SockCallback.3
Ns_SockErrno.3
Ns_SockIO.3
Ns_String.3
Ns_TclConn.3
Ns_TclDbGetHandle.3
Ns_TclFile.3
Ns_TclInit.3
Ns_TclInterp.3
Ns_TclRegister.3
Ns_TclSet.3
Ns_TclThread.3
Ns_Thread.3
Ns_Thread2.3
Ns_ThreadAlloc.3
Ns_Time.3
Ns_Tls.3
Ns_Uid.3
Ns_Url.3
Ns_UrlEncode.3
Ns_UrlSpecific.3
Ns_UrlToFile.3
