mysql-proxy-discuss team mailing list archive

[Jan Kneschke <jan@xxxxxxxxxxx>]

Kay Röpke wrote:
> Hi Jan!

To all,

we have a ongoing project to make it easier to everyone to jump into the
proxy's code-base. This is the perfect place for everyone to get hands
on the code: run the "make docs" as described below and read through the
docs and ask question, send improvements ... The goal is that everyone
can understand the proxy code.

> I've added some make targets to produce the Doxygen output and also
> tweaked the output slightly (mostly so it correctly sees through the
> NETWORK_MYSQLD_PLUGIN_PROTO macros and generates more readable
> documentation).
> Currently it doesn't check for doxygen in autoconf, and you need
> doxygen/dot/mscgen in your path.
> 
> I've also enabled the call/caller graphs, so producing the docs takes a
> bit longer, but is much more useful.
> 
> make distcheck passes again, too, there were .log files laying around in
> tests/suite/, no idea why I haven't seen them before - they are nuked
> now when you make clean.
> 
> The docs targets are:
> 
> make docs
> and
> make docs-bzr
> 
> The latter will use a little script to gather useful information from
> the branch you are in (branch nick, revno and date of last commit).
> Both docs targets will use $(PACKAGE_VERSION) from autotools to set the
> correct doxygen PROJECT_NUMBER - less likely to forget it in the future
> this way :)
> 
> cheers,
> -k


cheers,
  Jan
-- 
 jan: "Gee, Brain^WEric, what'd you wanna do tonight?"
eric: Same thing we do everynight: Take over the HelloWorld!