[Xapian-devel] Deprecation Policy

[James Aylett]

On Wed, Apr 11, 2007 at 02:06:36PM +0100, Olly Betts wrote:

> I think for now each release series will probably need to move to "no
> new features" mode as we prepare to move to the next (as 0.9 currently
> essentially is).  But this isn't something we need to nail down right
> now, and I'd rather focus on getting 1.0 released than be diverted into
> lengthy discussions of directions after that.

True. +0 on the idea, though, for the record.

> > > I think we should preserve the full documentation comments for
> > > removed methods here.
> > 
> > I think we should actually write more narrative "how to move from
> > 1.X.* to 1.X+1.0" documents. It shouldn't be difficult; it just needs
> > a little bit more structure than a dump of the replacement comments
> > for deprecated methods now removed.
> 
> There's a place for both - a narrative is useful for reading before
> migration, but when you type "make" on your application and it fails to
> find "Enquire::set_sorting()" then a table mapping "this old -> that new"
> is more helpful than paragraphs of prose.

Yeah, for lazy people who don't read the upgrade documentation :)

> My main point is that we shouldn't just delete the helpful comments
> I've added for each deprecated method as they are still going to be
> useful.

+1

J

-- 
/--------------------------------------------------------------------------\
  James Aylett                                                  xapian.org
  james at tartarus.org                               uncertaintydivision.org