Re: Guide to PostgreSQL source tree

----- Original Message ----- 
From: Gavin Sherry <swm@linuxworld.com.au>
Sent: Sunday, August 19, 2001 3:40 AM


> Hi all,
> 
> For a few months now I've been thinking about whether or not a guide
> ('line-by-line') to the Postgres source tree would be of any value. 

[snip] 

> So, what do people think?

Such a guide would be nice to have handy as a reference, but how 
are you going to keep up with frequent code changes
and the new code added? Keeping this thing up-to-date
is an enormous effort even if you're not the only
one involved.

And what's wrong in automated guide generation? Like
if put specially formatted comments (responsibility of the author of the piece) 
for the guide in the source, and run through the source tree
your guide generator from time to time (like on every beta, RC, and release perhaps?).
This way the guide maintenance will be much easier, but the quality will solely
depend on comments supplied by the author.

My two Canadian cents.

Serguei