Dai­ly doxy­gen gen­er­at­ed docs of the FreeB­SD ker­nel (head)

I man­aged to get some time to set­up an auto­mat­ed gen­er­a­tion of the doxy­gen docs for ker­nel sub­sys­tems of FreeB­SD on my webserver.

Every night/morning (Ger­man time­zone) the sources will be updat­ed, and the docs get regen­er­at­ed (this takes some time). Cur­rent­ly this depends upon some patch­es to the make­file and doxy­gen con­fig files in tools/kerneldoc/subsys. Every­thing is gen­er­at­ed direct­ly in the place where the web­serv­er will look for to deliv­er 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­serv­er and do not mir­ror this. You can gen­er­ate this your­self very easy. Assum­ing you have the FreeB­SD 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 FreeB­SD sources and every­thing will be OK), apply the patch, cd into tools/kerneldoc/subsys and run “make all” (or “make vm” or what­ev­er you are inter­est­ed in). You need doxy­gen installed, off course.

If you want to set­up 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­i­ty to host it on FreeBSD.org resources.

2 thoughts on “Dai­ly doxy­gen gen­er­at­ed docs of the FreeB­SD ker­nel (head)”

  1. vg says:

    This is great. Is it pos­si­ble for you to push these doc­gen gen­er­at­ed files to a github gh_pages repos­i­to­ry every­day, instead of host­ing it here, It will save you space and band­width on your server. 

    And hav­ing it on github means we can go back in time and see past files. That way we can see the state of the code last month or some­thing like that.

    1. netchild says:

      Space and band­width are not a prob­lem. Every­one can put it up on github. You just need the FreeB­SD source and doxygen.

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.