summaryrefslogtreecommitdiff
path: root/python/BuildInstructionsWindows.md
diff options
context:
space:
mode:
authorMark Spruiell <mes@zeroc.com>2017-04-14 12:32:27 -0700
committerMark Spruiell <mes@zeroc.com>2017-04-14 12:32:27 -0700
commit1e7dee261764a4cb6bfcf9359fd60c179d1dcbd6 (patch)
tree799dfeaaafe07b717569688b1383131e33970918 /python/BuildInstructionsWindows.md
parentFormatting fixes (diff)
downloadice-1e7dee261764a4cb6bfcf9359fd60c179d1dcbd6.tar.bz2
ice-1e7dee261764a4cb6bfcf9359fd60c179d1dcbd6.tar.xz
ice-1e7dee261764a4cb6bfcf9359fd60c179d1dcbd6.zip
updating build instructions
Diffstat (limited to 'python/BuildInstructionsWindows.md')
-rw-r--r--python/BuildInstructionsWindows.md80
1 files changed, 41 insertions, 39 deletions
diff --git a/python/BuildInstructionsWindows.md b/python/BuildInstructionsWindows.md
index 21e3630db9c..4babc4ed237 100644
--- a/python/BuildInstructionsWindows.md
+++ b/python/BuildInstructionsWindows.md
@@ -12,81 +12,84 @@ Ice for Python is expected to build and run properly on Windows and was
extensively tested using the operating systems and compiler versions listed for
our [supported platforms][2].
-The build requires the [Ice Builder for Visual Studio][8], you must install
-version 4.2.0 or greater to build Ice.
+The build requires the [Ice Builder for Visual Studio][8]. You must install
+version 4.3.6 or greater to build Ice.
### Python Versions
-Ice for Python supports Python versions 2.6, 2.7, 3.3, 3.4 or 3.5. Note however
-that your Python installation must have been built with a C++ compiler that is
-compatible with the one used to build Ice for C++.
+Ice for Python supports Python versions 2.7 or 3.6. Note however that your
+Python installation must have been built with a C++ compiler that is compatible
+with the one used to build Ice for C++.
## Building the Python Extension
The Python interpreter is readily available on Windows platforms. You can build
it yourself using Microsoft Visual C++, or obtain a binary distribution from the
-Python web site. The Python 3.5.x binary distribution is compiled with Visual
-C++ 14, Python 3.4.x and Python 2.7.x are compiled with Visual C++ 10, you
-should compile the Ice extension with the same Visual C++ version that your
-Python binary distribution was compiled.
+Python web site. The Python 3.6.x binary distribution is compiled with Visual
+C++ 14, while Python 2.7.x is compiled with Visual C++ 10. You should compile the
+Ice extension with the same Visual C++ version as your Python binary distribution.
-Using the first configurations produces 32-bit binaries, while the second
-configurations produce 64-bit binaries.
+Open a command prompt. For example, when using Visual Studio 2015, you have
+several alternatives:
+
+- VS2015 x86 Native Tools Command Prompt
+- VS2015 x64 Native Tools Command Prompt
+
+Using the first configuration produces 32-bit binaries, while the second
+configuration produces 64-bit binaries.
Change to the Ice for Python source subdirectory:
> cd python
-You must built Ice for C++ from the `cpp` subdirectory, if you have not done so
-review cpp\BuildInstructionsWindows.md first.
+You must built Ice for C++ from the `cpp` subdirectory. If you have not done so,
+refer to the [C++ build instructions](../cpp/BuildInstructionsWindows.md).
-Building the extension:
+Build the extension:
- > MSbuild msbuild\ice.proj
+ > msbuild msbuild\ice.proj
-This will build the extension in `Release` configuration and using the command
-prompt default platform, for `x64` platform the extension will be placed in
-`python\x64\Release\IcePy.pyd` and for `Win32` platform the extension will be
-paced in `python\Win32\Release\IcePy.pyd`.
+This will build the extension in `Release` configuration using the command
+prompt's default platform. For the `x64` platform, the extension will be placed in
+`python\x64\Release\IcePy.pyd`, and for the `Win32` platform the extension will be
+placed in `python\Win32\Release\IcePy.pyd`.
-If you want to build a debug version of the extension you can to so by setting
+If you want to build a debug version of the extension, you can do so by setting
the MSBuild `Configuration` property to `Debug`:
- > MSbuild msbuild\ice.proj /p:Configuration=Debug
+ > msbuild msbuild\ice.proj /p:Configuration=Debug
-The debug version of the extension for `x64` platform will be placed in
-`python\x64\Debug\IcePy_d.pyd` and for `Win32` platform it will be placed in
+The debug version of the extension for the `x64` platform will be placed in
+`python\x64\Debug\IcePy_d.pyd` and for the `Win32` platform it will be placed in
`python\Win32\Debug\IcePy_d.pyd`.
> *For Debug builds a debug version of the Python interpreter must be installed.*
The supported values for the `Configuration` property are `Debug` and `Release`.
-If you wan to build the extension for other platform that the command prompt
-default platform, you need to set the MSbuild `Platform` property, the supported
+If you want to build the extension for a different platform than the command prompt's
+default platform, you need to set the MSBuild property `Platform`. The supported
values for this property are `Win32` and `x64`.
-The following command will build the extension `x64` platform binaries with
+The following command will build the `x64` platform binaries with the
`Release` configuration:
- > MSbuild msbuild\ice.proj /p:Configuration=Release /p:Platform=x64
+ > msbuild msbuild\ice.proj /p:Configuration=Release /p:Platform=x64
-And the next command will build the extension `Win32` platform binaries with
+This command will build the `Win32` platform binaries with the
`Release` configuration:
- > MSbuild msbuild\ice.proj /p:Configuration=Release /p:Platform=Win32
+ > msbuild msbuild\ice.proj /p:Configuration=Release /p:Platform=Win32
-> *When using the MSBuild Platform property the build platform doesn't depend on
-the command prompt default platform*
+> *When using the MSBuild Platform property, the build platform doesn't depend on
+the command prompt's default platform.*
-The build will use a default Python location defined in
-`python\msbuild\ice.props`, it can be override by setting the `PythonHome`
-MSBuild property.
+The build will use a default location for Python defined in
+`python\msbuild\ice.props`. You can override it by setting the `PythonHome`
+MSBuild property. For example, the following command will use Python installation
+from `C:\Python36-AMD64` instead of the default location:
-The following command will use Python installation from `C:\Python35-AMD64`
-instead of the default location:
-
- > MSbuild msbuild\ice.proj /p:Configuration=Release /p:Platform=x64 /p:PythonHome=C:\Python35-AMD64
+ > msbuild msbuild\ice.proj /p:Configuration=Release /p:Platform=x64 /p:PythonHome=C:\Python36-AMD64
## Configuring your Environment for Python
@@ -99,7 +102,6 @@ subdirectory. For example, if the Ice for Python extension is installed in
> set PYTHONPATH=C:\Ice\python;C:\Ice\python\Win32\Release
-
## Running the Python Tests
After a successful build, you can run the tests as follows: