diff options
| author | Rickard Green <[email protected]> | 2010-02-18 17:33:26 +0000 |
|---|---|---|
| committer | Erlang/OTP <[email protected]> | 2010-02-18 17:33:26 +0000 |
| commit | 3fdc76b92134b5e2d279097fa97f031cb06e04a2 (patch) | |
| tree | 8bdd7838fa25e4fafb20156868d013f7e96e45a3 /system/doc | |
| parent | 3a44b99cc6f14a87242e2dddc57f191f853cfd90 (diff) | |
| download | otp-3fdc76b92134b5e2d279097fa97f031cb06e04a2.tar.gz otp-3fdc76b92134b5e2d279097fa97f031cb06e04a2.tar.bz2 otp-3fdc76b92134b5e2d279097fa97f031cb06e04a2.zip | |
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).
Diffstat (limited to 'system/doc')
| -rw-r--r-- | system/doc/installation_guide/Makefile | 8 | ||||
| -rw-r--r-- | system/doc/installation_guide/install.xml | 8 |
2 files changed, 9 insertions, 7 deletions
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> |