Skip to content

Commit 2272670

Browse files
committed
python#10907: Update OS X installer build README to better reflect
current build practices.
1 parent 4ce92b2 commit 2272670

1 file changed

Lines changed: 113 additions & 44 deletions

File tree

‎Mac/BuildScript/README.txt‎

Lines changed: 113 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,147 @@
1-
Building a MacPython distribution
2-
=================================
1+
Building a Python Mac OS X distribution
2+
=======================================
33

4-
The ``build-install.py`` script creates MacPython distributions, including
5-
sleepycat db4, sqlite3 and readline support. It builds a complete
4+
The ``build-install.py`` script creates Python distributions, including
5+
certain third-party libraries as necessary. It builds a complete
66
framework-based Python out-of-tree, installs it in a funny place with
77
$DESTROOT, massages that installation to remove .pyc files and such, creates
88
an Installer package from the installation plus other files in ``resources``
99
and ``scripts`` and placed that on a ``.dmg`` disk image.
1010

11-
Prerequisites
12-
-------------
11+
As of Python 2.7.x and 3.2, PSF practice is to build two installer variants
12+
for each release:
1313

14-
* A MacOS X 10.4 (or later)
14+
1. 32-bit-only, i386 and PPC universal, capable on running on all machines
15+
supported by Mac OS X 10.3.9 through (at least) 10.6::
1516

16-
* XCode 2.2 (or later), with the universal SDK
17+
python2.6 build-installer.py \
18+
--sdk-path=/Developer/SDKs/MacOSX10.4u.sdk \
19+
--universal-archs=32-bit \
20+
--dep-target=10.3
21+
# These are the current default options
1722

18-
* No Fink (in ``/sw``) or DarwinPorts (in ``/opt/local``), those could
23+
- builds the following third-party libraries
24+
25+
* Bzip2
26+
* Zlib 1.2.3
27+
* GNU Readline (GPL)
28+
* SQLite 3
29+
* NCurses
30+
* Oracle Sleepycat DB 4.8 (Python 2.x only)
31+
32+
- requires ActiveState ``Tcl/Tk 8.4`` (currently 8.4.19) to be installed for building
33+
34+
- current target build environment:
35+
36+
* Mac OS X 10.5.8 PPC or Intel
37+
* Xcode 3.1.4 (or later)
38+
* ``MacOSX10.4u`` SDK (later SDKs do not support PPC G3 processors)
39+
* ``MACOSX_DEPLOYMENT_TARGET=10.3``
40+
* Apple ``gcc-4.0``
41+
* Python 2.6 for documentation build with Sphinx
42+
43+
- alternate build environments:
44+
45+
* Mac OS X 10.4.11 with Xcode 2.5
46+
* Mac OS X 10.6.6 with Xcode 3.2.5
47+
- need to change ``/System/Library/Frameworks/{Tcl,Tk}.framework/Version/Current`` to ``8.4``
48+
49+
2. 64-bit / 32-bit, x86_64 and i386 universal, for OS X 10.6 (and later)::
50+
51+
python2.6 build-installer.py \
52+
--sdk-path=/Developer/SDKs/MacOSX10.6.sdk \
53+
--universal-archs=intel \
54+
--dep-target=10.6
55+
56+
- uses system-supplied versions of third-party libraries
57+
58+
* readline module links with Apple BSD editline (libedit)
59+
* builds Oracle Sleepycat DB 4.8 (Python 2.x only)
60+
61+
- requires ActiveState Tcl/Tk 8.5.9 (or later) to be installed for building
62+
63+
- current target build environment:
64+
65+
* Mac OS X 10.6.6 (or later)
66+
* Xcode 3.2.5 (or later)
67+
* ``MacOSX10.6`` SDK
68+
* ``MACOSX_DEPLOYMENT_TARGET=10.6``
69+
* Apple ``gcc-4.2``
70+
* Python 2.6 for documentation build with Sphinx
71+
72+
- alternate build environments:
73+
74+
* none
75+
76+
77+
General Prerequisites
78+
---------------------
79+
80+
* No Fink (in ``/sw``) or MacPorts (in ``/opt/local``) or other local
81+
libraries or utilities (in ``/usr/local``) as they could
1982
interfere with the build.
2083

21-
* The documentation for the release must be available on python.org
84+
* The documentation for the release is built using Sphinx
2285
because it is included in the installer.
2386

