diff options
author | Benoit Foucher <benoit@zeroc.com> | 2015-06-19 16:20:35 +0200 |
---|---|---|
committer | Benoit Foucher <benoit@zeroc.com> | 2015-06-19 16:20:35 +0200 |
commit | a56cbe5426f6958d0faabd82ba2a689abbee43e8 (patch) | |
tree | 912c5e26c124d846c1d8f0faa655ac9f0cc9a347 /ruby | |
parent | Put back server.pem (diff) | |
download | ice-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 'ruby')
-rw-r--r-- | ruby/BuildInstructionsLinuxOSX.md (renamed from ruby/BuildInstructionsLinux.md) | 42 | ||||
-rw-r--r-- | ruby/BuildInstructionsWindows.md | 37 |
2 files changed, 41 insertions, 38 deletions
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. |