summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBenoit Foucher <benoit@zeroc.com>2017-06-30 16:58:50 +0200
committerBenoit Foucher <benoit@zeroc.com>2017-06-30 16:58:50 +0200
commitcca0a663c888dba18b319cf7b2017ec46347cf05 (patch)
treed99c5b95bbdc77bb343585265c4c579193edd247
parentFixed ICE-8194 - Ice/objects crash with Ice debug library (diff)
downloadice-cca0a663c888dba18b319cf7b2017ec46347cf05.tar.bz2
ice-cca0a663c888dba18b319cf7b2017ec46347cf05.tar.xz
ice-cca0a663c888dba18b319cf7b2017ec46347cf05.zip
Fixed documentation files to use 80 columns
-rw-r--r--README.md49
-rw-r--r--cpp/BuildInstructionsLinux.md30
-rw-r--r--cpp/BuildInstructionsMacOS.md34
-rw-r--r--cpp/BuildInstructionsWindows.md42
-rw-r--r--csharp/BuildInstructions.md7
-rw-r--r--java-compat/BuildInstructions.md12
-rw-r--r--java/BuildInstructions.md25
-rw-r--r--js/BuildInstructions.md3
-rw-r--r--objective-c/BuildInstructions.md34
-rw-r--r--php/BuildInstructionsWindows.md24
-rw-r--r--python/BuildInstructionsWindows.md39
-rw-r--r--ruby/BuildInstructionsLinuxMacOS.md4
12 files changed, 173 insertions, 130 deletions
diff --git a/README.md b/README.md
index 1e108d4ae26..52dc6a4c7f5 100644
--- a/README.md
+++ b/README.md
@@ -2,9 +2,17 @@
# Ice - Comprehensive RPC Framework
-Ice is a comprehensive RPC framework that helps you network your software with minimal effort. Ice takes care of all interactions with low-level network programming interfaces and allows you to focus your efforts on your application logic. When using Ice, there is no need to worry about details such as opening network connections, serializing and deserializing data for network transmission, or retrying failed connection attempts (to name just a few of dozens of such low-level details).
-
-You can download Ice releases from [ZeroC's website](https://zeroc.com/downloads/ice). Use this GitHub repository to build from source; see [branches](#branches) for more information.
+Ice is a comprehensive RPC framework that helps you network your software with
+minimal effort. Ice takes care of all interactions with low-level network
+programming interfaces and allows you to focus your efforts on your application
+logic. When using Ice, there is no need to worry about details such as opening
+network connections, serializing and deserializing data for network
+transmission, or retrying failed connection attempts (to name just a few of
+dozens of such low-level details).
+
+You can download Ice releases from [ZeroC's
+website](https://zeroc.com/downloads/ice). Use this GitHub repository to build
+from source; see [branches](#branches) for more information.
## Languages
@@ -47,10 +55,15 @@ Ice runs on a wide range of platforms:
and server-side dispatches
- Automatic discovery of remote objects through UDP multicast
- Comes with a number of optional services:
- - [IceGrid](https://zeroc.com/products/ice/services/icegrid) - a DNS-like service for Ice objects, with support for server deployment, replication, monitoring, load-balancing and more
- - [IceStorm](https://zeroc.com/products/ice/services/icestorm) - a lightweight topic-based pub-sub service
- - [Glacier2](https://zeroc.com/products/ice/services/glacier2) - a sysadmin-friendly solution for routing Ice communications through firewalls
- - [IcePatch2](https://zeroc.com/products/ice/services/icepatch2) - an efficient software distribution and patching service
+ - [IceGrid](https://zeroc.com/products/ice/services/icegrid) - a DNS-like
+ service for Ice objects, with support for server deployment, replication,
+ monitoring, load-balancing and more
+ - [IceStorm](https://zeroc.com/products/ice/services/icestorm) - a
+ lightweight topic-based pub-sub service
+ - [Glacier2](https://zeroc.com/products/ice/services/glacier2) - a
+ sysadmin-friendly solution for routing Ice communications through firewalls
+ - [IcePatch2](https://zeroc.com/products/ice/services/icepatch2) - an
+ efficient software distribution and patching service
## Branches
@@ -68,17 +81,25 @@ Ice runs on a wide range of platforms:
## Copyright and License
-Ice is a single-copyright project: all the source code in this [ice repository](https://github.com/zeroc-ice/ice) is Copyright &copy; ZeroC, Inc., with very few exceptions.
+Ice is a single-copyright project: all the source code in this [ice
+repository](https://github.com/zeroc-ice/ice) is Copyright &copy; ZeroC, Inc.,
+with very few exceptions.
-As copyright owner, ZeroC can license Ice under different license terms, and offers the following licenses for Ice:
-- GPL v2, a popular open-source license with strong [copyleft](http://en.wikipedia.org/wiki/Copyleft) conditions (the default license)
-- Commercial or closed-source licenses
+As copyright owner, ZeroC can license Ice under different license terms, and
+offers the following licenses for Ice: - GPL v2, a popular open-source license
+with strong [copyleft](http://en.wikipedia.org/wiki/Copyleft) conditions (the
+default license) - Commercial or closed-source licenses
-If you license Ice under GPL v2, there is no license fee or signed license agreement: you just need to comply with the GPL v2 terms and conditions. See [ICE_LICENSE](./ICE_LICENSE) and [LICENSE](./LICENSE) for further information.
+If you license Ice under GPL v2, there is no license fee or signed license
+agreement: you just need to comply with the GPL v2 terms and conditions. See
+[ICE_LICENSE](./ICE_LICENSE) and [LICENSE](./LICENSE) for further information.
-If you purchase a commercial or closed-source license for Ice, you must comply with the terms and conditions listed in the associated license agreement; the GPL v2 terms and conditions do not apply.
+If you purchase a commercial or closed-source license for Ice, you must comply
+with the terms and conditions listed in the associated license agreement; the
+GPL v2 terms and conditions do not apply.
-The Ice software itself remains the same: the only difference between an open-source Ice and a commercial Ice are the license terms.
+The Ice software itself remains the same: the only difference between an open-
+source Ice and a commercial Ice are the license terms.
## Documentation
diff --git a/cpp/BuildInstructionsLinux.md b/cpp/BuildInstructionsLinux.md
index f18a0da7d2f..5859871bae5 100644
--- a/cpp/BuildInstructionsLinux.md
+++ b/cpp/BuildInstructionsLinux.md
@@ -67,22 +67,23 @@ These packages are provided with the system and can be installed with:
sudo apt-get install pkg-config libdbus-1-dev libbluetooth-dev
```
-> *We have experienced problems with BlueZ versions up to and including 5.39,
-as well as 5.44 and 5.45. At this time we recommend using the daemon (`bluetoothd`)
+> *We have experienced problems with BlueZ versions up to and including 5.39, as
+well as 5.44 and 5.45. At this time we recommend using the daemon (`bluetoothd`)
from BlueZ 5.43.*
## Building Ice
-Review the top-level [config/Make.rules](../config/Make.rules) in your build tree and
-update the configuration if needed. The comments in the file provide more information.
+Review the top-level [config/Make.rules](../config/Make.rules) in your build
+tree and update the configuration if needed. The comments in the file provide
+more information.
In a command window, change to the `cpp` subdirectory:
```
cd cpp
```
-Run `make` to build the Ice C++ libraries, services and test suite. Set `V=1` to get
-a more detailed build output. You can build only the libraries and services with the
-`srcs` target, or only the tests with the `tests` target. For example:
+Run `make` to build the Ice C++ libraries, services and test suite. Set `V=1` to
+get a more detailed build output. You can build only the libraries and services
+with the `srcs` target, or only the tests with the `tests` target. For example:
```
make V=1 -j8 srcs
```
@@ -117,7 +118,8 @@ To build the C++11 mapping, use build configurations that are prefixed with
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
@@ -129,13 +131,13 @@ On an x86_64 system:
<prefix>/lib64 (RHEL, SLES, Amazon)
<prefix>/lib/x86_64-linux-gnu (Ubuntu)
-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.
-If building a C++11 program, you must define the `ICE_CPP11_MAPPING` macro during
-compilation with the `-D` option (`g++ -DICE_CPP11_MAPPING`) and add
-the `++11` suffix to the library name when linking (such as `-lIce++11`).
+If building a C++11 program, you must define the `ICE_CPP11_MAPPING` macro
+during compilation with the `-D` option (`g++ -DICE_CPP11_MAPPING`) and add the
+`++11` suffix to the library name when linking (such as `-lIce++11`).
## Running the Test Suite
diff --git a/cpp/BuildInstructionsMacOS.md b/cpp/BuildInstructionsMacOS.md
index 3a39efa02b2..e5089466ab8 100644
--- a/cpp/BuildInstructionsMacOS.md
+++ b/cpp/BuildInstructionsMacOS.md
@@ -29,16 +29,17 @@ You can install LMDB and mcpp using [Homebrew][7]:
```
## Building Ice
-Review the top-level [config/Make.rules](../config/Make.rules) in your build tree and
-update the configuration if needed. The comments in the file provide more information.
+Review the top-level [config/Make.rules](../config/Make.rules) in your build
+tree and update the configuration if needed. The comments in the file provide
+more information.
In a command window, change to the `cpp` subdirectory:
```
cd cpp
```
-Run `make` to build the Ice C++ libraries, services and test suite. Set `V=1` to get
-a more detailed build output. You can build only the libraries and services with the
-`srcs` target, or only the tests with the `tests` target. For example:
+Run `make` to build the Ice C++ libraries, services and test suite. Set `V=1` to
+get a more detailed build output. You can build only the libraries and services
+with the `srcs` target, or only the tests with the `tests` target. For example:
```
make V=1 -j8 srcs
```
@@ -109,12 +110,12 @@ configuration(s) you selected.
However, in order to run the test suite on `iphoneos`, you need to build the
C++98 Test Controller app or C++11 Test Controller app from Xcode:
- - Build the test suite with `make` for the `xcodedsk` or `cpp11-xcodesdk` configuration,
- and the `iphoneos` platform.
+ - Build the test suite with `make` for the `xcodedsk` or `cpp11-xcodesdk`
+ configuration, and the `iphoneos` platform.
- Open the C++ Test Controller project located in the
- `cpp\test\ios\controller` directory.
- - Build the `C++98 Test Controller` or the `C++11 Test Controller` app (it must match
- the configuration(s) selected when building the test suite).
+ `cpp/test/ios/controller` directory.
+ - Build the `C++98 Test Controller` or the `C++11 Test Controller` app (it must
+ match the configuration(s) selected when building the test suite).
## Running the Test Suite
@@ -123,9 +124,9 @@ require the Python module `passlib`, which you can install with the command:
```
pip install passlib
```
-After a successful source build, you can run the tests as shown below. If everything
-worked out, you should see lots of `ok` messages. In case of a failure, the tests abort
-with `failed`.
+After a successful source build, you can run the tests as shown below. If
+everything worked out, you should see lots of `ok` messages. In case of a
+failure, the tests abort with `failed`.
### macOS
```
@@ -138,14 +139,15 @@ with `failed`.
python allTests.py --config=cpp11-xcodesdk --platform=iphonesimulator --controller-app
```
### iOS
- - Start the `C++98 Test Controller` or the `C++11 Test Controller` app on your iOS
- device, from Xcode.
+ - Start the `C++98 Test Controller` or the `C++11 Test Controller` app on your
+ iOS device, from Xcode.
- On your Mac:
```
python allTests.py --config=xcodesdk --platform=iphoneos # C++98 controller
python allTests.py --confg=cpp11-xcodesdk --platform=iphoneos # C++11 controller
```
- All the test clients and servers run on the iOS device, not on your Mac computer.
+ All the test clients and servers run on the iOS device, not on your Mac
+ computer.
[1]: https://doc.zeroc.com/display/Rel/Using+the+macOS+Binary+Distribution+for+Ice+3.7.0
[2]: https://doc.zeroc.com/display/Rel/Supported+Platforms+for+Ice+3.7.0
diff --git a/cpp/BuildInstructionsWindows.md b/cpp/BuildInstructionsWindows.md
index ec0cf9e9a2d..fe4a2dc3c1a 100644
--- a/cpp/BuildInstructionsWindows.md
+++ b/cpp/BuildInstructionsWindows.md
@@ -3,9 +3,9 @@
This file describes how to build Ice for C++ from sources on Windows and how
to test the resulting build.
-ZeroC provides [Ice binary distributions][1] for various platforms and compilers,
-including Windows and Visual Studio, so building Ice from sources is usually
-unnecessary.
+ZeroC provides [Ice binary distributions][1] for various platforms and
+compilers, including Windows and Visual Studio, so building Ice from sources is
+usually unnecessary.
## Build Requirements
@@ -84,17 +84,18 @@ environment variables:
- SIGN_CERTIFICATE to your Authenticode certificate
- SIGN_PASSWORD to the certificate password
-If you want to run the test suite without building the entire source base, use this
-command:
+If you want to run the test suite without building the entire source base, use
+this command:
msbuild msbuild\ice.proj /p:ICE_BIN_DIST=all
-The build will automatically install ZeroC's official Ice binary NuGet packages if necessary.
+The build will automatically install ZeroC's official Ice binary NuGet packages
+if necessary.
## Building Ice for UWP
-The steps are the same as for Building Ice for C++ above, except you must also use a
-`UWP` target.
+The steps are the same as for Building Ice for C++ above, except you must also
+use a `UWP` target.
To build Ice for UWP:
@@ -118,17 +119,21 @@ You can create a NuGet package with the following command:
msbuild msbuild\ice.proj /t:NuGetPack /p:BuildAllConfigurations=yes
-This creates zeroc.ice.v120\zeroc.ice.v120.nupkg`, `zeroc.ice.v140\zeroc.ice.v140.nupkg` or
-`zeroc.ice.v141\zeroc.ice.v141.nupkg` depending on the compiler you are using.
+This creates `zeroc.ice.v120\zeroc.ice.v120.nupkg`,
+`zeroc.ice.v140\zeroc.ice.v140.nupkg` or `zeroc.ice.v141\zeroc.ice.v141.nupkg`
+depending on the compiler you are using.
To create UWP NuGet packages, use the `UWPNuGetPack` target instead:
msbuild msbuild\ice.proj /t:UWPNuGetPack /p:BuildAllConfigurations=yes
-This creates `zeroc.ice.uwp.v140\zeroc.ice.uwp.v140.nupkg`, `zeroc.ice.uwp.v140.x64\zeroc.ice.uwp.v140.x64.nupkg`
-and `zeroc.ice.uwp.v140.x86\zeroc.ice.uwp.v140.x86.nupkg` for Visual Studio 2015 builds or
-`zeroc.ice.uwp.v140\zeroc.ice.uwp.v140.nupkg`, `zeroc.ice.uwp.v140.x64\zeroc.ice.uwp.v140.x64.nupkg` and
-`zeroc.ice.uwp.v140.x86\zeroc.ice.uwp.v140.x86.nupkg` for Visual Studio 2017 builds.
+This creates: `zeroc.ice.uwp.v140\zeroc.ice.uwp.v140.nupkg`,
+`zeroc.ice.uwp.v140.x64\zeroc.ice.uwp.v140.x64.nupkg` and
+`zeroc.ice.uwp.v140.x86\zeroc.ice.uwp.v140.x86.nupkg` for Visual Studio 2015
+builds or `zeroc.ice.uwp.v140\zeroc.ice.uwp.v140.nupkg`,
+`zeroc.ice.uwp.v140.x64\zeroc.ice.uwp.v140.x64.nupkg` and
+`zeroc.ice.uwp.v140.x86\zeroc.ice.uwp.v140.x86.nupkg` for Visual Studio 2017
+builds.
## Running the Test Suite
@@ -141,7 +146,8 @@ After a successful source build, you can run the tests as follows:
python allTests.py
-For the C++11 mapping you need to use the `Cpp11-Debug` or `Cpp11-Release` configuration:
+For the C++11 mapping you need to use the `Cpp11-Debug` or `Cpp11-Release`
+configuration:
python allTests.py --config Cpp11-Debug
@@ -155,9 +161,9 @@ require the Python module `passlib`, which you can install with the command:
pip install passlib
-The scripts also require Ice for Python, you can build Ice for Python from [python](../python)
-folder of this source distribution or install the Python module `zeroc-ice`, using the
-following command:
+The scripts also require Ice for Python, you can build Ice for Python from
+[python](../python) folder of this source distribution or install the Python
+module `zeroc-ice`, using the following command:
pip install zeroc-ice
diff --git a/csharp/BuildInstructions.md b/csharp/BuildInstructions.md
index 23f7dcc4149..60edee20fcc 100644
--- a/csharp/BuildInstructions.md
+++ b/csharp/BuildInstructions.md
@@ -34,12 +34,13 @@ To build the Ice assemblies, services and tests, run
Upon completion, the Ice assemblies are placed in the `Assemblies` subdirectory.
-If you want to build the test suite without building the entire source base, use this
-command:
+If you want to build the test suite without building the entire source base, use
+this command:
msbuild msbuild\ice.proj /p:ICE_BIN_DIST=all
-The build will automatically install ZeroC's official Ice binary NuGet packages if necessary.
+The build will automatically install ZeroC's official Ice binary NuGet packages
+if necessary.
## Running the .NET Tests
diff --git a/java-compat/BuildInstructions.md b/java-compat/BuildInstructions.md
index 29ddea44cb3..5d6a796e035 100644
--- a/java-compat/BuildInstructions.md
+++ b/java-compat/BuildInstructions.md
@@ -59,10 +59,10 @@ therefore add significant latency to Ice requests.*
### Preparing to Build
-The build system requires the Slice to Java compiler from Ice for C++. If you have
-not built Ice for C++ in this source distribution, you must set the `ICE_HOME`
-environment variable with the path name of your Ice installation. For example,
-on Unix:
+The build system requires the Slice to Java compiler from Ice for C++. If you
+have not built Ice for C++ in this source distribution, you must set the
+`ICE_HOME` environment variable with the path name of your Ice installation. For
+example, on Unix:
$ export ICE_HOME=/opt/Ice-3.7.0 (For local build)
$ export ICE_HOME=/usr (For RPM installation)
@@ -71,8 +71,8 @@ On Windows:
> set ICE_HOME=C:\Program Files\ZeroC\Ice-3.7.0 (MSI installation)
-On Windows if you are using Ice for C++ from a source distribution, you must
-set the `CPP_PLATFORM` and `CPP_CONFIGURATION` environment variables to match the
+On Windows if you are using Ice for C++ from a source distribution, you must set
+the `CPP_PLATFORM` and `CPP_CONFIGURATION` environment variables to match the
platform and configuration used in your C++ build:
> set CPP_PLATFORM=x64
diff --git a/java/BuildInstructions.md b/java/BuildInstructions.md
index db3572fc401..a35036b7da6 100644
--- a/java/BuildInstructions.md
+++ b/java/BuildInstructions.md
@@ -30,10 +30,10 @@ Ice for Java requires J2SE 1.8 or later.
Make sure that the `javac` and `java` commands are present in your PATH.
The Metrics Graph feature of the IceGrid GUI tool requires 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 in an environment with JavaFX
-produces an IceGrid GUI JAR file that can be used in JVMs with or without JavaFX
-support, as the Metrics Graph feature is enabled dynamically.
+feature will not be available if you build the source with a JVM that lacks
+support for JavaFX. Alternatively, building the source in an environment with
+JavaFX produces an IceGrid GUI JAR file that can be used in JVMs with or without
+JavaFX support, as the Metrics Graph feature is enabled dynamically.
### Gradle
@@ -97,10 +97,10 @@ The Maven package id for the application bundler package is as follows:
### Preparing to Build
-The build system requires the Slice to Java compiler from Ice for C++. If you have
-not built Ice for C++ in this source distribution, you must set the `ICE_HOME`
-environment variable with the path name of your Ice installation. For example,
-on Unix:
+The build system requires the Slice to Java compiler from Ice for C++. If you
+have not built Ice for C++ in this source distribution, you must set the
+`ICE_HOME` environment variable with the path name of your Ice installation. For
+example, on Unix:
$ export ICE_HOME=/opt/Ice-3.7.0 (For local build)
$ export ICE_HOME=/usr (For RPM installation)
@@ -109,8 +109,8 @@ On Windows:
> set ICE_HOME=C:\Program Files\ZeroC\Ice-3.7.0 (MSI installation on Windows)
-On Windows if you are using Ice for C++ from a source distribution, you must
-set the `CPP_PLATFORM` and `CPP_CONFIGURATION` environment variables to match the
+On Windows if you are using Ice for C++ from a source distribution, you must set
+the `CPP_PLATFORM` and `CPP_CONFIGURATION` environment variables to match the
platform and configuration used in your C++ build:
> set CPP_PLATFORM=x64
@@ -192,8 +192,9 @@ You can start the tool with the following command:
> java -jar icegridgui.jar
-On macOS, the build also creates an application bundle named IceGrid GUI.
-You can start the IceGrid GUI tool by double-clicking the IceGrid GUI icon in Finder.
+On macOS, the build also creates an application bundle named IceGrid GUI. You
+can start the IceGrid GUI tool by double-clicking the IceGrid GUI icon in
+Finder.
[1]: https://zeroc.com/distributions/ice
[2]: https://doc.zeroc.com/display/Rel/Supported+Platforms+for+Ice+3.7.0
diff --git a/js/BuildInstructions.md b/js/BuildInstructions.md
index cfbd90f7271..3f2d6878616 100644
--- a/js/BuildInstructions.md
+++ b/js/BuildInstructions.md
@@ -9,7 +9,8 @@ supported platforms.
To build Ice for JavaScript you must have the following:
- The `slice2js` compiler from Ice for C++. If you have not built Ice for C++
- in this source distribution, refer to the [C++ build instructions](../cpp/BuildInstructions.md).
+ in this source distribution, refer to the
+ [C++ build instructions](../cpp/BuildInstructions.md).
- Node.js 4.6 or later
## Building the JavaScript libraries and NodeJS packages
diff --git a/objective-c/BuildInstructions.md b/objective-c/BuildInstructions.md
index 1700ec611d5..b07c5f58bcd 100644
--- a/objective-c/BuildInstructions.md
+++ b/objective-c/BuildInstructions.md
@@ -13,27 +13,28 @@ our [supported platforms][2].
## Building Ice for Objective-C
-The build of Ice for Objective-C requires that you first build Ice for C++ in the
-`cpp` subdirectory for the same configuration(s) and platform(s).
+The build of Ice for Objective-C requires that you first build Ice for C++ in
+the `cpp` subdirectory for the same configuration(s) and platform(s).
-Review the top-level [config/Make.rules](../config/Make.rules) in your build tree and
-update the configuration if needed. The comments in the file provide more information.
+Review the top-level [config/Make.rules](../config/Make.rules) in your build
+tree and update the configuration if needed. The comments in the file provide
+more information.
Change to the Ice for Objective-C source subdirectory:
```
cd objective-c
```
-Run `make` to build the Ice Objective-C libraries and test suite. Set `V=1` to get
-a more detailed build output. You can build only the libraries with the `srcs`
-target, or only the tests with the `tests` target. For example:
+Run `make` to build the Ice Objective-C libraries and test suite. Set `V=1` to
+get a more detailed build output. You can build only the libraries with the
+`srcs` target, or only the tests with the `tests` target. For example:
```
make V=1 -j8 srcs
```
### Build configurations and platforms
-The Objective-C source tree supports multiple build configurations and platforms.
-To see the supported configurations and platforms:
+The Objective-C source tree supports multiple build configurations and
+platforms. To see the supported configurations and platforms:
```
make print V=supported-configs
make print V=supported-platforms
@@ -42,9 +43,9 @@ To build all the supported configurations and platforms:
```
make CONFIGS=all PLATFORMS=all -j8
```
-The `arc-` configurations (for [Automatic Reference Counting][3]) apply only to the
-test suite; the Ice libraries don't use these configurations, and the same Ice for
-Objective-C library can be used with and without ARC.
+The `arc-` configurations (for [Automatic Reference Counting][3]) apply only to
+the test suite; the Ice libraries don't use these configurations, and the same
+Ice for Objective-C library can be used with and without ARC.
### Ice Xcode SDK
@@ -74,7 +75,7 @@ configuration(s) you selected.
However, in order to run the test suite on `iphoneos`, you need to build the
Objective-C Controller app from Xcode:
- Open the Objective-C Test Controller project located in the
- `objective-c\test\ios\controller` directory.
+ `objective-c/test/ios/controller` directory.
- Build the `Objective-C Controller` or `Objective-C ARC Controller` app.
## Running the Test Suite
@@ -93,13 +94,14 @@ of `ok` messages. In case of a failure, the tests abort with `failed`.
python allTests.py --config=xcodesdk --platform=iphonesimulator --controller-app
```
### iOS
- - Start the `Objective-C Controller` or `Objective-C ARC Controller` app on your iOS
- device, from Xcode.
+ - Start the `Objective-C Controller` or `Objective-C ARC Controller` app on
+ your iOS device, from Xcode.
- On your Mac:
```
python allTests.py --config=xcodesdk --platform=iphoneos
```
- All the test clients and servers run on the iOS device, not on your Mac computer.
+ All the test clients and servers run on the iOS device, not on your Mac
+ computer.
[1]: https://doc.zeroc.com/display/Rel/Using+the+macOS+Binary+Distribution+for+Ice+3.7.0
[2]: https://doc.zeroc.com/display/Rel/Supported+Platforms+for+Ice+3.7.0
diff --git a/php/BuildInstructionsWindows.md b/php/BuildInstructionsWindows.md
index 499569dce58..cb504266180 100644
--- a/php/BuildInstructionsWindows.md
+++ b/php/BuildInstructionsWindows.md
@@ -33,28 +33,30 @@ Now you're ready to build Ice for PHP:
msbuild msbuild\ice.proj
-This builds the extension with `Release` binaries for the default platform.
-The extension will be placed in `lib\x64\Release\php_ice.dll` for the `x64` platform
+This builds the extension with `Release` binaries for the default platform. The
+extension will be placed in `lib\x64\Release\php_ice.dll` for the `x64` platform
and `lib\Win32\Release\php_ice.dll` for the `Win32` platform.
-The default configuration builds the extension against the thread-safe PHP run time.
-You can build with the non-thread-safe run time using the `NTS-Release` or `NTS-Debug`
-configuration:
+The default configuration builds the extension against the thread-safe PHP run
+time. You can build with the non-thread-safe run time using the `NTS-Release` or
+`NTS-Debug` configuration:
msbuild msbuild\ice.proj /p:Configuration=NTS-Release
The extension will be placed in `lib\x64\Release\php_ice_nts.dll` directory for
-the `x64` platform and `lib\Win32\Release\php_ice_nts.dll` for the `Win32` platform.
+the `x64` platform and `lib\Win32\Release\php_ice_nts.dll` for the `Win32`
+platform.
The extension is built by default with namespaces enabled. You can build the PHP
-extension with namespaces disabled by setting the MSBuild property `PhpUseNamespaces`
-to `no`:
+extension with namespaces disabled by setting the MSBuild property
+`PhpUseNamespaces` to `no`:
msbuild msbuild\ice.proj /p:PhpUseNamespaces=no
-The PHP extension depends on Ice for C++ components from the `cpp` subdirectory, and those
-are built if required. It is also possible to build the PHP extension using the Ice for C++
-NuGet packages by setting the`ICE_BIN_DIST` msbuild property to `cpp`:
+The PHP extension depends on Ice for C++ components from the `cpp` subdirectory,
+and those are built if required. It is also possible to build the PHP extension
+using the Ice for C++ NuGet packages by setting the`ICE_BIN_DIST` msbuild
+property to `cpp`:
msbuild msbuild\ice.proj /p:ICE_BIN_DIST=cpp
diff --git a/python/BuildInstructionsWindows.md b/python/BuildInstructionsWindows.md
index ef6fdb4b4f1..a6d90b0b3ae 100644
--- a/python/BuildInstructionsWindows.md
+++ b/python/BuildInstructionsWindows.md
@@ -26,8 +26,9 @@ with the one used to build Ice for C++.
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.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.
+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.
Open a Visual Studio command prompt. For example, with Visual Studio 2015, you
can open one of:
@@ -49,39 +50,43 @@ Build the extension:
> msbuild msbuild\ice.proj
-This builds the extension with `Release` binaries for the default platform.
-The extension will be placed in `python\x64\Release\IcePy.pyd` for the `x64` platform
-and `python\Win32\Release\IcePy.pyd` for the `Win32` platform.
+This builds the extension with `Release` binaries for the default platform. The
+extension will be placed in `python\x64\Release\IcePy.pyd` for the `x64`
+platform and `python\Win32\Release\IcePy.pyd` for the `Win32` platform.
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
-The debug version of the extension will be placed in `python\x64\Debug\IcePy_d.pyd`
-for the `x64` platform and `python\Win32\Debug\IcePy_d.pyd` for the `Win32` platform.
+The debug version of the extension will be placed in
+`python\x64\Debug\IcePy_d.pyd` for the `x64` platform and
+`python\Win32\Debug\IcePy_d.pyd` for the `Win32` platform.
-> *For Debug builds a debug version of the Python interpreter must be installed.*
+> *For Debug builds a debug version of the Python interpreter must be
+> *installed.*
-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`.
+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 builds the `x64` platform binaries with the `Release` configuration:
+The following command builds the `x64` platform binaries with the `Release`
+configuration:
> msbuild msbuild\ice.proj /p:Configuration=Release /p:Platform=x64
-This command builds the `Win32` platform binaries with the `Release` configuration:
+This command builds the `Win32` platform binaries with the `Release`
+configuration:
> 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's 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 the 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:
+MSBuild property. For example, the following command will use Python
+installation from `C:\Python36-AMD64` instead of the default location:
> msbuild msbuild\ice.proj /p:Configuration=Release /p:Platform=x64 /p:PythonHome=C:\Python36-AMD64
diff --git a/ruby/BuildInstructionsLinuxMacOS.md b/ruby/BuildInstructionsLinuxMacOS.md
index bf4487dc967..213da227b3b 100644
--- a/ruby/BuildInstructionsLinuxMacOS.md
+++ b/ruby/BuildInstructionsLinuxMacOS.md
@@ -33,8 +33,8 @@ environment variable to the installation directory. For example:
$ export RUBY_HOME=/opt/ruby
-The build of Ice for Python requires that you first build Ice for C++ in the `cpp`
-subdirectory.
+The build of Ice for Python requires that you first build Ice for C++ in the
+`cpp` subdirectory.
From the top-level source directory, edit `config/Make.rules` to establish your
build configuration. The comments in the file provide more information.