summaryrefslogtreecommitdiff
path: root/php
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 /php
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 'php')
-rw-r--r--php/BuildInstructionsLinuxOSX.md40
-rw-r--r--php/BuildInstructionsWindows.md59
2 files changed, 52 insertions, 47 deletions
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