warning fix

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

diff --git a/wxPython/docs/BUILD.txt b/wxPython/docs/BUILD.txt
index 7d9700ba8c041f4d69b82755b6ae237e199d1901..85d25f0dda8c5efd9a6cdbaf5036828320034d20 100644 (file)
--- a/wxPython/docs/BUILD.txt
+++ b/wxPython/docs/BUILD.txt
@@ -5,7 +5,7 @@ This file describes how I build wxWidgets and wxPython while doing
 development and testing, and is meant to help other people that want
 to do the same thing.  I'll assume that you are using either a CVS
 snapshot from http://wxWidgets.org/snapshots/, a checkout from CVS, or
 development and testing, and is meant to help other people that want
 to do the same thing.  I'll assume that you are using either a CVS
 snapshot from http://wxWidgets.org/snapshots/, a checkout from CVS, or

-one of the released wxPythonSrc-2.5.* tarballs.  I'll also assume that
+one of the released wxPython-src-2.5.* tarballs.  I'll also assume that

 you know your way around your system, the compiler, etc. and most
 importantly, that you know what you are doing!  ;-)
 
 you know your way around your system, the compiler, etc. and most
 importantly, that you know what you are doing!  ;-)
 


@@ -21,31 +21,31 @@ may already have installed.
 .. _INSTALL: INSTALL.html
 .. _BUILD: BUILD.html
 
 .. _INSTALL: INSTALL.html
 .. _BUILD: BUILD.html
 

-If you want to make changes to any of the ``*.i`` files, (SWIG interface
-definition files,) or to regenerate the extension sources or renamer
-modules, then you will need an up to date version of SWIG.  Either get
-and build the current CVS version, or version 1.3.20, and then apply
-the patches in wxPython/SWIG.  See the README.txt in that dir for
-details about each patch and also info about those that may already
-have been applied to the SWIG sources.  If you install this build of
-SWIG to a location that is not on the PATH (so it doesn't interfere
-with an existing SWIG install for example) then you can set a setup.py
-command-line variable named SWIG to be the full path name of the
-executable and the wxPython build will use it.  See below for an
-example.
+If you want to make changes to any of the ``*.i`` files, (SWIG
+interface definition files,) or to regenerate the extension sources or
+renamer modules, then you will need an up to date version of SWIG,
+plus some patches.  Get the sources for version 1.3.22, and then apply
+the patches in wxPython/SWIG and then build SWIG like normal.  See the
+README.txt in the wxPython/SWIG dir for details about each patch and
+also info about those that may already have been applied to the SWIG
+sources.  If you install this build of SWIG to a location that is not
+on the PATH (so it doesn't interfere with an existing SWIG install for
+example) then you can set a setup.py command-line variable named SWIG
+to be the full path name of the executable and the wxPython build will
+use it.  See below for an example.

 
 In the text below I'll use WXDIR with environment variable syntax
 
 In the text below I'll use WXDIR with environment variable syntax

-(either $WXDIR or %WXDIR%) to refer to the top level directory were
+(either $WXDIR or %WXDIR%) to refer to the top level directory where

 your wxWidgerts and wxPython sources are located.  It will equate to
 whereever you checked out the wxWidgets module from CVS, or untarred
 your wxWidgerts and wxPython sources are located.  It will equate to
 whereever you checked out the wxWidgets module from CVS, or untarred

-the wxPythonSrc tarball to.  You can either substitute the $WXDIR text
+the wxPython-src tarball to.  You can either substitute the $WXDIR text

 below with your actual dir, or set the value in the environment and
 use it just like you see it below.
 
 If you run into what appears to be compatibility issues between
 wxWidgets and wxPython while building wxPython, be sure you are using
 below with your actual dir, or set the value in the environment and
 use it just like you see it below.
 
 If you run into what appears to be compatibility issues between
 wxWidgets and wxPython while building wxPython, be sure you are using

-the wxWidgets sources included with the wxPythonSrc tarball or the CVS
-snapshot, and not a previously installed version or a version
+the wxWidgets sources included with the wxPython-src tarball or the
+CVS snapshot, and not a previously installed version or a version

 installed from one of the standard wxWidgets installers.  With the
 "unstable" releases (have a odd-numbered minor release value, where
 the APIs are allowed to change) there are often significant
 installed from one of the standard wxWidgets installers.  With the
 "unstable" releases (have a odd-numbered minor release value, where
 the APIs are allowed to change) there are often significant


