Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Regenned the ReST docs

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@27702 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2004-06-09 05:40:10 +00:00
parent fda330675c
commit 40efbdda05
5 changed files with 575 additions and 300 deletions
Download Patch File Download Diff File Expand all files Collapse all files

156
wxPython/docs/BUILD.html
View File

@@ -44,6 +44,15 @@ whereever you checked out the wxWidgets module from CVS, or untarred
the wxPythonSrc 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.</p>
<p>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
installed from one of the standard wxWidgets installers. With the
&quot;unstable&quot; releases (have a odd-numbered minor release value, where
the APIs are allowed to change) there are often significant
differences between the W.X.Y release of wxWidgets and the W.X.Y.Z
release of wxPython.</p>
<div class="section" id="building-on-unix-like-systems-e-g-linux-and-os-x">
<h1><a name="building-on-unix-like-systems-e-g-linux-and-os-x">Building on Unix-like Systems (e.g. Linux and OS X)</a></h1>
<p>These platforms are built almost the same way while in development
@@ -131,7 +140,7 @@ instead.</p>
these commands, so it won't impact your already installed version
of the latest release. You'll be able test with this version when
you want to, and use the installed release version the rest of the
time. If do want to install the development verison please read
time. If you want to install the development version please read
INSTALL.txt.</p>
<p>If you have more than one version of Python on your system then be
sure to use the version of Python that you want to use when running
@@ -161,16 +170,16 @@ where to find the new swig executable, so add these flags:</p>
<pre class="literal-block">
USE_SWIG=1 SWIG=/opt/swig/bin/swig
</pre>
<p>If you get errors about wxGLCanvas or being unable to find libGLU
or something like that then you can add BUILD_GLCANVAS=0 to the
setup.py command line to disable the building of the glcanvas
module.</p>
<p>If you get errors about being unable to find libGLU, wxGLCanvas
being undeclared, or something similar then you can add
BUILD_GLCANVAS=0 to the setup.py command line to disable the
building of the glcanvas module.</p>
<p>When the setup.py command is done you should have fully populated
wxPython and wx packages locally in $WXDIR/wxPython/wxPython and
$WXDIR/wxPython/wx, with all the extension modules (<tt class="literal"><span class="pre">*.so</span></tt> files)
located in the wx package.</p>
</li>
<li><p class="first">To run code with the development verison of wxPython, just set the
<li><p class="first">To run code with the development version of wxPython, just set the
PYTHONPATH to the wxPython dir located in the source tree. For
example:</p>
<pre class="literal-block">
@@ -212,7 +221,7 @@ used. The Python executable that comes from PythonLabs and the
wxPython extensions that I distribute are built with MSVC 6 with all
the Service Packs applied. This policy will change with Python 2.4
and MSVC 7.1 will be used starting with that version.</p>
<p>If you want to build a debugable version of wxWidgets and wxPython you
<p>If you want to build a debuggable version of wxWidgets and wxPython you
will need to have also built a debug version of Python and any other
extension modules you need to use. You can tell if you have them
already if there is a _d in the file names, for example python_d.exe
@@ -221,15 +230,31 @@ 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.</p>
<p>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 want
to use my scripts you'll need to get a copy or 4DOS or 4NT from
<a class="reference" href="http://www.jpsoft.com/">http://www.jpsoft.com/</a> and also a copy of unix-like cat and sed
programs. You can also do by hand what my scripts are doing, but
there are alot of steps involved and I won't be going into details
here. There is a copy of my build scripts in %WXDIR%wxPythondistribmsw
that you can use for reference (if you don't use them directly) for
adapting these instructions to your specific needs. The directions
below assume that you are using my scripts.</p>
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
programs then there is a copy of my wxWidgets build scripts in
%WXDIR%\wxPython\distrib\msw. Just copy them to
%WXDIR%\build\msw and you can use them to do your build, otherwise
you can do everything by hand as described below. But if you do work
by hand and something doesn't seem to be working correctly please
refer to the build scripts to see what may need to be done
differently.</p>
<p>The <a href="#id1" name="id2"><span class="problematic" id="id2">*</span></a>.btm files are for 4NT and the others are for bash. They are:</p>
<div class="system-message" id="id1">
<p class="system-message-title">System Message: <a name="id1">WARNING/2</a> (<tt>/home/work/projects/wx2.5/wxPython/docs/BUILD.txt</tt>, line 259); <em><a href="#id2">backlink</a></em></p>
Inline emphasis start-string without end-string.</div>
<blockquote>
<p>.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</p>
<div class="system-message">
<p class="system-message-title">System Message: ERROR/3 (<tt>/home/work/projects/wx2.5/wxPython/docs/BUILD.txt</tt>, line 264)</p>
Unexpected indentation.</div>
<blockquote>
as needed for the different types of builds</blockquote>
</blockquote>
<p>Okay. Here's what you've been waiting for, the instructions! Adapt
accordingly if you are using the bash shell.</p>
<ol class="arabic">
<li><p class="first">Set an environment variable to the root of the wxWidgets source
tree. This is used by the makefiles:</p>
@@ -237,16 +262,13 @@ tree. This is used by the makefiles:</p>
set WXWIN=%WXDIR%
</pre>
</li>
<li><p class="first">Copy setup0.h to setup.h</p>
<blockquote>
<p>cd %WXDIR%includewxmsw
copy setup0.h setup.h</p>
</blockquote>
<li><p class="first">Copy setup0.h to setup.h:</p>
<pre class="literal-block">
cd %WXDIR%\include\wx\msw
copy setup0.h setup.h
</pre>
</li>
<li><p class="first">Edit %WXDIR%includewxmswsetup.h and change a few settings.
Some of them are changed by my build scripts depending on the type
of build (debug/hybrid, unicode/ansi). I change a few of the other
defaults to have these values:</p>
<li><p class="first">Edit %WXDIR%\include\wx\msw\setup.h and change a few settings:</p>
<pre class="literal-block">
wxDIALOG_UNIT_COMPATIBILITY 0
wxUSE_DEBUG_CONTEXT 1
@@ -257,18 +279,33 @@ wxUSE_POSTSCRIPT 1
wxUSE_AFM_FOR_POSTSCRIPT 0
wxUSE_DISPLAY 1
</pre>
<p>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
%WXWIN%\libvc_dll. If you are doing it by hand and making a
UNICODE build, then also change these:</p>
<pre class="literal-block">
wxUSE_UNICODE 1
wxUSE_UNICODE_MSLU 1
</pre>
<p>If you are doing a &quot;hybrid&quot; build (which is the same as the
binaries that I release) then also change these:</p>
<pre class="literal-block">
wxUSE_MEMORY_TRACING 0
wxUSE_DEBUG_CONTEXT 0
</pre>
</li>
<li><p class="first">Make sure that %WXDIR%libvc_dll directory is on the PATH. The
<li><p class="first">Make sure that %WXDIR%\lib\vc_dll directory is on the PATH. The
wxWidgets DLLs will end up there as part of the build and so you'll
need it on the PATH for them to be found at runtime.</p>
</li>
<li><p class="first">Change to the %WXDIR%buildmsw directory and copy my build scripts
there from their default location in %WXDIR%wxPythondistribmsw
if they are not present already.</p>
<li><p class="first">Change to the %WXDIR%\build\msw directory</p>
<blockquote>
<p>cd %WXDIR%\build\msw</p>
</blockquote>
</li>
<li><p class="first">Use the .make.btm command to build wxWidgets. It needs one
command-line parameter which controls what kind of build(s) to do.
Use one of the following:</p>
<li><p class="first">If using my scripts then use the .make.btm command to build
wxWidgets. It needs one command-line parameter which controls what
kind of build(s) to do. Use one of the following:</p>
<pre class="literal-block">
debug Build debug version
hybrid Build hybrid version
@@ -279,19 +316,46 @@ both-uni and finally both unicode libraries
</pre>
<p>For example:</p>
<pre class="literal-block">
.make hybrid
You can also pass additional command line parameters as needed and
.make hybrid
</pre>
<p>You can also pass additional command line parameters as needed and
they will all be passed on to the nmake commands, for example to
clean up the build::
.make hybrid clean
clean up the build:</p>
<pre class="literal-block">
.make hybrid clean
</pre>
<p>If <em>not</em> using my scripts then you can do it by hand by directly
executing nmake with a bunch of extra command line parameters.
The base set are:</p>
<pre class="literal-block">
-f makefile.vc OFFICIAL_BUILD=1 SHARED=1 MONOLITHIC=0 USE_OPENGL=1
</pre>
<p>If doing a debug build then add:</p>
<pre class="literal-block">
BUILD=debug
</pre>
<p>otherwise add these:</p>
<pre class="literal-block">
DEBUG_FLAG=1 CXXFLAGS=/D__NO_VC_CRTDBG__ WXDEBUGFLAG=h BUILD=release
</pre>
<p>If doing a Unicode build then add these flags:</p>
<pre class="literal-block">
UNICODE=1 MSLU=1
</pre>
<p>Now, from the %WXDIR%\build\msw directory run nmake with your
selection of command-line flags as described above. Repeat this
same command from the following directories in order to build the
contrib libraries:</p>
<pre class="literal-block">
%WXDIR%\contrib\build\gizmos
%WXDIR%\contrib\build\xrc
%WXDIR%\contrib\build\stc
%WXDIR%\contrib\build\ogl
</pre>
</li>
<li><p class="first">When that is done it will have built the main wxWidgets DLLs and
also some of the contribs DLLs. There should be a ton of DLLs in
%WXDIR%bin and lots of lib files and other stuff in
%WXDIR%libvc_dll.</p>
<li><p class="first">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
and lots of lib files and other stuff in %WXDIR%\lib\vc_dll.</p>
</li>
<li><p class="first">Building wxPython on Windows is very similar to doing it for the
unix systems. We're not going to install the development version
@@ -299,9 +363,9 @@ of wxPython with these commands, so it won't impact your already
installed version of the latest release. You'll be able to test
with this version when you want to, and use the installed release
version the rest of the time. If you ever do want to install the
development verison please refer to INSTALL.txt.</p>
<p>Change to the %WXDIR%wxPython dir and run the this command,
makeing sure that you use the version of python that you want to
development version please refer to INSTALL.txt.</p>
<p>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):</p>
<pre class="literal-block">
cd %WXDIR%\wxPython
@@ -328,7 +392,7 @@ wxPython and wx packages locally in %WXDIR%/wxPython/wxPython and
%WXDIR%/wxPython/wx, with all the extension modules (<tt class="literal"><span class="pre">*.pyd</span></tt>
files) located in the wx package.</p>
</li>
<li><p class="first">To run code with the development verison of wxPython, just set the
<li><p class="first">To run code with the development version of wxPython, just set the
PYTHONPATH to the wxPython dir in the CVS tree. For example:</p>
<pre class="literal-block">
set PYTHONPATH=%WXDIR%\wxPython