'[1219035] cleanup: miscellaneous' and minor source cleaning.

[wxWidgets.git] / wxPython / docs / MigrationGuide.txt

diff --git a/wxPython/docs/MigrationGuide.txt b/wxPython/docs/MigrationGuide.txt
index b9156e62c25890e480f2579a210a1e489c621323..9dd3ca2c10bade2c30d3559351a9a8ede70eca58 100644 (file)
--- a/wxPython/docs/MigrationGuide.txt
+++ b/wxPython/docs/MigrationGuide.txt
@@ -1,9 +1,9 @@
 ============================
 ============================

-wxPython 2.5 Migration Guide
+wxPython 2.6 Migration Guide

 ============================
 
 This document will help explain some of the major changes in wxPython
 ============================
 
 This document will help explain some of the major changes in wxPython

-2.5 since the 2.4 series and let you know what you need to do to adapt
+2.6 since the 2.4 series and let you know what you need to do to adapt

 your programs to those changes.  Be sure to also check in the CHANGES_
 file like usual to see info about the not so major changes and other
 things that have been added to wxPython.
 your programs to those changes.  Be sure to also check in the CHANGES_
 file like usual to see info about the not so major changes and other
 things that have been added to wxPython.


@@ -339,8 +339,8 @@ Building, Extending and Embedding wxPython
 wxPython's setup.py script now expects to use existing libraries for
 the contribs (gizmos, stc, xrc, etc.) rather than building local
 copies of them.  If you build your own copies of wxPython please be
 wxPython's setup.py script now expects to use existing libraries for
 the contribs (gizmos, stc, xrc, etc.) rather than building local
 copies of them.  If you build your own copies of wxPython please be

-aware that you now need to also build the ogl, stc, xrc, and gizmos
-libraries in addition to the main wx lib.  
+aware that you now need to also build the stc, xrc, animate and gizmos
+libraries in addition to the main wx lib.

 
 The wxPython.h and other header files are now in
 .../wxPython/include/wx/wxPython instead of in wxPython/src.  You
 
 The wxPython.h and other header files are now in
 .../wxPython/include/wx/wxPython instead of in wxPython/src.  You


@@ -425,7 +425,10 @@ You should not use AddWindow, AddSizer, AddSpacer (and similar for
 Insert, Prepend, and etc.) methods any longer.  Just use Add and the
 wrappers will figure out what to do.  **[Changed in 2.5.2.x]**
 AddWindow, AddSizer, AddSpacer and etc. will now issue a
 Insert, Prepend, and etc.) methods any longer.  Just use Add and the
 wrappers will figure out what to do.  **[Changed in 2.5.2.x]**
 AddWindow, AddSizer, AddSpacer and etc. will now issue a

-DeprecationWarning. 
+DeprecationWarning. **[Changed in 2.5.4.x]** These methods have now
+been undeprecated at the request of Riaan Booysen, the Boa Constructor
+team lead.  They are now just simple compatibility aliases for Add,
+and etc.

 
 **[Changed in 2.5.2.x]** The Sizers have had some fundamental internal
 changes in the 2.5.2.x release intended to make them do more of the
 
 **[Changed in 2.5.2.x]** The Sizers have had some fundamental internal
 changes in the 2.5.2.x release intended to make them do more of the


@@ -688,19 +691,22 @@ OGL is dead! LONG LIVE OGL!
 
 **[Changed in 2.5.2.x]** 
 
 
 **[Changed in 2.5.2.x]** 
 

-The wx.ogl module has been deprecated in favor of the new Python port
-of the OGL library located at wx.lib.ogl contributed by Pierre Hjälm.
-This will hopefully greatly extend the life of OGL within wxPython by
-making it more easily maintainable and less prone to getting rusty as
-there seems to be less and less interest in maintaining the C++
-version.  
+The wx.ogl module was deprecated in version 2.5.2 in favor of the new
+Python port of the OGL library located at wx.lib.ogl contributed by
+Pierre Hjälm.  Starting in version 2.5.5 the old ogl is no longer
+being built in the distributed binaries, however the source code is
+still in the source tree so people can built it themselves if desired.
+
+The reason this changes was done was to greatly extend the life of OGL
+within wxPython by making it more easily maintainable and less prone
+to getting rusty as there seems to be less and less interest in
+maintaining the C++ version.

 
 There are only a few known compatibility issues at this time.  First
 
 There are only a few known compatibility issues at this time.  First

-is that the ogl.DrawnShape has not been reimplemented yet.  Next is the
-location of OGL.  The deprecated version is located in the wx.ogl
-module, and the new version is in the wx.lib.ogl package.  So this
-just means that to start using the new version you need to adjust your
-imports.  So if your code currently has something like this::
+is the location of OGL.  The old version was located in the
+wx.ogl module, and the new version is in the wx.lib.ogl package.  So
+this just means that to start using the new version you need to adjust
+your imports.  So if your code currently has something like this::

 
      import wx
      import wx.ogl as ogl
 
      import wx
      import wx.ogl as ogl


@@ -849,11 +855,11 @@ directly in site-packages.  This is done to help facilitate having
 multiple versions of wxPython installed side-by-side.  Why would you
 want to do this?  One possible scenario is you have an app that
 requires wxPython 2.4 but you want to use the newest 2.5 to do your
 multiple versions of wxPython installed side-by-side.  Why would you
 want to do this?  One possible scenario is you have an app that
 requires wxPython 2.4 but you want to use the newest 2.5 to do your

-development with.  Or perhaps you want to be able to test your app
+own development with.  Or perhaps you want to be able to test your app

 with several different versions of wxPython to ensure compatibility.
 Before everyone panics, rest asured that if you only install one
 with several different versions of wxPython to ensure compatibility.
 Before everyone panics, rest asured that if you only install one

-version of wxPython then you should notice no difference in how
-things work.
+version of wxPython then you should notice no difference in how things
+work.

 
 In addition to installing wxPython into a "versioned" subdirectory of
 site-packages, a file named `wx.pth` is optionally installed that will
 
 In addition to installing wxPython into a "versioned" subdirectory of
 site-packages, a file named `wx.pth` is optionally installed that will


@@ -874,10 +880,10 @@ runtime so your applications can select which version of wxPython they
 would like to to have imported.  You use it like this::
 
       import wxversion
 would like to to have imported.  You use it like this::
 
       import wxversion

-      wxversion.require("2.4")
+      wxversion.select("2.4")

       import wx
 
       import wx
 

-Then eventhough a 2.5 version of wxPython may be the default the
+Then even though a 2.5 version of wxPython may be the default the

 application that does the above the first time that wx is imported
 will actually get a 2.4 version.  **NOTE:** There isn't actually a 2.4
 version of wxPython that supports this, but there will be.
 application that does the above the first time that wx is imported
 will actually get a 2.4 version.  **NOTE:** There isn't actually a 2.4
 version of wxPython that supports this, but there will be.