@@ -77,7 +77,6 @@ place, then do the same for wxPython.
          ../configure --prefix=/opt/wx/2.5 \
                       --with-gtk \
                       --with-opengl \
          ../configure --prefix=/opt/wx/2.5 \
                       --with-gtk \
                       --with-opengl \

-                      --disable-monolithic \

                       --enable-debug \
                       --enable-geometry \
                       --enable-sound --with-sdl \
                       --enable-debug \
                       --enable-geometry \
                       --enable-sound --with-sdl \


@@ -85,9 +84,31 @@ place, then do the same for wxPython.
                       
 
    On OS X of course you'll want to use --with-mac instead of
                       
 
    On OS X of course you'll want to use --with-mac instead of

-   --with-gtk.  For GTK2 and unicode add::
+   --with-gtk.  
+
+   **NOTE**: Due to a recent change there is currently a dependency
+   problem in the multilib builds of wxWidgets on OSX, so I have
+   switched to using a monolithic build.  That means that all of the
+   core wxWidgets code is placed in in one shared library instead of
+   several.  wxPython can be used with either mode, so use whatever
+   suits you on Linux and etc. but use monolithic on OSX.  To switch
+   to the monolithic build of wxWidgets just add this configure flag::
+
+                    --enable-monolithic \
+
+   By default GTK2 will be selected if its development pacakge is
+   installed on your build system.  To force the use of GTK 1.2.x
+   instead add this flag::
+
+                     --disable-gtk2 \
+
+   To make the wxWidgets build be unicode enabled (strongly
+   recommended if you are building with GTK2) then add the following.
+   When wxPython is unicode enabled then all strings that are passed
+   to wx functions and methods will first be converted to unicode
+   objects, and any 'strings' returned from wx functions and methods
+   will actually be unicode objects.::

                          
                          

-                      --enable-gtk2 \

                       --enable-unicode \
 
    Notice that I used a prefix of /opt/wx/2.5.  You can use whatever
                       --enable-unicode \
 
    Notice that I used a prefix of /opt/wx/2.5.  You can use whatever


@@ -115,14 +136,13 @@ place, then do the same for wxPython.
    command but there are other libraries besides the main wxWidgets
    libs that also need to be built so again I make a script to do it
    all for me so I don't forget anything.  This time it is called
    command but there are other libraries besides the main wxWidgets
    libs that also need to be built so again I make a script to do it
    all for me so I don't forget anything.  This time it is called

