Re: Squid programming guide

On Mon, 2006-08-21 at 12:57 +0200, Henrik Nordstrom wrote:
> mån 2006-08-21 klockan 11:25 +0200 skrev Kinkie:
> > - consider the wiki as the master copy, and possibly include in the
> > sources a DocBooc-rendered version of the contents. This would maximize
> > the chance of non-core contributors adding to it, as it has started
> > happening with the FAQ.
>
> One comment regarding the FAQ. I find the WIKI version significantly
> harder to navigate. Mainly due to the missing expanded table of
> contents. Basically one has to use the full text search to find
> anything, all the time..

The expanded TOC is now available as
http://wiki.squid-cache.org/SquidFaq/FaqIndex

It needs to be updated when new pages are added, but apart from that
it's self-maintaining.

> Regarding the programmers guide. This needs to be split in two parts to
> be manageable. The generic parts not closely related to the code, and
> reference material which should be inline in the source and extracted
> using doxygen if you ask me.

I can second that. We need to have guidelines for the coding style: do
you have anything in mind?

    Kinkie
Received on Mon Aug 21 2006 - 07:23:16 MDT