From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 7538 invoked from network); 24 Nov 2004 20:10:36 +0000 Received: from smtp.gentoo.org (156.56.111.197) by lists.gentoo.org with AES256-SHA encrypted SMTP; 24 Nov 2004 20:10:36 +0000 Received: from lists.gentoo.org ([156.56.111.196] helo=parrot.gentoo.org) by smtp.gentoo.org with esmtp (Exim 4.41) id 1CX3TI-000521-Gf for arch-gentoo-dev@lists.gentoo.org; Wed, 24 Nov 2004 20:10:36 +0000 Received: (qmail 26507 invoked by uid 89); 24 Nov 2004 20:10:35 +0000 Mailing-List: contact gentoo-dev-help@gentoo.org; run by ezmlm Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-dev@gentoo.org Received: (qmail 25514 invoked from network); 24 Nov 2004 20:10:35 +0000 From: Benjamin Schindler To: gentoo-dev@lists.gentoo.org In-Reply-To: <46059ce104112315265d557064@mail.gmail.com> References: <200411222345.14487.vapier@gentoo.org> <3908185A3D2C144E9FAD070D2727FFD81716A9@PERIMAIL.perimed.priv> <921ad39e04112306381595bc8a@mail.gmail.com> <1049C878-3D68-11D9-9250-000A958238BC@gentoo.org> <1101226835.9000.39.camel@cgianelloni.nuvox.net> <46059ce104112315265d557064@mail.gmail.com> Content-Type: text/plain Organization: Gentoo Foundation Date: Wed, 24 Nov 2004 21:10:14 +0100 Message-Id: <1101327015.9848.5.camel@io> Mime-Version: 1.0 X-Mailer: Evolution 2.0.2 Content-Transfer-Encoding: 7bit X-OriginalArrivalTime: 24 Nov 2004 20:10:34.0273 (UTC) FILETIME=[A7D68110:01C4D261] Subject: Re: [gentoo-dev] Gentoo beeping at me! X-Archives-Salt: d6c734d9-42ab-4be8-9fc7-177f0f11676e X-Archives-Hash: cdd18c7cc9f3bc4a79886e04e1b04c5d I've got to throw an idea in here.... How about a doxygen-style documentation? No, it doesn't have to be doxygen, but I'm thinking of this idea. Instead of looking at every eclass, why not have some standard-format documentation in an eclass itself and let a tool create the documentation in whichever format he wishes to do so. Just my 2 cents... On Tue, 2004-11-23 at 18:26 -0500, Dan Meltzer wrote: > Uhh... to stick my head in... > > I'd be willing to write up some documentation for the various > eclasses, what format would you like them in? man-page style or what? > > > On Tue, 23 Nov 2004 11:20:35 -0500, Chris Gianelloni > wrote: > > On Tue, 2004-11-23 at 10:55 -0500, Hasan Khalil wrote: > > > AFAIK, there is no user documentation for most eclasses' options, > > > including this one. That's the whole problem IMO. > > > > > > But maybe that's just my opinion and it's not shared with anyone else, > > > in which case this message should be disregarded. > > > > Like I say any time a dev mentions anything about a lack of > > documentation... > > > > There will be some as soon as you write it! > > > > *grin* > > > > I will admit that I am pretty bad about documentation myself, so it is > > definitely something that we all need to work on improving. > > > > -- > > Chris Gianelloni > > Release Engineering - Operational/QA Manager > > Games - Developer > > Gentoo Linux > > > > > > > > -- > gentoo-dev@gentoo.org mailing list > > -- Benjamin Schindler Gentoo Foundation -- gentoo-dev@gentoo.org mailing list