summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBenoit Foucher <benoit@zeroc.com>2015-06-19 16:20:35 +0200
committerBenoit Foucher <benoit@zeroc.com>2015-06-19 16:20:35 +0200
commita56cbe5426f6958d0faabd82ba2a689abbee43e8 (patch)
tree912c5e26c124d846c1d8f0faa655ac9f0cc9a347
parentPut back server.pem (diff)
downloadice-a56cbe5426f6958d0faabd82ba2a689abbee43e8.tar.bz2
ice-a56cbe5426f6958d0faabd82ba2a689abbee43e8.tar.xz
ice-a56cbe5426f6958d0faabd82ba2a689abbee43e8.zip
BuildInstruction fixes
- Hard-wrapped lines to 80 cols - Added OSX instruction for Ruby
-rw-r--r--android/BuildInstructions.md19
-rw-r--r--cpp/BuildInstructionsLinux.md16
-rw-r--r--cpp/BuildInstructionsMinGW.md4
-rw-r--r--cpp/BuildInstructionsOSX.md25
-rw-r--r--cpp/BuildInstructionsWinRT.md55
-rw-r--r--cpp/BuildInstructionsWindows.md32
-rw-r--r--csharp/BuildInstructions.md52
-rw-r--r--java/BuildInstructions.md53
-rw-r--r--js/BuildInstructions.md4
-rw-r--r--php/BuildInstructionsLinuxOSX.md40
-rw-r--r--php/BuildInstructionsWindows.md59
-rw-r--r--python/BuildInstructionsLinuxOSX.md6
-rw-r--r--python/BuildInstructionsWindows.md18
-rw-r--r--ruby/BuildInstructionsLinuxOSX.md (renamed from ruby/BuildInstructionsLinux.md)42
-rw-r--r--ruby/BuildInstructionsWindows.md37
15 files changed, 240 insertions, 222 deletions
diff --git a/android/BuildInstructions.md b/android/BuildInstructions.md
index 09eb40fc168..0af20e80e06 100644
--- a/android/BuildInstructions.md
+++ b/android/BuildInstructions.md
@@ -1,14 +1,14 @@
# Building the Ice for Android Test Suite
-This directory contains an Android Studio project for the Ice test suite. For ease
-of development and testing, this project also builds a subset of the Ice JAR files.
-This is not necessary for your own projects as it considerably complicates the
-project configuration.
+This directory contains an Android Studio project for the Ice test suite. For
+ease of development and testing, this project also builds a subset of the Ice
+JAR files. This is not necessary for your own projects as it considerably
+complicates the project configuration.
-Building [Ice for Java](../java/BuildInstructions.md) is the only way to build all
-of the Ice JAR files from source. The JAR files produced by the Ice for Java build
-fully support Android. If you prefer, our [binary distributions][1] include
-pre-compiled JAR files.
+Building [Ice for Java](../java/BuildInstructions.md) is the only way to build
+all of the Ice JAR files from source. The JAR files produced by the Ice for Java
+build fully support Android. If you prefer, our [binary distributions][1]
+include pre-compiled JAR files.
## Build Requirements
@@ -68,6 +68,7 @@ Follow these steps to import the Ice for Android project into Android Studio:
"Use default gradle wrapper" and press OK
The Android Studio project contains a `testApp` application for the Ice test
-suite. To run the application, select it in the configuration pull down and run it.
+suite. To run the application, select it in the configuration pull down and run
+it.
[1]: https://zeroc.com/download.html
diff --git a/cpp/BuildInstructionsLinux.md b/cpp/BuildInstructionsLinux.md
index 26aa5342f4f..f3a1d02581c 100644
--- a/cpp/BuildInstructionsLinux.md
+++ b/cpp/BuildInstructionsLinux.md
@@ -2,17 +2,17 @@
This file describes the Ice source distribution, including information about
compiler requirements, third-party dependencies, and instructions for building
-and testing the distribution. If you prefer, you can install [binary packages][1]
-for supported platforms that contain pre-compiled libraries, executables, and
-everything else necessary to build Ice applications on Linux.
+and testing the distribution. If you prefer, you can install [binary
+packages][1] for supported platforms that contain pre-compiled libraries,
+executables, and everything else necessary to build Ice applications on Linux.
## C++ Build Requirements
### Operating Systems and Compilers
Ice is expected to build and run properly on any recent Linux distribution for
-x86 and x86_64, and was extensively tested using the operating systems and compiler
-versions listed for our [supported platforms][2].
+x86 and x86_64, and was extensively tested using the operating systems and
+compiler versions listed for our [supported platforms][2].
### Third-Party Libraries
@@ -24,9 +24,9 @@ Ice has dependencies on a number of third-party libraries:
- [Berkeley DB][6] 5.3
- [mcpp][7] 2.7.2 (with patches)
-Expat, OpenSSL and bzip are included with most Linux distributions. ZeroC supplies
-binary packages for Berkeley DB and mcpp on supported Linux distributions that do
-not include them:
+Expat, OpenSSL and bzip are included with most Linux distributions. ZeroC
+supplies binary packages for Berkeley DB and mcpp on supported Linux
+distributions that do not include them:
- Berkeley DB 5.3.28 on RHEL 6, SLES12, SLES 11 and Amzn 2015.03
- mcpp 2.7.2 with patches (`mcpp-devel`) on RHEL 7, RHEL 6, SLES 12, SLES 11
diff --git a/cpp/BuildInstructionsMinGW.md b/cpp/BuildInstructionsMinGW.md
index b05997c1848..a6d2cda7d92 100644
--- a/cpp/BuildInstructionsMinGW.md
+++ b/cpp/BuildInstructionsMinGW.md
@@ -13,8 +13,8 @@ Ice for C++ was tested with the following MinGW compilers:
- [mingw 4.7.3 32-bit][2]
- mingw 4.7.2 64-bit, included in the [Ruby Development Kit][3] version 4.7.2
-> *mingw 4.7.2 32-bit, included in the 32-bit Ruby Development Kit version 4.7.2,
-contains a very severe bug that makes it unsuitable to build Ice.*
+> *mingw 4.7.2 32-bit, included in the 32-bit Ruby Development Kit version
+4.7.2, contains a very severe bug that makes it unsuitable to build Ice.*
### Third-Party Libraries
diff --git a/cpp/BuildInstructionsOSX.md b/cpp/BuildInstructionsOSX.md
index 066495ca61a..9a2e96fa6ad 100644
--- a/cpp/BuildInstructionsOSX.md
+++ b/cpp/BuildInstructionsOSX.md
@@ -30,10 +30,12 @@ a couple of options:
$ brew install berkeley-db53 [--without-java]
$ brew install mcpp
- The `berkeley-db53` package is a pre-compiled bottle that includes Java support
- by default; you can exclude Java support using the `--without-java` option.
+ The `berkeley-db53` package is a pre-compiled bottle that includes Java
+ support by default; you can exclude Java support using the `--without-java`
+ option.
-- Download the Berkeley DB and mcpp source distributions and build them yourself.
+- Download the Berkeley DB and mcpp source distributions and build them
+ yourself.
## Building Ice
@@ -42,8 +44,8 @@ In a command window, change to the `cpp` subdirectory:
$ cd cpp
Edit `config/Make.rules` to establish your build configuration. The comments in
-the file provide more information. Pay particular attention to the variables that
-define the locations of the third-party libraries.
+the file provide more information. Pay particular attention to the variables
+that define the locations of the third-party libraries.
Now you're ready to build Ice:
@@ -56,16 +58,17 @@ This will build the Ice core libraries, services, and tests.
Simply run `make install`. This will install Ice in the directory specified by
the `prefix` variable in `config/Make.rules`.
-After installation, make sure that the `<prefix>/bin` directory is in your `PATH`.
+After installation, make sure that the `<prefix>/bin` directory is in your
+`PATH`.
If you choose to not embed a `runpath` into executables at build time (see your
-build settings in `config/Make.rules`) or did not create a symbolic link from the
-`runpath` directory to the installation directory, you also need to add the
+build settings in `config/Make.rules`) or did not create a symbolic link from
+the `runpath` directory to the installation directory, you also need to add the
library directory to your `DYLD_LIBRARY_PATH`.
-When compiling Ice programs, you must pass the location of the `<prefix>/include`
-directory to the compiler with the `-I` option, and the location of the library
-directory with the `-L` option.
+When compiling Ice programs, you must pass the location of the
+`<prefix>/include` directory to the compiler with the `-I` option, and the
+location of the library directory with the `-L` option.
## Running the Test Suite
diff --git a/cpp/BuildInstructionsWinRT.md b/cpp/BuildInstructionsWinRT.md
index 2bc4a9bfc11..cc2d939cff7 100644
--- a/cpp/BuildInstructionsWinRT.md
+++ b/cpp/BuildInstructionsWinRT.md
@@ -2,30 +2,30 @@
This file describes the Ice source distribution, including information about
compiler requirements, third-party dependencies, and instructions for building
-and testing the distribution. If you prefer, you can download a [Windows installer][1]
-that contains pre-compiled debug and release libraries, executables, and everything
-else necessary to build Ice applications for WinRT.
+and testing the distribution. If you prefer, you can download a [Windows
+installer][1] that contains pre-compiled debug and release libraries,
+executables, and everything else necessary to build Ice applications for WinRT.
## Build Requirements for WinRT
-Ice was extensively tested using the operating systems and compiler versions listed
-for our [supported platforms][2].
+Ice was extensively tested using the operating systems and compiler versions
+listed for our [supported platforms][2].
## Building Ice
-> *To build Ice for WinRT you first need to build Ice for Windows. The build of Ice
-for Windows is necessary to create the Slice translators that we need to build Ice
-for WinRT.*
+> *To build Ice for WinRT you first need to build Ice for Windows. The build of
+Ice for Windows is necessary to create the Slice translators that we need to
+build Ice for WinRT.*
-Open a command prompt that is configured for your target architecture. For example,
-Visual Studio gives you several alternatives:
+Open a command prompt that is configured for your target architecture. For
+example, Visual Studio gives you several alternatives:
- Visual Studio Command Prompt
- Visual Studio x64 Win64 Command Prompt
- Visual Studio x64 Cross Tools Command Prompt
-Using the first configuration produces 32-bit binaries, while the second and third
-produce 64-bit binaries.
+Using the first configuration produces 32-bit binaries, while the second and
+third produce 64-bit binaries.
In the command window, change to the `cpp` subdirectory:
@@ -67,34 +67,35 @@ In Visual Studio, open this solution file:
cpp\test\WinRT\TestSuite.sln
-Now select the configuration that matches the settings in `config\Make.rules.mak`
-that you used to build the dynamic libraries. For example, if you built the test
-libraries for x86 and debug, you must select Win32 Debug.
+Now select the configuration that matches the settings in
+`config\Make.rules.mak` that you used to build the dynamic libraries. For
+example, if you built the test libraries for x86 and debug, you must select
+Win32 Debug.
After selecting the appropriate configuration, build the solution by choosing
"Build Solution" in the "Build" menu.
-After the build completes, you can deploy the application using "Deploy Solution"
-in the "Build" menu. Once deployed, you can start the application from the WinRT
-Desktop by clicking the "Ice Test Suite" icon.
+After the build completes, you can deploy the application using "Deploy
+Solution" in the "Build" menu. Once deployed, you can start the application from
+the WinRT Desktop by clicking the "Ice Test Suite" icon.
In the test suite application, selecting "winrt" for the Server field allows you
to run tests with TCP and WS protocols supported by the WinRT server side.
-You can also use C++, C# or Java servers to run the tests, which allows you to use
-additional SSL and WSS protocols.
+You can also use C++, C# or Java servers to run the tests, which allows you to
+use additional SSL and WSS protocols.
-To use servers from C++, C# or Java language mappings, you need to build the tests
-for the desired language mapping.
+To use servers from C++, C# or Java language mappings, you need to build the
+tests for the desired language mapping.
-The test controller server is implemented in Java. Refer to the build instructions in
-java subdirectory for information on building the test controller. Use the following
-command to start the test controller:
+The test controller server is implemented in Java. Refer to the build
+instructions in java subdirectory for information on building the test
+controller. Use the following command to start the test controller:
> python scripts/TestController.py
-In the "Ice Test Suite" Windows Store application, select the Server language mapping
-and Protocol you want to use.
+In the "Ice Test Suite" Windows Store application, select the Server language
+mapping and Protocol you want to use.
[1]: https://doc.zeroc.com/display/Ice36/Using+the+Windows+Binary+Distribution
[2]: https://doc.zeroc.com/display/Ice36/Supported+Platforms+for+Ice+3.6.0
diff --git a/cpp/BuildInstructionsWindows.md b/cpp/BuildInstructionsWindows.md
index 3124ea30f3b..93861655cf0 100644
--- a/cpp/BuildInstructionsWindows.md
+++ b/cpp/BuildInstructionsWindows.md
@@ -2,16 +2,16 @@
This file describes the Ice source distribution, including information about
compiler requirements, third-party dependencies, and instructions for building
-and testing the distribution. If you prefer, you can download a [Windows installer][1]
-that contains pre-compiled debug and release libraries, executables, and everything
-else necessary to build Ice applications on Windows.
+and testing the distribution. If you prefer, you can download a [Windows
+installer][1] that contains pre-compiled debug and release libraries,
+executables, and everything else necessary to build Ice applications on Windows.
## Build Requirements
### Operating Systems and Compilers
-Ice was extensively tested using the operating systems and compiler versions listed
-for our [supported platforms][2].
+Ice was extensively tested using the operating systems and compiler versions
+listed for our [supported platforms][2].
### Third-Party Libraries
@@ -37,8 +37,8 @@ are two knowledgebase articles that may be relevant for your system:
## Building Ice
-Open a command prompt that is configured for your target architecture. For example,
-when using Visual Studio 2013, you have several alternatives:
+Open a command prompt that is configured for your target architecture. For
+example, when using Visual Studio 2013, you have several alternatives:
- Developer Command Prompt
- VS2013 x86 Native Tools Command Prompt
@@ -48,7 +48,8 @@ when using Visual Studio 2013, you have several alternatives:
Using the first two configurations produces 32-bit binaries, while the third and
fourth configurations produce 64-bit binaries.
-> *You must be using a Windows x64 platform when compiling a 64-bit version of Ice.*
+> *You must be using a Windows x64 platform when compiling a 64-bit version of
+> *Ice.*
In the command window, change to the `cpp` subdirectory:
@@ -66,18 +67,19 @@ This will build the Ice core libraries, services, and tests.
### x64 Platform
Building Ice on x64 with the Visual Studio C++ compiler is like building Ice on
-x86. You just need to perform the build in an "x64 Command Prompt", and not in
-a regular "Developer Command Prompt".
+x86. You just need to perform the build in an "x64 Command Prompt", and not in a
+regular "Developer Command Prompt".
-> *You must be using a Windows x64 platform when compiling a 64-bit version of Ice.*
+> *You must be using a Windows x64 platform when compiling a 64-bit version of
+> *Ice.*
## Installing a C++ Source Build
-Simply run `nmake /f Makefile.mak install`. This will install Ice in the directory
-specified by the `prefix` variable in `config\Make.rules.mak`.
+Simply run `nmake /f Makefile.mak install`. This will install Ice in the
+directory specified by the `prefix` variable in `config\Make.rules.mak`.
-If you built a 64-bit version of Ice, the binaries are installed in the `bin\x64`
-directory and the libraries are installed in the `lib\x64` directory.
+If you built a 64-bit version of Ice, the binaries are installed in the
+`bin\x64` directory and the libraries are installed in the `lib\x64` directory.
## Running the Test Suite
diff --git a/csharp/BuildInstructions.md b/csharp/BuildInstructions.md
index c47fa16d53a..23febb268ad 100644
--- a/csharp/BuildInstructions.md
+++ b/csharp/BuildInstructions.md
@@ -1,21 +1,21 @@
# Building Ice for .NET
This page describes how to build and install Ice for .NET from source code using
-Visual Studio. If you prefer, you can also download [binary distributions][1] for
-the supported platforms.
+Visual Studio. If you prefer, you can also download [binary distributions][1]
+for the supported platforms.
## Build Requirements
### Operating Systems and Compilers
-Ice for .NET was extensively tested using the operating systems and compiler versions
-listed for our [supported platforms][2].
+Ice for .NET was extensively tested using the operating systems and compiler
+versions listed for our [supported platforms][2].
### Slice to C# Translator
-You will need the Slice to C# translator. ZeroC provides translator binaries for our
-supported platforms, or you can build Ice for C++ (which contains the Slice to C#
-translator) from source.
+You will need the Slice to C# translator. ZeroC provides translator binaries for
+our supported platforms, or you can build Ice for C++ (which contains the Slice
+to C# translator) from source.
## Compiling Ice for .NET with Visual Studio
@@ -33,8 +33,8 @@ Open a Visual Studio command window and change to the `csharp` subdirectory:
> cd csharp
-Review the settings in the file `config\Make.rules.mak.cs` and edit as necessary.
-For example, you may wish to enable optimization.
+Review the settings in the file `config\Make.rules.mak.cs` and edit as
+necessary. For example, you may wish to enable optimization.
To build the Ice assemblies, services and tests, run
@@ -61,8 +61,8 @@ At the command prompt, execute:
> python allTests.py
-You can also run tests individually by changing to the test directory and running
-this command:
+You can also run tests individually by changing to the test directory and
+running this command:
> python run.py
@@ -71,23 +71,24 @@ failure, the tests abort with `failed`.
## Protocol Compression with .NET
-Ice for .NET attempts to dynamically load `bzip2.dll` to support protocol compression,
-therefore this DLL must be present in your PATH. Ice automatically disables protocol
-compression if the DLL cannot be found.
+Ice for .NET attempts to dynamically load `bzip2.dll` to support protocol
+compression, therefore this DLL must be present in your PATH. Ice automatically
+disables protocol compression if the DLL cannot be found.
-On 64-bit Windows, you must ensure that Ice finds the 64-bit version of `bzip2.dll`
-before the 32-bit version. The 64-bit and 32-bit bzip2 libraries are installed in
-`<prefix>\bin\x64` and `<prefix>\bin`, respectively. For 64-bit Windows, the
-`<prefix>\bin\x64` directory must appear before `<prefix>\bin` in your application's
-PATH. (The Ice run time prints a warning to the console if it detects a `bzip2.dll`
-format mismatch during start-up.)
+On 64-bit Windows, you must ensure that Ice finds the 64-bit version of
+`bzip2.dll` before the 32-bit version. The 64-bit and 32-bit bzip2 libraries are
+installed in `<prefix>\bin\x64` and `<prefix>\bin`, respectively. For 64-bit
+Windows, the `<prefix>\bin\x64` directory must appear before `<prefix>\bin` in
+your application's PATH. (The Ice run time prints a warning to the console if it
+detects a `bzip2.dll` format mismatch during start-up.)
## Installing Ice for .NET
-Run `nmake /f Makefile.mak install` to install Ice for .NET in the directory specified
-by the `prefix` variable in `config\Make.rules.mak.cs`. After installation, the
-`<prefix>\bin` directory contains executables (such as `iceboxnet.exe`), and the
-`<prefix>\Assemblies` directory contains the .NET assemblies.
+Run `nmake /f Makefile.mak install` to install Ice for .NET in the directory
+specified by the `prefix` variable in `config\Make.rules.mak.cs`. After
+installation, the `<prefix>\bin` directory contains executables (such as
+`iceboxnet.exe`), and the `<prefix>\Assemblies` directory contains the .NET
+assemblies.
> *This command must be executed in a command prompt that has administrative
privileges because it requires write access to the registry to register the
@@ -127,7 +128,8 @@ build. Run nmake to start the build:
## Targeting Unity
Ice for .NET can also be compiled to target the Unity API. To build Ice for the
-Unity API, open `config\Make.rules.mak.cs` and set `UNITY=yes`. Run nmake as before:
+Unity API, open `config\Make.rules.mak.cs` and set `UNITY=yes`. Run nmake as
+before:
> nmake /f Makefile.mak
diff --git a/java/BuildInstructions.md b/java/BuildInstructions.md
index d5f21294df1..0021a2afa58 100644
--- a/java/BuildInstructions.md
+++ b/java/BuildInstructions.md
@@ -10,17 +10,18 @@ platforms.
Ice for Java is expected to build and run properly on Windows, OS X, and any
recent Linux distribution for x86 and x86_64, and was extensively tested using
-the operating systems and compiler versions listed for our [supported platforms][2].
-Due to the portability of Java, it is very likely that it will also work on other
-platforms for which a suitable Java implementation is available.
+the operating systems and compiler versions listed for our [supported
+platforms][2]. Due to the portability of Java, it is very likely that it will
+also work on other platforms for which a suitable Java implementation is
+available.
### Slice to Java Translator
-You will need the Slice to Java translator. ZeroC provides translator binaries for
-our supported platforms. For other platforms, you will have to either port Ice for
-C++ (which contains the Slice to Java translator), or you will have to translate
-your Slice files to Java on a supported platform and then copy the generated Java
-files to your target platform.
+You will need the Slice to Java translator. ZeroC provides translator binaries
+for our supported platforms. For other platforms, you will have to either port
+Ice for C++ (which contains the Slice to Java translator), or you will have to
+translate your Slice files to Java on a supported platform and then copy the
+generated Java files to your target platform.
### Java Version
@@ -28,21 +29,21 @@ Ice for Java requires J2SE 1.7.0 or later.
The Metrics Graph feature of the graphical IceGrid administrative tool requires
J2SE 7u6 or later with JavaFX support. This feature will not be available if you
-build the source with a JVM that lacks support for JavaFX. Alternatively, building
-the source using J2SE 7u6 or later with JavaFX produces a JAR file that can be
-used in JVMs with or without JavaFX support, as the Metrics Graph feature is
-enabled dynamically.
+build the source with a JVM that lacks support for JavaFX. Alternatively,
+building the source using J2SE 7u6 or later with JavaFX produces a JAR file that
+can be used in JVMs with or without JavaFX support, as the Metrics Graph feature
+is enabled dynamically.
Make sure that the `javac` and `java` commands are present in your PATH.
### Berkeley DB
"Freeze" is an optional Ice component that provides a persistence facility for
-Ice applications. Freeze uses Berkeley DB as its underlying database and currently
-requires Berkeley DB version 5.3 (the recommended version is 5.3.28).
+Ice applications. Freeze uses Berkeley DB as its underlying database and
+currently requires Berkeley DB version 5.3 (the recommended version is 5.3.28).
-ZeroC includes Berkeley DB in the binary distributions for all supported platforms,
-or you can build it from source yourself.
+ZeroC includes Berkeley DB in the binary distributions for all supported
+platforms, or you can build it from source yourself.
In order to run an application that uses Freeze, you must add `db.jar` to your
CLASSPATH and verify that the Berkeley DB shared libraries are in your
@@ -147,8 +148,8 @@ On Windows:
> set ICE_HOME=C:\Program Files (x86)\ZeroC\Ice-3.6.0
-Before building Ice for Java, review the settings in the file `gradle.properties`
-and edit as necessary.
+Before building Ice for Java, review the settings in the file
+`gradle.properties` and edit as necessary.
### Building Ice for Java
@@ -184,8 +185,8 @@ The installation installs the following JAR files to `<prefix>/lib`.
icepatch2-3.6.0.jar
icestorm-3.6.0.jar
-POM files are also installed for ease of deployment to a maven-based distribution
-system.
+POM files are also installed for ease of deployment to a maven-based
+distribution system.
## Running the Java Tests
@@ -201,13 +202,13 @@ On Windows:
> set ICE_HOME=c:\Program Files (x86)\ZeroC\Ice-3.6.0
-Python is required to run the test suite. To run the tests, open a command window
-and change to the top-level directory. At the command prompt, execute:
+Python is required to run the test suite. To run the tests, open a command
+window and change to the top-level directory. At the command prompt, execute:
> python allTests.py
-You can also run tests individually by changing to the test directory and running
-this command:
+You can also run tests individually by changing to the test directory and
+running this command:
> python run.py
@@ -230,8 +231,8 @@ the IceGrid Admin tool by double-clicking the IceGrid Admin icon in Finder.
## Test Controller
The test Controller is an Ice server that allows to start servers for languages
-that doesn't provide a full server side. This is currently used by JavaScript and
-WinRT test suites to start the required servers.
+that doesn't provide a full server side. This is currently used by JavaScript
+and WinRT test suites to start the required servers.
> gradlew :testController:assemble
diff --git a/js/BuildInstructions.md b/js/BuildInstructions.md
index 56ad683ca61..aba9cb3f87d 100644
--- a/js/BuildInstructions.md
+++ b/js/BuildInstructions.md
@@ -51,8 +51,8 @@ To start the browser tests run:
> npm run gulp:test:run-with-browser
This requires that you build the Java test controller from the Java subdirectory
-and test servers from C++, C# or Java. Follow the instructions from the corresponding
-language mapping to build the tests and the server controller.
+and test servers from C++, C# or Java. Follow the instructions from the
+corresponding language mapping to build the tests and the server controller.
In OS X the first time you run the script, you will be prompted for your
password. This is necessary to configure the trust setting for the HTTP
diff --git a/php/BuildInstructionsLinuxOSX.md b/php/BuildInstructionsLinuxOSX.md
index a914788bfe3..d9128d6876c 100644
--- a/php/BuildInstructionsLinuxOSX.md
+++ b/php/BuildInstructionsLinuxOSX.md
@@ -19,20 +19,23 @@ distribution or compile from source yourself.
## Building the PHP Extension
Our source code only supports building Ice for PHP as a dynamic PHP extension;
-the product of the build is a shared library that you must configure PHP to load.
+the product of the build is a shared library that you must configure PHP to
+load.
First, change to the `php` source subdirectory:
$ cd php
-Edit `config/Make.rules` and review the build settings. For example, you may want
-to enable `OPTIMIZE`. If your PHP installation resides in a non-standard location,
-modify the `PHP_HOME` setting to contain the installation directory. If you are
-using PHP 5.3 or later and wish to use PHP namespaces, set `USE_NAMESPACES=yes`.
+Edit `config/Make.rules` and review the build settings. For example, you may
+want to enable `OPTIMIZE`. If your PHP installation resides in a non-standard
+location, modify the `PHP_HOME` setting to contain the installation directory.
+If you are using PHP 5.3 or later and wish to use PHP namespaces, set
+`USE_NAMESPACES=yes`.
If you have not built Ice for C++ from the `cpp` subdirectory, then set the
-`ICE_HOME` environment variable to the directory containing your Ice installation.
-For example, if Ice is installed in `/opt/Ice`, set `ICE_HOME` as follows:
+`ICE_HOME` environment variable to the directory containing your Ice
+installation. For example, if Ice is installed in `/opt/Ice`, set `ICE_HOME` as
+follows:
$ export ICE_HOME=/opt/Ice
@@ -46,8 +49,8 @@ Run `make` to build the extension.
To install the Ice extension, you must move the extension's shared library into
PHP's extension directory. This directory is determined by the PHP configuration
-directive `extension_dir`. You can determine the default value for this directive
-by running the command-line version of PHP with the `-i` option:
+directive `extension_dir`. You can determine the default value for this
+directive by running the command-line version of PHP with the `-i` option:
$ php -i
@@ -106,14 +109,14 @@ and its third-party dependencies. These libraries are named as follows:
libbz2
In general, these libraries must reside in a directory of the user's PATH. For
-Web servers, the libraries may need to reside in a system directory. For example,
-on Linux you can add the directory containing the Ice run-time libraries to
-`/etc/ld.so.conf` and run `ldconfig`.
+Web servers, the libraries may need to reside in a system directory. For
+example, on Linux you can add the directory containing the Ice run-time
+libraries to `/etc/ld.so.conf` and run `ldconfig`.
You can verify that the Ice extension is installed properly by examining the
output of the `php -m` command, or by calling the `phpInfo()` function from a
-script. For example, you can create a file in the Web server's document directory
-containing the following PHP script:
+script. For example, you can create a file in the Web server's document
+directory containing the following PHP script:
<?php
phpInfo();
@@ -130,9 +133,9 @@ need access to the shared libraries for IceSSL and OpenSSL.
In addition to the binary Ice extension module and its library dependencies, you
will also need to make the Ice for PHP source files available to your scripts.
-These files are located in the `lib` subdirectory and consist of the Ice run time
-definitions (`Ice.php` or `Ice_ns.php`) along with PHP source files generated from
-the Slice files included in the Ice distribution.
+These files are located in the `lib` subdirectory and consist of the Ice run
+time definitions (`Ice.php` or `Ice_ns.php`) along with PHP source files
+generated from the Slice files included in the Ice distribution.
The Ice extension makes no assumptions about the location of these files, so you
can install them anywhere you like. For example, you can simply include them in
@@ -140,7 +143,8 @@ the same directory as your application scripts. Alternatively, if you prefer to
install them in a common directory, you may need to modify PHP's `include_path`
directive so that the PHP interpreter is able to locate these files. Another
option is to modify the include path from within your script prior to including
-any Ice run-time file. Here is an example that assumes Ice is installed in `/opt`:
+any Ice run-time file. Here is an example that assumes Ice is installed in
+`/opt`:
// PHP
ini_set('include_path',
diff --git a/php/BuildInstructionsWindows.md b/php/BuildInstructionsWindows.md
index a6915efbaf4..fa75d413d2b 100644
--- a/php/BuildInstructionsWindows.md
+++ b/php/BuildInstructionsWindows.md
@@ -18,25 +18,26 @@ distribution or compile from source yourself.
## Building the PHP Extension
-The Ice installer for Windows includes a pre-compiled extension for PHP 5.6 built
-with Visual Studio 2012 (Visual C++ 11) and compatible with the "Thread-safe VC11"
-distribution of PHP available on [php.net](). We encourage you to use this
-extension if possible, together with a compatible Web server.
+The Ice installer for Windows includes a pre-compiled extension for PHP 5.6
+built with Visual Studio 2012 (Visual C++ 11) and compatible with the "Thread-
+safe VC11" distribution of PHP available on [php.net](). We encourage you to use
+this extension if possible, together with a compatible Web server.
-> *The Apache binaries provided by the Apache Software Foundation are compiled with
-Visual C++ 6 and therefore are not compatible with the Ice for PHP extension included
-in our Windows installer. A VC11 build of Apache is available from alternate sources.*
+> *The Apache binaries provided by the Apache Software Foundation are compiled
+with Visual C++ 6 and therefore are not compatible with the Ice for PHP
+extension included in our Windows installer. A VC11 build of Apache is available
+from alternate sources.*
-The most common motivation for compiling the Ice extension yourself is to create an
-extension that is compatible with your existing environment, such as when your Web
-server or PHP interpreter is built with a different compiler.
+The most common motivation for compiling the Ice extension yourself is to create
+an extension that is compatible with your existing environment, such as when
+your Web server or PHP interpreter is built with a different compiler.
-To build the Ice extension, first download the PHP5 binary archive or Windows installer
-and install the distribution.
+To build the Ice extension, first download the PHP5 binary archive or Windows
+installer and install the distribution.
-You will also need to download and extract the PHP5 sources (Ice for PHP requires
-the PHP header files). Change to the PHP5 source directory and run the following
-commands:
+You will also need to download and extract the PHP5 sources (Ice for PHP
+requires the PHP header files). Change to the PHP5 source directory and run the
+following commands:
> buildconf
> configure
@@ -56,25 +57,25 @@ Change to the Ice for PHP source directory:
Open `config\Make.rules.mak.php`, review the comments, and make any necessary
changes. In particular, you may need to change the values of `PHP_HOME` and
-`PHP_BIN_HOME` to refer to your PHP source and binary installations, respectively.
-If you compiled PHP from source, you should also review the setting of
-`PHP_LIBDIR`. If you are using PHP 5.3 or later and wish to use PHP namespaces,
-set `USE_NAMESPACES=yes`. Finally, if you are using a non-thread-safe PHP
-installation, set `PHP_ZTS=no`.
+`PHP_BIN_HOME` to refer to your PHP source and binary installations,
+respectively. If you compiled PHP from source, you should also review the
+setting of `PHP_LIBDIR`. If you are using PHP 5.3 or later and wish to use PHP
+namespaces, set `USE_NAMESPACES=yes`. Finally, if you are using a non-thread-
+safe PHP installation, set `PHP_ZTS=no`.
Run NMAKE to build the extension:
> nmake /f Makefile.mak
-Upon successful completion, the Ice for PHP extension is created as `lib\php_ice.dll`
-(Release) or `lib\php_iced.dll` (Debug).
+Upon successful completion, the Ice for PHP extension is created as
+`lib\php_ice.dll` (Release) or `lib\php_iced.dll` (Debug).
## Installing the PHP Extension
-To install the Ice extension, you must move the extension's shared library into PHP's
-extension directory. This directory is determined by the PHP configuration directive
-`extension_dir`. You can determine the default value for this directive by running
-the command-line version of PHP with the `-i` option:
+To install the Ice extension, you must move the extension's shared library into
+PHP's extension directory. This directory is determined by the PHP configuration
+directive `extension_dir`. You can determine the default value for this
+directive by running the command-line version of PHP with the `-i` option:
> php -i
@@ -130,9 +131,9 @@ and its third-party dependencies. On Windows, these DLLs are required:
bzip2.dll
In general, these libraries must reside in a directory of the user's PATH. For
-Web servers, the libraries may need to reside in a system directory. For example,
-on Windows you can copy the DLLs to the `C:\WINDOWS\system32` directory, or to
-the Apache installation directory.
+Web servers, the libraries may need to reside in a system directory. For
+example, on Windows you can copy the DLLs to the `C:\WINDOWS\system32`
+directory, or to the Apache installation directory.
You can verify that the Ice extension is installed properly by examining the
output of the `php -m` command, or by calling the `phpInfo()` function from a
diff --git a/python/BuildInstructionsLinuxOSX.md b/python/BuildInstructionsLinuxOSX.md
index a0037167967..584c9566119 100644
--- a/python/BuildInstructionsLinuxOSX.md
+++ b/python/BuildInstructionsLinuxOSX.md
@@ -8,9 +8,9 @@ for the supported platforms.
### Operating Systems and Compilers
-Ice for Python is expected to build and run properly on OS X and any recent Linux
-distribution for x86 and x86_64, and was extensively tested using the operating
-systems and compiler versions listed for our [supported platforms][2].
+Ice for Python is expected to build and run properly on OS X and any recent
+Linux distribution for x86 and x86_64, and was extensively tested using the
+operating systems and compiler versions listed for our [supported platforms][2].
### Python Versions
diff --git a/python/BuildInstructionsWindows.md b/python/BuildInstructionsWindows.md
index 317876e6be9..5b7dca0c1fd 100644
--- a/python/BuildInstructionsWindows.md
+++ b/python/BuildInstructionsWindows.md
@@ -1,22 +1,22 @@
# Building Ice for Python on Windows
-This document describes how to build and install Ice for Python from source code on
-Windows. If you prefer, you can also download [binary distributions][1] for the
-supported platforms.
+This document describes how to build and install Ice for Python from source code
+on Windows. If you prefer, you can also download [binary distributions][1] for
+the supported platforms.
## Python Build Requirements
### Operating Systems and Compilers
-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].
+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].
### Python Versions
-Ice for Python supports Python versions 2.6, 2.7, 3.3 or 3.4. 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.6, 2.7, 3.3 or 3.4. 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 Development Kit
diff --git a/ruby/BuildInstructionsLinux.md b/ruby/BuildInstructionsLinuxOSX.md
index a0544246783..56b4ec9fd76 100644
--- a/ruby/BuildInstructionsLinux.md
+++ b/ruby/BuildInstructionsLinuxOSX.md
@@ -1,22 +1,23 @@
# Building Ice for Ruby on Linux
-This document describes how to build and install Ice for Ruby from source code.
-If you prefer, you can also download [binary distributions][1] for the supported
-platforms.
+This file describes how to build and install Ice for Ruby from source code on
+Linux and OS X. If you prefer, you can also download [binary distributions][1]
+for the supported platforms.
## Ruby Build Requirements
### Operating Systems and Compilers
-Ice for Ruby is expected to build and run properly on any recent Linux distribution
-for x86 and x86_64, and was extensively tested using the operating systems and Ruby
-versions listed for our [supported platforms][2].
+Ice for Ruby is expected to build and run properly on OS X and on any recent
+Linux distribution for x86 and x86_64, and was extensively tested using the
+operating systems and Ruby versions listed for our [supported platforms][2].
### Ruby Versions
-Ice for Ruby supports Ruby versions 1.8.1 or later. You can use a source or binary
-installation of Ruby. If you use an RPM installation, the following packages are
-required:
+Ice for Ruby supports Ruby versions 1.8.1 or later. You can use a source or
+binary installation of Ruby.
+
+If you use an RPM installation, the following packages are required:
ruby
ruby-devel
@@ -32,8 +33,8 @@ distribution or compile from source yourself.
The instructions for compiling the Ice extension assume that you have already
installed Ruby.
-If you installed Ruby in a non-standard location, set the `RUBY_HOME` environment
-variable to the installation directory. For example:
+If you installed Ruby in a non-standard location, set the `RUBY_HOME`
+environment variable to the installation directory. For example:
$ export RUBY_HOME=/opt/ruby
@@ -58,11 +59,10 @@ You can perform an automated installation with the following command:
$ make install
This process uses the `prefix` variable in `config/Make.rules` as the
-installation's root directory. The subdirectory `<prefix>/ruby` is created
-as a copy of the local `ruby` directory and contains the Ice for Ruby
-extension library (`IceRuby.so`) as well as Ruby source code. Using this
-installation method requires that you modify your environment as described
-in *Using Ice for Ruby* below.
+installation's root directory. The subdirectory `<prefix>/ruby` is created as a
+copy of the local `ruby` directory and contains the Ice for Ruby extension
+library as well as Ruby source code. Using this installation method requires
+that you modify your environment as described in *Using Ice for Ruby* below.
Another option is to copy the contents of the local `ruby` directory to your
Ruby installation's `site_ruby` directory. For example, if you installed Ruby
@@ -88,9 +88,11 @@ environment variable as follows:
This example assumes that your Ice for Ruby installation is located in the
`/opt/Ice` directory.
-You must also modify `LD_LIBRARY_PATH` to include the directory `/opt/Ice/lib`:
+You must also modify `LD_LIBRARY_PATH` or `DYLD_LIBRARY_PATH` to include the
+directory `/opt/Ice/lib`:
- $ export LD_LIBRARY_PATH=/opt/Ice/lib:$LD_LIBRARY_PATH
+ $ export LD_LIBRARY_PATH=/opt/Ice/lib:$LD_LIBRARY_PATH (Linux)
+ $ export DYLD_LIBRARY_PATH=/opt/Ice/lib:$DYLD_LIBRARY_PATH (OS X)
To verify that Ruby can load the Ice extension successfully, open a command
window and start the interpreter using `irb`:
@@ -107,8 +109,8 @@ successfully. Enter `exit` to quit the interpreter.
## Running the Ruby Tests
-The `test` subdirectory contains Ruby implementations of the core Ice test suite.
-Python is required to run the test suite.
+The `test` subdirectory contains Ruby implementations of the core Ice test
+suite. Python is required to run the test suite.
The test suites require that the Ice for C++ tests be built in the `cpp`
subdirectory of this source distribution.
diff --git a/ruby/BuildInstructionsWindows.md b/ruby/BuildInstructionsWindows.md
index 87dbe7d54c2..767e6bbf93f 100644
--- a/ruby/BuildInstructionsWindows.md
+++ b/ruby/BuildInstructionsWindows.md
@@ -8,9 +8,9 @@ supported platforms.
### Operating Systems
-Ice for Ruby is expected to build and run properly on Windows, and was extensively
-tested using the operating systems and Ruby versions listed for our [supported
-platforms][2].
+Ice for Ruby is expected to build and run properly on Windows, and was
+extensively tested using the operating systems and Ruby versions listed for our
+[supported platforms][2].
### Prerequisites
@@ -21,16 +21,16 @@ To build Ice for Ruby you must have the following:
- Ruby Development Kit 4.7.2
- mingw 4.7.3 (only for 32-bit builds)
-The Ruby distribution for Windows uses the MinGW compiler, therefore MinGW is the
-only C++ compiler supported by Ice for Ruby.
+The Ruby distribution for Windows uses the MinGW compiler, therefore MinGW is
+the only C++ compiler supported by Ice for Ruby.
The instructions in this file make the following assumptions about your build
environment:
1. You have installed the Ice 3.6.0 distribution using the ZeroC installer. The
default installation directory is `C:\Program Files (x86)\ZeroC\Ice-3.6.0`.
-2. You have installed Ruby 2.2.1 using the Windows installer. The default installation
-directory is `C:\Ruby221`.
+2. You have installed Ruby 2.2.1 using the Windows installer. The default
+installation directory is `C:\Ruby221`.
3. You have installed the Ruby Development Kit 4.7.2 in `C:\RubyDevKit-4.7.2`.
4. For 32-bit builds, you have installed mingw 4.7.3 in `C:\mingw-4.7.3`.
@@ -93,24 +93,25 @@ You can perform an automated installation with the following command:
> make install
-This process uses the `prefix` variable in `config\Make.rules` as the installation's
-root directory. The subdirectory `<prefix>\ruby` is created as a copy of the local
-ruby directory and contains the Ice for Ruby extension library (`IceRuby.so`) as
-well as Ruby source code. Using this installation method requires that you modify
-your environment as described below.
+This process uses the `prefix` variable in `config\Make.rules` as the
+installation's root directory. The subdirectory `<prefix>\ruby` is created as a
+copy of the local ruby directory and contains the Ice for Ruby extension library
+(`IceRuby.so`) as well as Ruby source code. Using this installation method
+requires that you modify your environment as described below.
## Configuring your Environment for Ruby
-The Ruby interpreter must be able to locate the Ice extension. One way to configure
-the interpreter is to define the `RUBYLIB` environment variable as follows:
+The Ruby interpreter must be able to locate the Ice extension. One way to
+configure the interpreter is to define the `RUBYLIB` environment variable as
+follows:
> set RUBYLIB=C:\Ice-3.6.0\ruby
This example assumes your Ice for Ruby installation is located in the `C:\Ice-3.6.0`
directory.
-In addition, you must modify your PATH environment variable to include the following
-directories:
+In addition, you must modify your PATH environment variable to include the
+following directories:
C:\Program Files (x86)\ZeroC\Ice-3.6.0\bin
C:\Ice-3.6.0\bin
@@ -121,8 +122,8 @@ At a command prompt, you can set your PATH as shown below:
## Running the Ruby Tests
-The `test` subdirectory contains Ruby implementations of the core Ice test suite.
-Python is required to run the test suite.
+The `test` subdirectory contains Ruby implementations of the core Ice test
+suite. Python is required to run the test suite.
The test suites require that the Ice for C++ tests be built in the `cpp`
subdirectory of this source distribution.