public inbox for gentoo-dev@lists.gentoo.org
 help / color / mirror / Atom feed
From: Benjamin Schindler <config@gentoo.org>
To: gentoo-dev@lists.gentoo.org
Subject: Re: [gentoo-dev] Gentoo beeping at me!
Date: Wed, 24 Nov 2004 21:10:14 +0100	[thread overview]
Message-ID: <1101327015.9848.5.camel@io> (raw)
In-Reply-To: <46059ce104112315265d557064@mail.gmail.com>

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
> <wolf31o2@gentoo.org> 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 <config@gentoo.org>
Gentoo Foundation


--
gentoo-dev@gentoo.org mailing list


  parent reply	other threads:[~2004-11-24 20:10 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2004-11-23  1:43 [gentoo-dev] Gentoo beeping at me! Roman Gaufman
2004-11-23  1:51 ` Mike Frysinger
     [not found]   ` <E86D9DE1-3D06-11D9-A6F4-000A95D3E704@gentoo.org>
2004-11-23  4:33     ` Mike Frysinger
2004-11-23  4:38       ` Lina Pezzella
2004-11-23  4:45         ` Mike Frysinger
2004-11-23  7:38           ` Daniel Armyr
2004-11-23  8:14             ` Ciaran McCreesh
2004-11-23 14:38             ` Roman Gaufman
2004-11-23 15:55               ` Hasan Khalil
2004-11-23 16:09                 ` Ciaran McCreesh
2004-11-24 10:14                   ` Aaron Walker
2004-11-23 16:20                 ` Chris Gianelloni
2004-11-23 23:26                   ` Dan Meltzer
2004-11-24  2:15                     ` Chris Gianelloni
2004-11-24 10:08                       ` Aaron Walker
     [not found]                       ` <46059ce1041123200452e69415@mail.gmail.com>
2004-11-24 13:44                         ` Chris Gianelloni
2004-11-24 20:10                     ` Benjamin Schindler [this message]
2004-11-25  9:44                       ` Georgi Georgiev
2004-11-25 19:19                         ` Ed Grimm
2004-11-25 20:02                           ` Ciaran McCreesh
2004-11-26  2:25                           ` Georgi Georgiev
2004-11-26 10:17                             ` Ciaran McCreesh
2004-11-26 18:03                               ` Georgi Georgiev
2004-11-26 18:45                                 ` Dan Meltzer
2004-11-26 19:17                                   ` Ciaran McCreesh
2004-11-26 23:55                                 ` Ed Grimm

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1101327015.9848.5.camel@io \
    --to=config@gentoo.org \
    --cc=gentoo-dev@lists.gentoo.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox