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

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

diff --git a/wxPython/docs/BUILD.txt b/wxPython/docs/BUILD.txt
index 85d25f0dda8c5efd9a6cdbaf5036828320034d20..a65dfc43ca4cfe9e23e70d9531bf034ca90355a9 100644 (file)
--- a/wxPython/docs/BUILD.txt
+++ b/wxPython/docs/BUILD.txt
@@ -1,11 +1,11 @@
-Building wxPython 2.5 for Development and Testing
+Building wxPython 2.6 for Development and Testing

 =================================================
 
 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
 =================================================
 
 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

-one of the released wxPython-src-2.5.* tarballs.  I'll also assume that
+one of the released wxPython-src-2.6.* 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!  ;-)
 


@@ -24,7 +24,7 @@ may already have installed.
 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,
 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
+plus some patches.  Get the sources for version 1.3.24, 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
 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


@@ -36,7 +36,7 @@ use it.  See below for an example.
 
 In the text below I'll use WXDIR with environment variable syntax
 (either $WXDIR or %WXDIR%) to refer to the top level directory where
 
 In the text below I'll use WXDIR with environment variable syntax
 (either $WXDIR or %WXDIR%) to refer to the top level directory where

-your wxWidgerts and wxPython sources are located.  It will equate to
+your wxWidgets and wxPython sources are located.  It will equate to

 whereever you checked out the wxWidgets module from CVS, or untarred
 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
 whereever you checked out the wxWidgets module from CVS, or untarred
 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


@@ -71,20 +71,22 @@ place, then do the same for wxPython.
    rerun the script without having to remember the options I used
    before::
 
    rerun the script without having to remember the options I used
    before::
 

-        cd $WXDIR
+         cd $WXDIR

          mkdir bld
          cd bld
          mkdir bld
          cd bld

-         ../configure --prefix=/opt/wx/2.5 \
+         ../configure --prefix=/opt/wx/2.6 \

                       --with-gtk \
                       --with-gtk \

+                     --with-gnomeprint \

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

+                      --disable-debugreport \

                       
 
    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.  
+   --with-gtk and --with-gnomeprint.  

 
    **NOTE**: Due to a recent change there is currently a dependency
    problem in the multilib builds of wxWidgets on OSX, so I have
 
    **NOTE**: Due to a recent change there is currently a dependency
    problem in the multilib builds of wxWidgets on OSX, so I have


@@ -94,13 +96,13 @@ place, then do the same for wxPython.
    suits you on Linux and etc. but use monolithic on OSX.  To switch
    to the monolithic build of wxWidgets just add this configure flag::
 
    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 \
+                     --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::
+   By default GTK 2.x will be used for the build.  If you would rather
+   use GTK 1.2.x for some reason then you can force configure to use
+   it by changing the --with-gtk flag to specify it like this::

 
 

-                     --disable-gtk2 \
+                      --with-gtk=1 \

 
    To make the wxWidgets build be unicode enabled (strongly
    recommended if you are building with GTK2) then add the following.
 
    To make the wxWidgets build be unicode enabled (strongly
    recommended if you are building with GTK2) then add the following.


@@ -111,14 +113,14 @@ place, then do the same for wxPython.
                          
                       --enable-unicode \
 
                          
                       --enable-unicode \
 

-   Notice that I used a prefix of /opt/wx/2.5.  You can use whatever
+   Notice that I used a prefix of /opt/wx/2.6.  You can use whatever

    path you want, such as a path in your HOME dir or even one of the
    standard prefix paths such as /usr or /usr/local if you like, but
    using /opt this way lets me easily have multiple versions and ports
    of wxWidgets "installed" and makes it easy to switch between them,
    without impacting any versions of wxWidgets that may have been
    installed via an RPM or whatever.  For the rest of the steps below
    path you want, such as a path in your HOME dir or even one of the
    standard prefix paths such as /usr or /usr/local if you like, but
    using /opt this way lets me easily have multiple versions and ports
    of wxWidgets "installed" and makes it easy to switch between them,
    without impacting any versions of wxWidgets that may have been
    installed via an RPM or whatever.  For the rest of the steps below

-   be sure to also substitute "/opt/wx/2.5" with whatever prefix you
+   be sure to also substitute "/opt/wx/2.6" with whatever prefix you

    choose for your build.
 
    If you want to use the image and zlib libraries included with
    choose for your build.
 
    If you want to use the image and zlib libraries included with


@@ -140,8 +142,8 @@ place, then do the same for wxPython.
    dir I don't lose my scripts too.)  This is what it looks like::
 
         make $* \
    dir I don't lose my scripts too.)  This is what it looks like::
 
         make $* \

+            && make -C contrib/src/animate $* \

             && make -C contrib/src/gizmos $* \
             && make -C contrib/src/gizmos $* \

-            && make -C contrib/src/ogl CXXFLAGS="-DwxUSE_DEPRECATED=0" $* \

             && make -C contrib/src/stc $* 
    
    So you just use .make as if it where make, but don't forget to set
             && make -C contrib/src/stc $* 
    
    So you just use .make as if it where make, but don't forget to set


@@ -151,9 +153,9 @@ place, then do the same for wxPython.
          .make install
 
    When it's done you should have an installed set of files under
          .make install
 
    When it's done you should have an installed set of files under

-   /opt/wx/2.5 containing just wxWidgets.  Now to use this version of
-   wxWidgets you just need to add /opt/wx/2.5/bin to the PATH and set
-   LD_LIBRARY_PATH (or DYLD_LIBRARY_PATH on OS X) to /opt/wx/2.5/lib.
+   /opt/wx/2.6 containing just wxWidgets.  Now to use this version of
+   wxWidgets you just need to add /opt/wx/2.6/bin to the PATH and set
+   LD_LIBRARY_PATH (or DYLD_LIBRARY_PATH on OS X) to /opt/wx/2.6/lib.

 
 
 3. I also have a script to help me build wxPython and it is checked in
 
 
 3. I also have a script to help me build wxPython and it is checked in


@@ -186,13 +188,13 @@ place, then do the same for wxPython.
    other version of it found first, then you can add this to the
    command line to ensure your new one is used instead::
 
    other version of it found first, then you can add this to the
    command line to ensure your new one is used instead::
 

-         WX_CONFIG=/opt/wx/2.5/bin/wx-config
+         WX_CONFIG=/opt/wx/2.6/bin/wx-config

 
    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::
 
 
    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=gtk 
+         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
 
    If you would like to do a Unicode enabled build (all strings sent
    to or retruned from wx functions are Unicode objects) and your


@@ -221,7 +223,7 @@ place, then do the same for wxPython.
    PYTHONPATH to the wxPython dir located in the source tree.  For
    example::
 
    PYTHONPATH to the wxPython dir located in the source tree.  For
    example::
 

-        export LD_LIBRARY_PATH=/opt/wx/2.5/lib
+        export LD_LIBRARY_PATH=/opt/wx/2.6/lib

         export PYTHONPATH=$WXDIR/wxPython
         cd $WXDIR/wxPython/demo
         python2.3 demo.py
         export PYTHONPATH=$WXDIR/wxPython
         cd $WXDIR/wxPython/demo
         python2.3 demo.py


@@ -238,7 +240,7 @@ place, then do the same for wxPython.
    SOLARIS NOTE: If you get unresolved symbol errors when importing
    wxPython and you are running on Solaris and building with gcc, then
    you may be able to work around the problem by uncommenting a bit of
    SOLARIS NOTE: If you get unresolved symbol errors when importing
    wxPython and you are running on Solaris and building with gcc, then
    you may be able to work around the problem by uncommenting a bit of

-   code in setup.py and building again.  Look for 'SunOS' in setup.py
+   code in config.py and building again.  Look for 'SunOS' in config.py

    and uncomment the block containing it.  The problem is that Sun's ld
    does not automatically add libgcc to the link step.
 
    and uncomment the block containing it.  The problem is that Sun's ld
    does not automatically add libgcc to the link step.
 


