From owner-freebsd-hackers@FreeBSD.ORG Mon Jul 14 09:15:34 2008 Return-Path: Delivered-To: freebsd-hackers@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 0035D1065670 for ; Mon, 14 Jul 2008 09:15:33 +0000 (UTC) (envelope-from alexander@leidinger.net) Received: from redbull.bpaserver.net (redbullneu.bpaserver.net [213.198.78.217]) by mx1.freebsd.org (Postfix) with ESMTP id 87D9E8FC1D for ; Mon, 14 Jul 2008 09:15:33 +0000 (UTC) (envelope-from alexander@leidinger.net) Received: from outgoing.leidinger.net (p54A567AD.dip.t-dialin.net [84.165.103.173]) by redbull.bpaserver.net (Postfix) with ESMTP id 58F102E0A4; Mon, 14 Jul 2008 11:15:26 +0200 (CEST) Received: from webmail.leidinger.net (webmail.leidinger.net [192.168.1.102]) by outgoing.leidinger.net (Postfix) with ESMTP id 9166A136076; Mon, 14 Jul 2008 11:15:14 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=Leidinger.net; s=outgoing-alex; t=1216026914; bh=2rNzsf3D/b0sQEj4nzxbGFQjOGr3Qvek+ CMS01Ful9Y=; h=Message-ID:Date:From:To:Cc:Subject:References: In-Reply-To:MIME-Version:Content-Type:Content-Transfer-Encoding; b=gKRTYAc/JdpNHnvhoULh7sY+k9eBRs/uxUiL5HTZ3ZVleqSOnbPNNRr6pMygXPKA7 tpy1NA4wPunZgG+GwgmoC9ruUFBLhfAmQi7baEmAG2Dmm5RxOi4EjlBIV655aSP4n5O gzh5OYHBQ1j6JBoVAYJ95nhN66E9tAHyObV+M1tOm+LHco4TRHu4zuDMwtqGf5kQxP5 nBpNLm9JGtVlXe1aHqFU8rmMYIQcNhf1m+yTs+XgUG79NcBKXiC+wMDBiyEVrdt0MBw JRbTwqmaFaSbnSsstncnxTHPEcB5VBNY6U01tJQxeZZD/x/Aujw9/RWH2YsgRXctvM5 E/Ko1OtnA== Received: (from www@localhost) by webmail.leidinger.net (8.14.2/8.13.8/Submit) id m6E9FEeW039874; Mon, 14 Jul 2008 11:15:14 +0200 (CEST) (envelope-from Alexander@Leidinger.net) Received: from pslux.cec.eu.int (pslux.cec.eu.int [158.169.9.14]) by webmail.leidinger.net (Horde Framework) with HTTP; Mon, 14 Jul 2008 11:15:14 +0200 Message-ID: <20080714111514.3394138okvgiq42o@webmail.leidinger.net> X-Priority: 3 (Normal) Date: Mon, 14 Jul 2008 11:15:14 +0200 From: Alexander Leidinger To: Mel References: <200807111517.54399.fbsd.hackers@rachie.is-a-geek.net> In-Reply-To: <200807111517.54399.fbsd.hackers@rachie.is-a-geek.net> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8; DelSp="Yes"; format="flowed" Content-Disposition: inline Content-Transfer-Encoding: quoted-printable User-Agent: Internet Messaging Program (IMP) H3 (4.2-RC2) / FreeBSD-8.0 X-BPAnet-MailScanner-Information: Please contact the ISP for more information X-BPAnet-MailScanner: Found to be clean X-BPAnet-MailScanner-SpamCheck: not spam, ORDB-RBL, SpamAssassin (not cached, score=-12.904, required 6, BAYES_00 -15.00, DKIM_SIGNED 0.00, DKIM_VERIFIED -0.00, J_CHICKENPOX_46 0.60, MIME_QP_LONG_LINE 1.40, RDNS_DYNAMIC 0.10) X-BPAnet-MailScanner-From: alexander@leidinger.net X-Spam-Status: No X-Mailman-Approved-At: Mon, 14 Jul 2008 12:00:12 +0000 Cc: freebsd-hackers@freebsd.org Subject: Re: Kernel API docs ('make doxygen') X-BeenThere: freebsd-hackers@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Technical Discussions relating to FreeBSD List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 14 Jul 2008 09:15:34 -0000 Quoting Mel (from Fri, 11 Jul 2008 =20 15:17:54 +0200): > I was wondering if this project is considered obsolete, finished or work i= n > progress. I would say it's in the "it has to prove it's usefulness"-stage. This =20 means not all people are convinced it is useful to have such stuff in =20 our source and someone needs to sit down and do something good to a =20 subsystem to show that it is useful to those people. > If it's the latter, I'm happy to do the legwork, like set up proper stubs = for > each function and structure that people who really know how they work can I think some people would complain if this would be committed to our =20 version control system without consent, and without those stubs being =20 there I don't expect that the stubs get converted to proper docs. So =20 giving advice to just go ahead may be a waste. > adjust. There's a lot already in there with normal comments, that can beco= me > documentation by simply adding an extra asterisk. Decide for yourself if you are willing to invest your time to convert =20 the existing docs in the source into doxygen docs. In =20 src/tools/kerneldoc/subsys/ is already a framework to handle the =20 doxygen stuff per subsystem (not all subsystems are done there). It =20 would be most beneficial to start with one of the subsystems which are =20 already available there. In case you want to play around there, send =20 me a mail and I try to get some time to commit some fixes. In case you =20 are interested to work on a subsystem which is not represented there, =20 you can email me too (but it should be easy to copy&modify an existing =20 file). But again, no guarantees that any changes to the source get's =20 committed. Bye, Alexander. --=20 Beware of a tall black man with one blond shoe. http://www.Leidinger.net Alexander @ Leidinger.net: PGP ID =3D B0063FE7 http://www.FreeBSD.org netchild @ FreeBSD.org : PGP ID =3D 72077137