Gentoo Archives: gentoo-dev

From: Benjamin Schindler <config@g.o>
To: gentoo-dev@l.g.o
Subject: Re: [gentoo-dev] Gentoo beeping at me!
Date: Wed, 24 Nov 2004 20:10:36
Message-Id: 1101327015.9848.5.camel@io
In Reply to: Re: [gentoo-dev] Gentoo beeping at me! by Dan Meltzer
1 I've got to throw an idea in here.... How about a doxygen-style
2 documentation? No, it doesn't have to be doxygen, but I'm thinking of
3 this idea. Instead of looking at every eclass, why not have some
4 standard-format documentation in an eclass itself and let a tool create
5 the documentation in whichever format he wishes to do so.
6 Just my 2 cents...
7 On Tue, 2004-11-23 at 18:26 -0500, Dan Meltzer wrote:
8 > Uhh... to stick my head in...
9 >
10 > I'd be willing to write up some documentation for the various
11 > eclasses, what format would you like them in? man-page style or what?
12 >
13 >
14 > On Tue, 23 Nov 2004 11:20:35 -0500, Chris Gianelloni
15 > <wolf31o2@g.o> wrote:
16 > > On Tue, 2004-11-23 at 10:55 -0500, Hasan Khalil wrote:
17 > > > AFAIK, there is no user documentation for most eclasses' options,
18 > > > including this one. That's the whole problem IMO.
19 > > >
20 > > > But maybe that's just my opinion and it's not shared with anyone else,
21 > > > in which case this message should be disregarded.
22 > >
23 > > Like I say any time a dev mentions anything about a lack of
24 > > documentation...
25 > >
26 > > There will be some as soon as you write it!
27 > >
28 > > *grin*
29 > >
30 > > I will admit that I am pretty bad about documentation myself, so it is
31 > > definitely something that we all need to work on improving.
32 > >
33 > > --
34 > > Chris Gianelloni
35 > > Release Engineering - Operational/QA Manager
36 > > Games - Developer
37 > > Gentoo Linux
38 > >
39 > >
40 > >
41 >
42 > --
43 > gentoo-dev@g.o mailing list
44 >
45 >
46 --
47 Benjamin Schindler <config@g.o>
48 Gentoo Foundation
49
50
51 --
52 gentoo-dev@g.o mailing list

Replies

Subject Author
Re: [gentoo-dev] Gentoo beeping at me! Georgi Georgiev <chutz@×××.net>