--------------------- PatchSet 5207 Date: 2007/08/09 06:25:19 Author: amosjeffries Branch: docs Tag: (none) Log: Pull more component descriptions into code. Members: doc/Programming-Guide/03_MajorComponents.dox:1.1.2.4->1.1.2.5 doc/Programming-Guide/ExternalPrograms.dox:1.1.2.1->1.1.2.2 src/dnsserver.cc:1.9.14.4->1.9.14.5 src/unlinkd_daemon.cc:1.2.18.2->1.2.18.3 Index: squid3/doc/Programming-Guide/03_MajorComponents.dox =================================================================== RCS file: /cvsroot/squid-sf//squid3/doc/Programming-Guide/Attic/03_MajorComponents.dox,v retrieving revision 1.1.2.4 retrieving revision 1.1.2.5 diff -u -r1.1.2.4 -r1.1.2.5 --- squid3/doc/Programming-Guide/03_MajorComponents.dox 9 Aug 2007 05:48:32 -0000 1.1.2.4 +++ squid3/doc/Programming-Guide/03_MajorComponents.dox 9 Aug 2007 06:25:19 -0000 1.1.2.5 @@ -1,5 +1,7 @@ /** -\page 03_MajorComponents Overview of Squid Components +\ingroup Component + +\section Overview of Squid Components \par Squid consists of the following major components Index: squid3/doc/Programming-Guide/ExternalPrograms.dox =================================================================== RCS file: /cvsroot/squid-sf//squid3/doc/Programming-Guide/Attic/ExternalPrograms.dox,v retrieving revision 1.1.2.1 retrieving revision 1.1.2.2 diff -u -r1.1.2.1 -r1.1.2.2 --- squid3/doc/Programming-Guide/ExternalPrograms.dox 9 Aug 2007 05:40:25 -0000 1.1.2.1 +++ squid3/doc/Programming-Guide/ExternalPrograms.dox 9 Aug 2007 06:25:19 -0000 1.1.2.2 @@ -1,18 +1,6 @@ /** \defgroup ExternalPrograms External Programs -\section dnsserver dnsserver -\par - Because the standard getaddrinfo() and getnameinfo() library calls - block, Squid must use external processes to actually make - these calls. Typically there will be ten dnsserver - processes spawned from Squid. Communication occurs via - TCP sockets bound to the loopback interface. The functions - in dns.cc are primarily concerned with starting and - stopping the dnsservers. Reading and writing to and from - the dnsservers occurs in the \link IPCache IP\endlink and - \link FQDNCache FQDN\endlink cache modules. - \section pinger pinger \par Although it would be possible for Squid to send and receive @@ -32,11 +20,4 @@ changed) URLs on stdout. It is implemented as an external process to maximize flexibility. -\section unlinkd unlinkd -\par - The unlink(2) system call can cause a process to block - for a significant amount of time. Therefore we do not want - to make unlink() calls from Squid. Instead we pass them - to this external process. - */ Index: squid3/src/dnsserver.cc =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/dnsserver.cc,v retrieving revision 1.9.14.4 retrieving revision 1.9.14.5 diff -u -r1.9.14.4 -r1.9.14.5 --- squid3/src/dnsserver.cc 9 Aug 2007 05:38:36 -0000 1.9.14.4 +++ squid3/src/dnsserver.cc 9 Aug 2007 06:25:19 -0000 1.9.14.5 @@ -1,6 +1,6 @@ /* - * $Id: dnsserver.cc,v 1.9.14.4 2007/08/09 05:38:36 amosjeffries Exp $ + * $Id: dnsserver.cc,v 1.9.14.5 2007/08/09 06:25:19 amosjeffries Exp $ * * DEBUG: section 0 DNS Resolver * AUTHOR: Harvest Derived @@ -33,11 +33,6 @@ * */ -/** - * \defgroup dnsserver dnsserver - * \ingroup ExternalPrograms - */ - #include "config.h" #if HAVE_UNISTD_H @@ -147,11 +142,38 @@ #include "util.h" #include "snprintf.h" +/** + \defgroup dnsserver dnsserver + \ingroup ExternalPrograms + \par + Because the standard gethostbyname() library call + blocks, Squid must use external processes to actually make + these calls. Typically there will be ten dnsserver + processes spawned from Squid. Communication occurs via + TCP sockets bound to the loopback interface. The functions + in dns.cc are primarily concerned with starting and + stopping the dnsservers. Reading and writing to and from + the dnsservers occurs in the \link IPCache IP\endlink and + \link FQDNCache FQDN\endlink cache modules. + + \section dnsserverInterface Command Line Interface + \verbatim +usage: dnsserver -Dhv -s nameserver + -D Enable resolver RES_DEFNAMES and RES_DNSRCH options + -h Help + -v Version + -s nameserver Specify alternate name server(s). 'nameserver' + must be an IP address, -s option may be repeated + \endverbatim + */ + #if !defined(_SQUID_AIX_) && !defined(_SQUID_MSWIN_) +/// \ingroup dnsserver extern int h_errno; #endif #if LIBRESOLV_DNS_TTL_HACK +/// \ingroup dnsserver extern int _dns_ttl_; /* this is a really *dirty* hack - bne */ #endif @@ -161,7 +183,9 @@ * WARNING: This hack queries only the resolver and not NetInfo or YP */ +/// \ingroup dnsserver struct hostent *_res_gethostbyname(char *name); +/// \ingroup dnsserver #define gethostbyname _res_gethostbyname #endif /* _SQUID_NEXT_ */ @@ -187,6 +211,7 @@ return (char *)"Unknown DNS problem"; } +/// \ingroup dnsserver #define REQ_SZ 512 /** @@ -273,16 +298,7 @@ } /** - \interface dnsserver "dnsserver.cc" \ingroup dnsserver - \verbatim -usage: dnsserver -Dhv -s nameserver - -D Enable resolver RES_DEFNAMES and RES_DNSRCH options - -h Help - -v Version - -s nameserver Specify alternate name server(s). 'nameserver' - must be an IP address, -s option may be repeated - \endverbatim */ static void usage(void) Index: squid3/src/unlinkd_daemon.cc =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/unlinkd_daemon.cc,v retrieving revision 1.2.18.2 retrieving revision 1.2.18.3 diff -u -r1.2.18.2 -r1.2.18.3 --- squid3/src/unlinkd_daemon.cc 12 Jul 2007 06:07:13 -0000 1.2.18.2 +++ squid3/src/unlinkd_daemon.cc 9 Aug 2007 06:25:19 -0000 1.2.18.3 @@ -1,6 +1,6 @@ /* - * $Id: unlinkd_daemon.cc,v 1.2.18.2 2007/07/12 06:07:13 amosjeffries Exp $ + * $Id: unlinkd_daemon.cc,v 1.2.18.3 2007/08/09 06:25:19 amosjeffries Exp $ * * DEBUG: - Unlink Daemon * AUTHOR: Duane Wessels @@ -37,30 +37,35 @@ #include "squid.h" -#define UNLINK_BUF_LEN 1024 - /** - * \defgroup unlinkd unlinkd - * \ingroup ExternalPrograms + \defgroup unlinkd unlinkd + \ingroup ExternalPrograms + \par + The unlink(2) system call can cause a process to block + for a significant amount of time. Therefore we do not want + to make unlink() calls from Squid. Instead we pass them + to this external process. */ +/// \ingroup unlinkd +#define UNLINK_BUF_LEN 1024 + /** - * \interface unlinkd "unlinkd_daemon.cc" - * \ingroup unlinkd - * \par This is the unlinkd external process. + \ingroup unlinkd + \par This is the unlinkd external process. * - * \par + \par * unlinkd receives the full path of any files to be removed * from stdin, each on its own line. * - * \par - * the results for each file are printed to stdout in the order + \par + * The results for each file are printed to stdout in the order * they were received * - * \param argc Ignored. - * \param argv Ignored. - * \retval ERR An error occured removing the file. - * \retval OK The file has been removed. + \param argc Ignored. + \param argv Ignored. + \retval ERR An error occured removing the file. + \retval OK The file has been removed. */ int main(int argc, char *argv[])