From 3fdc76b92134b5e2d279097fa97f031cb06e04a2 Mon Sep 17 00:00:00 2001 From: Rickard Green Date: Thu, 18 Feb 2010 17:33:26 +0000 Subject: OTP-8449 Documentation improvements. The most important "readme" files now use Markdown notation. HTML versions of these files are now also automatically generated and included in the HTML documentation. - Building and Installing Erlang/OTP - $ERL_TOP/INSTALL.md (previously known as $ERL_TOP/README). - Cross Compiling Erlang/OTP - $ERL_TOP/INSTALL-CROSS.md. - How to Build Erlang/OTP on Windows - $ERL_TOP/INSTALL-WIN32.md (previously known as $ERL_TOP/README.win32). --- system/README | 10 +++++----- system/doc/installation_guide/Makefile | 8 +++++--- system/doc/installation_guide/install.xml | 8 ++++---- 3 files changed, 14 insertions(+), 12 deletions(-) (limited to 'system') 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 - /doc/installation_guide/part_frame.html + 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 @@
Source

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:

Building and Installing Erlang/OTP - $ERL_TOP/INSTALL.md + $ERL_TOP/INSTALL.md Cross Compiling Erlang/OTP - $ERL_TOP/INSTALL-CROSS.md + $ERL_TOP/INSTALL-CROSS.md How to Build Erlang/OTP on Windows - $ERL_TOP/INSTALL-WIN32.md + $ERL_TOP/INSTALL-WIN32.md

Where $ERL_TOP is the top directory in the source tree.

-- cgit v1.2.3