@@ -292,10 +294,10 @@ differently.
 
 The \*.btm files are for 4NT and the others are for bash.  They are::
 
 
 The \*.btm files are for 4NT and the others are for bash.  They are::
 

-   .make/.make.btm       Builds the main lib and the needed contribs
-   .mymake/.mymake.btm   Builds just one lib, use by .make
-   .makesetup.mk         A makefile that will copy and edit setup.h
-                         as needed for the different types of builds
+   .make/.make.btm        Builds the main lib and the needed contribs
+   .mymake/.mymake.btm    Builds just one lib, use by .make
+   .makesetup.mk          A makefile that will copy and edit setup.h
+                          as needed for the different types of builds

 
 Okay.  Here's what you've been waiting for, the instructions!  Adapt
 accordingly if you are using the bash shell.
 
 Okay.  Here's what you've been waiting for, the instructions!  Adapt
 accordingly if you are using the bash shell.


@@ -321,6 +323,7 @@ accordingly if you are using the bash shell.
          wxUSE_POSTSCRIPT               1
          wxUSE_AFM_FOR_POSTSCRIPT       0
          wxUSE_DISPLAY                  1
          wxUSE_POSTSCRIPT               1
          wxUSE_AFM_FOR_POSTSCRIPT       0
          wxUSE_DISPLAY                  1

+         wxUSE_DEBUGREPORT              0

 
    If you are using my build scripts then a few more settings will be
    changed and then a copy of setup.h is placed in a subdir of
 
    If you are using my build scripts then a few more settings will be
    changed and then a copy of setup.h is placed in a subdir of


@@ -328,7 +331,7 @@ accordingly if you are using the bash shell.
    UNICODE build, then also change these::
 
          wxUSE_UNICODE                  1
    UNICODE build, then also change these::
 
          wxUSE_UNICODE                  1

-        wxUSE_UNICODE_MSLU             1
+         wxUSE_UNICODE_MSLU             1

 
    If you are doing a "hybrid" build (which is the same as the
    binaries that I release) then also change these::
 
    If you are doing a "hybrid" build (which is the same as the
    binaries that I release) then also change these::


@@ -344,7 +347,7 @@ accordingly if you are using the bash shell.
 
 5. Change to the %WXDIR%\\build\\msw directory 
 
 
 5. Change to the %WXDIR%\\build\\msw directory 
 

-        cd %WXDIR%\\build\\msw
+         cd %WXDIR%\\build\\msw

 
 
 6. If using my scripts then use the .make.btm command to build
 
 
 6. If using my scripts then use the .make.btm command to build


@@ -372,7 +375,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=1 USE_OPENGL=1
+        nmake -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::
 


@@ -391,13 +394,10 @@ accordingly if you are using the bash shell.
    same command from the following directories in order to build the
    contrib libraries::
 
    same command from the following directories in order to build the
    contrib libraries::
 

-       %WXDIR%\contrib\build\gizmos
-       %WXDIR%\contrib\build\stc
-       %WXDIR%\contrib\build\ogl
+        %WXDIR%\contrib\build\animate
+        %WXDIR%\contrib\build\gizmos
+        %WXDIR%\contrib\build\stc

 
 

-    Note, that the ogl lib build will need an additional flag::
-
-       CPPFLAGS="-DwxUSE_DEPRECATED=0"

 
 7.  When that is all done it will have built the main wxWidgets DLLs
     and also some of the contribs DLLs.  There should be a ton of DLLs
 
 7.  When that is all done it will have built the main wxWidgets DLLs
     and also some of the contribs DLLs.  There should be a ton of DLLs


@@ -447,7 +447,7 @@ accordingly if you are using the bash shell.
    PYTHONPATH to the wxPython dir in the CVS tree.  For example::
 
         set PYTHONPATH=%WXDIR%\wxPython
    PYTHONPATH to the wxPython dir in the CVS tree.  For example::
 
         set PYTHONPATH=%WXDIR%\wxPython

-       cd %WXDIR\wxPython\demo
+        cd %WXDIR\wxPython\demo

         python demo.py
 
 
         python demo.py