Alexander Leidinger

Just another weblog

Aug
14

Daily doxy­gen gen­er­ated docs of the FreeBSD ker­nel (head)

I man­aged to get some time to setup an auto­mated gen­er­a­tion of the doxy­gen docs for ker­nel sub­sys­tems of FreeBSD on my web­server.

Every night/morning (Ger­man time­zone) the sources will be updated, and the docs get regen­er­ated (this takes some time). Cur­rently this depends upon some patches to the make­file and doxy­gen con­fig files in tools/kerneldoc/subsys. Every­thing is gen­er­ated directly in the place where the web­server will look for to deliver the pages, so if you browse this in the mid­dle of the gen­er­a­tion, the con­tent may not be con­sis­tent (yet).

Please be nice to the web­server and do not mir­ror this. You can gen­er­ate this your­self very easy. Assum­ing you have the FreeBSD source on a local hard disk, you just need to down­load the patch from http://www.Leidinger.net/FreeBSD/current-patches/ (if you do not find dox.diff, update your FreeBSD sources and every­thing will be OK), apply the patch, cd into tools/kerneldoc/subsys and run “make all” (or “make vm” or what­ever you are inter­ested in). You need doxy­gen installed, off course.

If you want to setup some­thing like this your­self, just down­load the script which is doing all the work, change some vari­ables in the begin­ning, and cre­ate your own local ver­sion of the com­plete docs.

In case this is using sig­nif­i­cant traf­fic, I will ask core/admins if there is the pos­si­bil­ity to host it on FreeBSD.org resources.

GD Star Rat­ing
load­ing…
GD Star Rat­ing
load­ing…
Share

Tags: , , , , , , , , ,