diff options
| -rw-r--r-- | INSTALL.md | 47 | ||||
| -rw-r--r-- | system/README | 10 | ||||
| -rw-r--r-- | system/doc/installation_guide/Makefile | 8 | ||||
| -rw-r--r-- | system/doc/installation_guide/install.xml | 8 |
4 files changed, 50 insertions, 23 deletions
diff --git a/INSTALL.md b/INSTALL.md index 10071ca844..452b0ff252 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -129,11 +129,12 @@ These are the tools you will need in order to unpack and build Erlang/OTP. * OpenSSL -- Optional, but needed for building the Erlang/OTP applications `ssl` and `crypto`. You need the "development package" of OpenSSL, i.e. including the header files. For building the application `ssl` the OpenSSL - binary command program `openssl` is also needed. - At least version 0.9.7 of OpenSSL is required. + binary command program `openssl` is also needed. At least version 0.9.7 + of OpenSSL is required. Can be downloaded from <http://www.openssl.org>. * Sun Java jdk-1.5.0 or higher -- Optional but needed for building the - Erlang/OTP application `jinterface` and parts of `ic` and `orber`. We - have also tested IBM's JDK 1.5.0. + Erlang/OTP application `jinterface` and parts of `ic` and `orber`. Can + be downloaded from <http://java.sun.com>. We have also tested IBM's + JDK 1.5.0. * X Windows -- Optional, but development headers and libraries are needed to build the Erlang/OTP application `gs` on Unix/Linux. * `sed` -- There seem to be some problems with some of the `sed` version on @@ -148,10 +149,13 @@ build an unmodified version of the released source. #### Building Documentation #### -* `xsltproc` -- XSLT processor. -* `fop` -- Apache FOP (requires Java). +* `xsltproc` -- XSLT processor. A tool for applying XSLT stylesheets + to XML documents. Can be downloaded from + <http://xmlsoft.org/XSLT/xsltproc2.html>. +* `fop` -- Apache FOP print formatter (requires Java). Can be downloaded from + <http://xmlgraphics.apache.org/fop>. * `Markdown.pl` -- Optional. This is a `perl` script that generates an - HTML version of a document written in Markdown notation. It can be + HTML version of a document written in Markdown notation. Can be downloaded at <http://daringfireball.net/projects/markdown>. ### Installing ### @@ -467,7 +471,8 @@ or using the `release_docs` target. * If you have installed Erlang/OTP using the `install` target, install the documentation using the `install-docs` target. Install locations - determined by `configure` will be used. + determined by `configure` will be used. `$DESTDIR` can be used the + same way as when doing `make install`. $ make install-docs @@ -477,7 +482,18 @@ or using the `release_docs` target. $ make release_docs RELEASE_ROOT=<release dir> -How to Install the Pre-formatted Erlang/OTP documentation +### Build Issues ### + +We have sometimes experienced problems with suns `java` running out of +memory when running `fop`. Increasing the amount of memory available +as follows has in our case solved the problem. + + $ export FOP_OPTS="-Xmx<Installed amount of RAM in MB>m" + +More information can be found at +<http://xmlgraphics.apache.org/fop/0.95/running.html#memory>. + +How to Install the Pre-formatted Erlang/OTP Documentation --------------------------------------------------------- Pre-formatted documentation can be downloaded at @@ -486,15 +502,24 @@ Pre-formatted documentation can be downloaded at For some graphical tools to find the on-line help you have to install the HTML documentation on top of the installed OTP applications, i.e. - $ cd <PrefixDir>/lib/erlang + $ cd <ReleaseDir> $ gunzip -c otp_html_R13B04.tar.gz | tar xf - For `erl -man <page>` to work the Unix manual pages have to be installed in the same way, i.e. - $ cd <PrefixDir>/lib/erlang + $ cd <ReleaseDir> $ gunzip -c otp_man_R13B04.tar.gz | tar xf - +Where `<ReleaseDir>` is + +* `<PrefixDir>/lib/erlang` if you have installed Erlang/OTP using + `make install`. +* `$DESTDIR<PrefixDir>/lib/erlang` if you have installed Erlang/OTP + using `make install DESTDIR=<TmpInstallDir>`. +* `RELEASE_ROOT` if you have installed using + `make release RELEASE_ROOT=<ReleaseDir>`. + Support for SMP (Symmetric Multi Processing) -------------------------------------------- diff --git a/system/README b/system/README index 29d86b8f47..15ccfd2f84 100644 --- a/system/README +++ b/system/README @@ -1,7 +1,7 @@ -Erlang/OTP March 18, 2009 +Erlang/OTP February 18, 2010 -LAST MINUTE INFORMATION -- Release of Erlang 5.7/OTP R13A +LAST MINUTE INFORMATION -- Release of Erlang 5.7.5/OTP R13B04 1. GENERAL @@ -11,7 +11,7 @@ LAST MINUTE INFORMATION -- Release of Erlang 5.7/OTP R13A The installation guide can be found in - <inst-root>/doc/installation_guide/part_frame.html + <inst-root>doc/installation_guide/users_guide.html 1.2 Java @@ -19,7 +19,7 @@ LAST MINUTE INFORMATION -- Release of Erlang 5.7/OTP R13A 1.3 Disk space - An installation of Erlang/OTP needs approximately 140 MB of + An installation of Erlang/OTP needs approximately 300 MB of disk space. 1.4 The package contains HTML documentation. You can also get this @@ -35,7 +35,7 @@ LAST MINUTE INFORMATION -- Release of Erlang 5.7/OTP R13A R11B-1). BEAM files from R10B or earlier are not supported. To get the best performance, you should recompile your - application code with the R13A compiler. + application code with the R13B04 compiler. 2. NOTES ABOUT THE SOLARIS VERSION diff --git a/system/doc/installation_guide/Makefile b/system/doc/installation_guide/Makefile index 53a02a1edf..854025765c 100644 --- a/system/doc/installation_guide/Makefile +++ b/system/doc/installation_guide/Makefile @@ -56,11 +56,12 @@ XML_FILES = \ # ---------------------------------------------------- # Install readme files # ---------------------------------------------------- -INSTALL_READMES = \ +SOURCE_INSTALL_READMES = \ $(ERL_TOP)/INSTALL.html \ $(ERL_TOP)/INSTALL-CROSS.html \ $(ERL_TOP)/INSTALL-WIN32.html +SOURCE_RELSYSDIR = $(RELSYSDIR)/source # ---------------------------------------------------- HTML_FILES = \ @@ -100,8 +101,9 @@ include $(ERL_TOP)/make/otp_release_targets.mk release_docs_spec: docs $(INSTALL_DIR) $(RELSYSDIR) - $(INSTALL_DATA) $(INSTALL_READMES) $(GIF_FILES) $(HTMLDIR)/*.html \ - $(RELSYSDIR) + $(INSTALL_DATA) $(GIF_FILES) $(HTMLDIR)/*.html $(RELSYSDIR) + $(INSTALL_DIR) $(SOURCE_RELSYSDIR) + $(INSTALL_DATA) $(SOURCE_INSTALL_READMES) $(SOURCE_RELSYSDIR) release_spec: diff --git a/system/doc/installation_guide/install.xml b/system/doc/installation_guide/install.xml index 027b3c49a0..c1b930a4bd 100644 --- a/system/doc/installation_guide/install.xml +++ b/system/doc/installation_guide/install.xml @@ -35,16 +35,16 @@ <section> <title>Source</title> <p>This document describes installation procedures for - binary releases. Documentation of the build and installation + binary releases. Documentation of build and installation procedures for the source release can be found in the source tree at the following locations:</p> <taglist> <tag>Building and Installing Erlang/OTP</tag> - <item><url href="INSTALL.html"><c>$ERL_TOP/INSTALL.md</c></url></item> + <item><url href="source/INSTALL.html"><c>$ERL_TOP/INSTALL.md</c></url></item> <tag>Cross Compiling Erlang/OTP</tag> - <item><url href="INSTALL-CROSS.html"><c>$ERL_TOP/INSTALL-CROSS.md</c></url></item> + <item><url href="source/INSTALL-CROSS.html"><c>$ERL_TOP/INSTALL-CROSS.md</c></url></item> <tag>How to Build Erlang/OTP on Windows</tag> - <item><url href="INSTALL-WIN32.html"><c>$ERL_TOP/INSTALL-WIN32.md</c></url></item> + <item><url href="source/INSTALL-WIN32.html"><c>$ERL_TOP/INSTALL-WIN32.md</c></url></item> </taglist> <p>Where <c>$ERL_TOP</c> is the top directory in the source tree.</p> </section> |