87+
* It is safest to start each variant build with an empty source directory
88+
populated with a fresh copy of the untarred source.
89+
2490

2591
The Recipe
2692
----------
2793

28-
Here are the steps you need to follow to build a MacPython installer:
94+
Here are the steps you need to follow to build a Python installer:
2995

30-
* Run ``./build-installer.py``. Optionally you can pass a number of arguments
31-
to specify locations of various files. Please see the top of
96+
* Run ``build-installer.py``. Optionally you can pass a number of arguments
97+
to specify locations of various files. Please see the top of
3298
``build-installer.py`` for its usage.
3399

34-
Running this script takes some time, I will not only build Python itself
100+
Running this script takes some time, it will not only build Python itself
35101
but also some 3th-party libraries that are needed for extensions.
36102

37103
* When done the script will tell you where the DMG image is (by default
38104
somewhere in ``/tmp/_py``).
39105

40-
Building a 4-way universal installer
41-
....................................
106+
Building other universal installers
107+
...................................
42108

43109
It is also possible to build a 4-way universal installer that runs on
44-
OSX Leopard or later::
110+
OS X Leopard or later::
45111

46-
$ ./build-installer.py --dep-target=10.5 --universal-archs=all --sdk=/
112+
python 2.6 /build-installer.py \
113+
--dep-target=10.5
114+
--universal-archs=all
115+
--sdk-path=/Developer/SDKs/MacOSX10.5.sdk
47116

48-
This requires that the deployment target is 10.5 (or later), and hence
49-
also that your building on at least OSX 10.5.
50-
51-
Testing
52-
-------
53-
54-
The resulting binaries should work on MacOSX 10.3.9 or later. I usually run
55-
the installer on a 10.3.9, a 10.4.x PPC and a 10.4.x Intel system and then
56-
run the testsuite to make sure.
117+
This requires that the deployment target is 10.5, and hence
118+
also that you are building on at least OS X 10.5. 4-way includes
119+
``i386``, ``x86_64``, ``ppc``, and ``ppc64`` (G5). ``ppc64`` executable
120+
variants can only be run on G5 machines running 10.5. Note that,
121+
while OS X 10.6 is only supported on Intel-based machines, it is possible
122+
to run ``ppc`` (32-bit) executables unmodified thanks to the Rosetta ppc
123+
emulation in OS X 10.5 and 10.6.
57124

125+
Other ``--universal-archs`` options are ``64-bit`` (``x86_64``, ``ppc64``),
126+
and ``3-way`` (``ppc``, ``i386``, ``x86_64``). None of these options
127+
are regularly exercised; use at your own risk.
58128

59-
Announcements
60-
-------------
61129

62-
(This is mostly of historic interest)
130+
Testing
131+
-------
63132

64-
When all is done, announcements can be posted to at least the following
65-
places:
66-
- pythonmac-sig@python.org
67-
- python-dev@python.org
68-
- python-announce@python.org
69-
- archivist@info-mac.org
70-
- adcnews@apple.com
71-
- news@macnn.com
72-
- http://www.macupdate.com
73-
- http://guide.apple.com/usindex.lasso
74-
- http://www.apple.com/downloads/macosx/submit
75-
- http://www.versiontracker.com/ (userid Jack.Jansen@oratrix.com)
76-
- http://www.macshareware.net (userid jackjansen)
133+
Ideally, the resulting binaries should be installed and the test suite run
134+
on all supported OS X releases and architectures. As a practical matter,
135+
that is generally not possible. At a minimum, variant 1 should be run on
136+
at least one Intel, one PPC G4, and one PPC G3 system and one each of
137+
OS X 10.6, 10.5, 10.4, and 10.3.9. Not all tests run on 10.3.9.
138+
Variant 2 should be run on 10.6 in both 32-bit and 64-bit modes.::
139+
140+
arch -i386 /usr/local/bin/pythonn.n -m test.regrtest -w -u all
141+
arch -X86_64 /usr/local/bin/pythonn.n -m test.regrtest -w -u all
142+
143+
Certain tests will be skipped and some cause the interpreter to fail
144+
which will likely generate ``Python quit unexpectedly`` alert messages
145+
to be generated at several points during a test run. These can
146+
be ignored.
77147

78-
Also, check out Stephan Deibels http://pythonology.org/market contact list

0 commit comments

Comments
 (0)