summaryrefslogtreecommitdiff
path: root/cpp
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 /cpp
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
Diffstat (limited to 'cpp')
-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
5 files changed, 69 insertions, 63 deletions
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