Date: Mon, 22 May 2006 10:18:25 +0200 From: Alexander Leidinger <Alexander@Leidinger.net> To: gnn@neville-neil.com Cc: src-committers@freebsd.org, cvs-src@freebsd.org, cvs-all@freebsd.org, Poul-Henning Kamp <phk@phk.freebsd.dk>, Julian Elischer <julian@elischer.org>, hellmuth.michaelis@t-online.de Subject: doxygen target (was: Re: cvs commit: src Makefile.inc1 ObsoleteFiles.inc src/etc/defaults rc.conf src/etc/mtree BSD.usr.dist src/etc/rc.d Makefile isdnd pcvt syscons src/release/picobsd/build picobsd src/share/man/man4 Makefile atkbd.4 kbdmux.4 pcvt.4 splash.4 vkbd.4 ...) Message-ID: <20060522101825.adfzv59y1eogwocs@netchild.homeip.net> In-Reply-To: <m2fyj3f3re.wl%gnn@neville-neil.com> References: <200605181516.15541.hm@kts.org> <39318.1147960050@critter.freebsd.dk> <m2ejyrl0gd.wl%gnn@neville-neil.com> <20060519143116.9iuvd81es0g0owkc@netchild.homeip.net> <m2fyj3f3re.wl%gnn@neville-neil.com>
next in thread | previous in thread | raw e-mail | index | archive | help
Quoting gnn@neville-neil.com (from Sun, 21 May 2006 14:48:37 -0700): > At Fri, 19 May 2006 14:31:16 +0200, > Alexander Leidinger wrote: >> >> Quoting "George V. Neville-Neil" <gnn@neville-neil.com> (from Thu, 18 >> May 2006 10:14:26 -0700): >> >> > I so hate to chime in on this thread, but I really think we need to >> > start putting things into the code and using Doxygen, or a moral >> > equivalent, to at least have a chance of keeping such things up to >> > date. Someone a while back set up a proper Doxygen file for use with >> > FreeBSD and we might simply pursue that tack. >> >> http://www.leidinger.net/FreeBSD/src_docs/ >> http://www.leidinger.net/FreeBSD/FreeBSD-Dox.tar.bz2 >> >> Feel free to send/suggest further subsystems/improvements. > > The one thing I'd like to suggest is that this be made part of the > tree with an optional make target. How should we go about doing that? We already have a doxygen config file in the tree, it covers the =20 entire kernel. But I think my approach of generating docs for =20 subsystems instead of the entire kernel may be more easy to understand =20 for people which want to understand a part of the kernel. Regarding the make target, do you think about "cd /usr/src; make =20 doxygen" or about "cd /usr/src/<mumble>; make doxygen"? The targets in the .tar.bz2 generate a HTML version too. Currently the =20 HTML version is around 300 MB, and it only covers a small part of the =20 kernel. Shall the HTML version also be generated (not available =20 online)? What about the destination, where do you want the HTML =20 version and/or the PDF version (needs pdflatex as a build tool) to be =20 placed (I can't come up with a good destination)? The HTML version is =20 generated by doxygen directly, the PDF needs to be generated from the =20 latex version, so in case of the PDF version it would make sense to =20 have a "doxygen" and "doxygeninstall" target, but not for the HTML =20 version (except you want to generate everything in OBJDIR and then do =20 a copy to the destination). Yes, I'm asking bikeshed questions... but only because I can't think =20 of a good answer myself ATM. Bye, Alexander. --=20 Selling GoodYear Eagle F1 235/40ZR18, 2x 4mm + 2x 5mm, ~150 EUR you have to pick it up between Germany/Saarland and Luxembourg/Capellen http://www.Leidinger.net Alexander @ Leidinger.net: PGP ID =3D B0063FE7 http://www.FreeBSD.org netchild @ FreeBSD.org : PGP ID =3D 72077137
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20060522101825.adfzv59y1eogwocs>