Re: Interface Stability (was Re: xxx-undocumented.txt)

[Damon Chaplin <damon karuna uklinux net>]

On Tue, 2005-02-15 at 20:12, Brian Cameron wrote:
> Damon:
> 
> On February 4th I send the following email with attached 2-line patch
> that adds "@stability" to the section docs in the source code.  I
> notice this hasn't made it into CVS head and wanted to remind you
> to consider including this as well.  I think it's pretty much the
> last piece needed to support stability levels in gtk-doc.

It's in cvs now.

> Also, in previous emails I suggested that it probably makes sense
> to put default definitions of the three stability levels (Stable,
> Unstable and Private) somewhere.  Perhaps on the web, perhaps as a
> part of the generated gtk-docs.  This way people can look up the
> default meanings of the interface levels.  Haven't gotten any
> response about whether people agree this is a good idea or not.
> Perhaps this isn't the right list.  If it makes the most sense to
> put this sort of information somewhere on developer.gnome.org,
> what would be the right alias to discuss this?

I think the stability levels should be described in the docs somewhere.

I think the easiest thing to do is to add a section to the GLib docs
describing each stability level, and link to those throughout the docs.
It does mean relying on the GLib docs being installed for the links to
be available, but I think that's OK.

If you want to open a bug and put the descriptions in it, that would be
a start.

Damon