From 7aa2cb2e64cd404f8a9f388d85ab287ced95f139 Mon Sep 17 00:00:00 2001
From: Rickard Green <rickard@erlang.org>
Date: Tue, 16 Feb 2010 01:24:37 +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/doc/installation_guide/Makefile    | 12 ++++++------
 system/doc/installation_guide/install.xml | 23 ++++++++++++++++++++---
 2 files changed, 26 insertions(+), 9 deletions(-)

(limited to 'system')

diff --git a/system/doc/installation_guide/Makefile b/system/doc/installation_guide/Makefile
index ec60105ae0..53a02a1edf 100644
--- a/system/doc/installation_guide/Makefile
+++ b/system/doc/installation_guide/Makefile
@@ -54,10 +54,12 @@ XML_FILES = \
 	$(XML_PART_FILES) 
 
 # ----------------------------------------------------
-# Readme for X-compiling
+# Install readme files
 # ----------------------------------------------------
-XCOMP_README_FILE = $(ERL_TOP)/xcomp/README.md
-README_FILE = $(ERL_TOP)/README
+INSTALL_READMES = \
+	$(ERL_TOP)/INSTALL.html \
+	$(ERL_TOP)/INSTALL-CROSS.html \
+	$(ERL_TOP)/INSTALL-WIN32.html
 
 # ----------------------------------------------------
 
@@ -98,10 +100,8 @@ include $(ERL_TOP)/make/otp_release_targets.mk
 
 release_docs_spec: docs
 	$(INSTALL_DIR) $(RELSYSDIR)
-	$(INSTALL_DATA) $(README_FILE) $(GIF_FILES) $(HTMLDIR)/*.html \
+	$(INSTALL_DATA) $(INSTALL_READMES) $(GIF_FILES) $(HTMLDIR)/*.html \
 		$(RELSYSDIR)
-	$(INSTALL_DIR) $(RELSYSDIR)/xcomp
-	$(INSTALL_DATA) $(XCOMP_README_FILE) $(RELSYSDIR)/xcomp
 
 release_spec:
 
diff --git a/system/doc/installation_guide/install.xml b/system/doc/installation_guide/install.xml
index 2e37ff35e9..027b3c49a0 100644
--- a/system/doc/installation_guide/install.xml
+++ b/system/doc/installation_guide/install.xml
@@ -4,7 +4,7 @@
 <chapter>
   <header>
     <copyright>
-      <year>2000</year><year>2009</year>
+      <year>2000</year><year>2010</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -13,12 +13,12 @@
       compliance with the License. You should have received a copy of the
       Erlang Public License along with this software. If not, it can be
       retrieved online at http://www.erlang.org/.
-    
+
       Software distributed under the License is distributed on an "AS IS"
       basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
       the License for the specific language governing rights and limitations
       under the License.
-    
+
     </legalnotice>
 
     <title>Installation</title>
@@ -32,6 +32,23 @@
     <file>install.xml</file>
   </header>
 
+  <section>
+    <title>Source</title>
+      <p>This document describes installation procedures for
+         binary releases. Documentation of the 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>
+	 <tag>Cross Compiling Erlang/OTP</tag>
+         <item><url href="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>
+      </taglist>
+      <p>Where <c>$ERL_TOP</c> is the top directory in the source tree.</p>
+  </section>
+
   <section>
     <title>UNIX</title>
 
-- 
cgit v1.2.3