-   ".make" (I use the leading ".  so when I do ``rm -r *`` in my build
+   ".make" (I use the leading "."  so when I do ``rm -r *`` in my build

    dir I don't lose my scripts too.)  This is what it looks like::
 
         make $* \
             && make -C contrib/src/gizmos $* \
             && make -C contrib/src/ogl CXXFLAGS="-DwxUSE_DEPRECATED=0" $* \
    dir I don't lose my scripts too.)  This is what it looks like::
 
         make $* \
             && make -C contrib/src/gizmos $* \
             && make -C contrib/src/ogl CXXFLAGS="-DwxUSE_DEPRECATED=0" $* \

-            && make -C contrib/src/stc $* \
-            && make -C contrib/src/xrc $* 
+            && make -C contrib/src/stc $* 

    
    So you just use .make as if it where make, but don't forget to set
    the execute bit on .make first!::
    
    So you just use .make as if it where make, but don't forget to set
    the execute bit on .make first!::


@@ -168,10 +188,17 @@ place, then do the same for wxPython.
 
          WX_CONFIG=/opt/wx/2.5/bin/wx-config
 
 
          WX_CONFIG=/opt/wx/2.5/bin/wx-config
 

-   If you are building with GTK2 then add the following flags to the
-   command line::
+   By default setup.py will assume that you built wxWidgets to use
+   GTK2.  If you built wxWidgets to use GTK 1.2.x then you should add
+   this flag to the command-line::

 
 

-         WXPORT=gtk2 UNICODE=1
+        WXPORT=gtk 
+
+   If you would like to do a Unicode enabled build (all strings sent
+   to or retruned from wx functions are Unicode objects) and your
+   wxWidgets was built with unicode enabled then add this flag::
+
+         UNICODE=1

 
    If you are wanting to have the source files regenerated with swig,
    then you need to turn on the USE_SWIG flag and optionally tell it
 
    If you are wanting to have the source files regenerated with swig,
    then you need to turn on the USE_SWIG flag and optionally tell it


@@ -227,7 +254,7 @@ compilers) can also be used but I've never done the work to make that
 happen.  If you want to try that then first you'll want to find out if
 there are any tricks that have to be done to make Python extension
 modules using that compiler, and then make a few changes to setup.py
 happen.  If you want to try that then first you'll want to find out if
 there are any tricks that have to be done to make Python extension
 modules using that compiler, and then make a few changes to setup.py

-to accomodate that.  (And send the patches to me.)  If you plan on
+to accommodate that.  (And send the patches to me.)  If you plan on

 using VisualStudio.Net (a.k.a. MSVC 7.1) keep in mind that you'll also
 have to build Python and any other extension modules that you use with
 that compiler because a different version of the C runtime library is
 using VisualStudio.Net (a.k.a. MSVC 7.1) keep in mind that you'll also
 have to build Python and any other extension modules that you use with
 that compiler because a different version of the C runtime library is


@@ -245,6 +272,13 @@ of the code with the debugger then building the normal (or hybrid)
 version is fine, and you can use the regular python executables with
 it.
 
 version is fine, and you can use the regular python executables with
 it.
 

+Starting with 2.5.3.0 wxPython can be built for either the monlithic
+or the multi-lib wxWidgets builds.  (Monolithic means that all the
+core wxWidgets code is in one DLL, and multi-lib means that the core
+code is divided into multiple DLLs.)  To select which one to use
+specify the MONOLITHIC flag for both the wxWidgets build and the
+wxPython build as shown below, setting it to either 0 or 1.
+

 Just like the unix versions I also use some scripts to help me build
 wxWidgets, but I use some non-standard stuff to do it.  So if you have
 bash (cygwin or probably MSYS too) or 4NT plus unix-like cat and sed
 Just like the unix versions I also use some scripts to help me build
 wxWidgets, but I use some non-standard stuff to do it.  So if you have
 bash (cygwin or probably MSYS too) or 4NT plus unix-like cat and sed


@@ -338,7 +372,7 @@ accordingly if you are using the bash shell.
    executing nmake with a bunch of extra command line parameters.
    The base set are::
 
    executing nmake with a bunch of extra command line parameters.
    The base set are::
 

-       -f makefile.vc OFFICIAL_BUILD=1 SHARED=1 MONOLITHIC=0 USE_OPENGL=1
+       -f makefile.vc OFFICIAL_BUILD=1 SHARED=1 MONOLITHIC=1 USE_OPENGL=1

 
    If doing a debug build then add::
 
 
    If doing a debug build then add::
 


@@ -358,7 +392,6 @@ accordingly if you are using the bash shell.
    contrib libraries::
 
        %WXDIR%\contrib\build\gizmos
    contrib libraries::
 
        %WXDIR%\contrib\build\gizmos

-       %WXDIR%\contrib\build\xrc

        %WXDIR%\contrib\build\stc
        %WXDIR%\contrib\build\ogl
 
        %WXDIR%\contrib\build\stc
        %WXDIR%\contrib\build\ogl
 


@@ -381,10 +414,11 @@ accordingly if you are using the bash shell.
 
    Change to the %WXDIR%\\wxPython dir and run the this command,
    making sure that you use the version of python that you want to
 
    Change to the %WXDIR%\\wxPython dir and run the this command,
    making sure that you use the version of python that you want to

-   build for (if you have more than one on your system)::
+   build for (if you have more than one on your system) and to match
+   the MONOLITHIC flag with how you built wxWidgets::

 
          cd %WXDIR%\wxPython
 
          cd %WXDIR%\wxPython

-         python setup.py build_ext --inplace 
+         python setup.py build_ext --inplace MONOLITHIC=1

 
    If you are wanting to have the source files regenerated with swig,
    then you need to turn on the USE_SWIG flag and optionally tell it
 
    If you are wanting to have the source files regenerated with swig,
    then you need to turn on the USE_SWIG flag and optionally tell it