lucene-java-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Lucene-java Wiki] Update of "BackwardsCompatibility" by Mark Miller
Date Wed, 09 Nov 2011 18:00:07 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Lucene-java Wiki" for change notification.

The "BackwardsCompatibility" page has been changed by Mark Miller:
http://wiki.apache.org/lucene-java/BackwardsCompatibility?action=diff&rev1=10&rev2=11

  
  == APIs and Compilation ==
  
- Minor versions should always have complete back-compatiblity for supported (i.e. public
and protected). That's to say, any code developed against '''X.0''' should continue to run
without alteration and without recompilation (ie, simply drop in the new JAR) against all
'''X.N''' releases, as long as only supported APIs are used. Back compat breaks will be documented
in the "Changes in backwards compatibility policy" section of CHANGES. For major releases,
there should also be a migration guide.
+ Minor versions should always have back-compatiblity for supported APIs (i.e. public and
protected). That's to say, any code developed against '''X.0''' should continue to run without
alteration and without recompilation (ie, simply drop in the new JAR) against all '''X.N'''
releases, as long as only supported APIs are used. Special exception back compat breaks will
be documented in the "Changes in backwards compatibility policy" section of CHANGES. For major
releases, there should also be a migration guide to assist in migrating application code across
API breaks.
  
  A major release may introduce incompatible API and runtime changes.  Within minor versions,
the transition strategy is to introduce new APIs in release '''X.N''', deprecating old APIs,
then remove all deprecated APIs in release '''X+1.0'''. In some cases, especially with large
refactorings across major versions, there will be no deprecation path and you will need to
read CHANGES and a migration guide to migrate your code.
  

Mime
View raw message