diff options
author | Erlang/OTP <[email protected]> | 2009-11-20 14:54:40 +0000 |
---|---|---|
committer | Erlang/OTP <[email protected]> | 2009-11-20 14:54:40 +0000 |
commit | 84adefa331c4159d432d22840663c38f155cd4c1 (patch) | |
tree | bff9a9c66adda4df2106dfd0e5c053ab182a12bd /lib/hipe/doc | |
download | otp-84adefa331c4159d432d22840663c38f155cd4c1.tar.gz otp-84adefa331c4159d432d22840663c38f155cd4c1.tar.bz2 otp-84adefa331c4159d432d22840663c38f155cd4c1.zip |
The R13B03 release.OTP_R13B03
Diffstat (limited to 'lib/hipe/doc')
-rw-r--r-- | lib/hipe/doc/Makefile | 29 | ||||
-rw-r--r-- | lib/hipe/doc/html/.gitignore | 0 | ||||
-rw-r--r-- | lib/hipe/doc/overview.edoc | 9 | ||||
-rw-r--r-- | lib/hipe/doc/pdf/.gitignore | 0 | ||||
-rw-r--r-- | lib/hipe/doc/src/Makefile | 113 | ||||
-rw-r--r-- | lib/hipe/doc/src/book.xml | 38 | ||||
-rw-r--r-- | lib/hipe/doc/src/fascicules.xml | 12 | ||||
-rw-r--r-- | lib/hipe/doc/src/make.dep | 13 | ||||
-rw-r--r-- | lib/hipe/doc/src/notes.xml | 350 | ||||
-rw-r--r-- | lib/hipe/doc/src/part_notes.xml | 35 |
10 files changed, 599 insertions, 0 deletions
diff --git a/lib/hipe/doc/Makefile b/lib/hipe/doc/Makefile new file mode 100644 index 0000000000..340f909aa6 --- /dev/null +++ b/lib/hipe/doc/Makefile @@ -0,0 +1,29 @@ +# ``The contents of this file are subject to the Erlang Public License, +# Version 1.1, (the "License"); you may not use this file except in +# 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 via the world wide web 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. +# +SHELL=/bin/sh + +include $(ERL_TOP)/make/target.mk +include $(ERL_TOP)/make/$(TARGET)/otp.mk + +clean: + -rm -f *.html edoc-info stylesheet.css + +# ---------------------------------------------------- +# Special Build Targets +# ---------------------------------------------------- + + + +# ---------------------------------------------------- +# Release Target +# ---------------------------------------------------- +include $(ERL_TOP)/make/otp_release_targets.mk diff --git a/lib/hipe/doc/html/.gitignore b/lib/hipe/doc/html/.gitignore new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/lib/hipe/doc/html/.gitignore diff --git a/lib/hipe/doc/overview.edoc b/lib/hipe/doc/overview.edoc new file mode 100644 index 0000000000..0016478a8a --- /dev/null +++ b/lib/hipe/doc/overview.edoc @@ -0,0 +1,9 @@ + + HiPE overview page + +@title The HiPE Compiler + +@author The HiPE group <[email protected]> [http://www.it.uu.se/research/group/hipe/] + +@doc This is the online documentation for the HiPE native code compiler. +The user interface is provided by the module {@link hipe}. diff --git a/lib/hipe/doc/pdf/.gitignore b/lib/hipe/doc/pdf/.gitignore new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/lib/hipe/doc/pdf/.gitignore diff --git a/lib/hipe/doc/src/Makefile b/lib/hipe/doc/src/Makefile new file mode 100644 index 0000000000..3b63e57549 --- /dev/null +++ b/lib/hipe/doc/src/Makefile @@ -0,0 +1,113 @@ +# ``The contents of this file are subject to the Erlang Public License, +# Version 1.1, (the "License"); you may not use this file except in +# 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 via the world wide web 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. +# +# The Initial Developer of the Original Code is Ericsson Utvecklings AB. +# Portions created by Ericsson are Copyright 1999, Ericsson Utvecklings +# AB. All Rights Reserved.'' +# +# $Id$ +# +include $(ERL_TOP)/make/target.mk +include $(ERL_TOP)/make/$(TARGET)/otp.mk + +# ---------------------------------------------------- +# Application version +# ---------------------------------------------------- +include ../../vsn.mk +VSN=$(HIPE_VSN) +APPLICATION=hipe + +# ---------------------------------------------------- +# Release directory specification +# ---------------------------------------------------- +RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN) + +# ---------------------------------------------------- +# Target Specs +# ---------------------------------------------------- +XML_APPLICATION_FILES = +XML_REF3_FILES = + +XML_PART_FILES = part_notes.xml +XML_CHAPTER_FILES = notes.xml + +BOOK_FILES = book.xml + +XML_FILES = \ + $(BOOK_FILES) $(XML_CHAPTER_FILES) \ + $(XML_PART_FILES) $(XML_REF3_FILES) $(XML_APPLICATION_FILES) + +GIF_FILES = + +# ---------------------------------------------------- + +HTML_FILES = $(XML_APPLICATION_FILES:%.xml=$(HTMLDIR)/%.html) \ + $(XML_PART_FILES:%.xml=$(HTMLDIR)/%.html) + +INFO_FILE = ../../info +EXTRA_FILES = \ + $(DEFAULT_GIF_FILES) \ + $(DEFAULT_HTML_FILES) \ + $(XML_REF3_FILES:%.xml=$(HTMLDIR)/%.html) \ + $(XML_CHAPTER_FILES:%.xml=$(HTMLDIR)/%.html) + +MAN3_FILES = $(XML_REF3_FILES:%.xml=$(MAN3DIR)/%.3) + +HTML_REF_MAN_FILE = $(HTMLDIR)/index.html + +TOP_PDF_FILE = $(PDFDIR)/$(APPLICATION)-$(VSN).pdf + +# ---------------------------------------------------- +# FLAGS +# ---------------------------------------------------- +XML_FLAGS += + +# ---------------------------------------------------- +# Targets +# ---------------------------------------------------- +$(HTMLDIR)/%.gif: %.gif + $(INSTALL_DATA) $< $@ + +docs: pdf html man + +$(TOP_PDF_FILE): $(XML_FILES) + +pdf: $(TOP_PDF_FILE) + +html: gifs $(HTML_REF_MAN_FILE) + +man: $(MAN3_FILES) + +gifs: $(GIF_FILES:%=$(HTMLDIR)/%) + +debug opt: + +clean clean_docs: + rm -rf $(HTMLDIR)/* + rm -f $(MAN3DIR)/* + rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo) + rm -f errs core *~ + +# ---------------------------------------------------- +# Release Target +# ---------------------------------------------------- +include $(ERL_TOP)/make/otp_release_targets.mk + +release_docs_spec: docs + $(INSTALL_DIR) $(RELSYSDIR)/doc/pdf + $(INSTALL_DATA) $(TOP_PDF_FILE) $(RELSYSDIR)/doc/pdf + $(INSTALL_DIR) $(RELSYSDIR)/doc/html + $(INSTALL_DATA) $(HTMLDIR)/* \ + $(RELSYSDIR)/doc/html + $(INSTALL_DATA) $(INFO_FILE) $(RELSYSDIR) + + +release_spec: diff --git a/lib/hipe/doc/src/book.xml b/lib/hipe/doc/src/book.xml new file mode 100644 index 0000000000..236dfc69a1 --- /dev/null +++ b/lib/hipe/doc/src/book.xml @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE book SYSTEM "book.dtd"> + +<book xmlns:xi="http://www.w3.org/2001/XInclude"> + <header titlestyle="normal"> + <copyright> + <year>2006</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + 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>HiPE</title> + <prepared></prepared> + <docno></docno> + <date></date> + <rev></rev> + </header> + <pagetext></pagetext> + <preamble> + </preamble> + <pagetext>HiPE</pagetext> + <releasenotes> + <xi:include href="notes.xml"/> + </releasenotes> +</book> + diff --git a/lib/hipe/doc/src/fascicules.xml b/lib/hipe/doc/src/fascicules.xml new file mode 100644 index 0000000000..28acc14624 --- /dev/null +++ b/lib/hipe/doc/src/fascicules.xml @@ -0,0 +1,12 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE fascicules SYSTEM "fascicules.dtd"> + +<fascicules> + <fascicule file="part_notes" href="part_notes_frame.html" entry="yes"> + Release Notes + </fascicule> + <fascicule file="" href="../../../../doc/print.html" entry="no"> + Off-Print + </fascicule> +</fascicules> + diff --git a/lib/hipe/doc/src/make.dep b/lib/hipe/doc/src/make.dep new file mode 100644 index 0000000000..d5f5844c21 --- /dev/null +++ b/lib/hipe/doc/src/make.dep @@ -0,0 +1,13 @@ +# ---------------------------------------------------- +# >>>> Do not edit this file <<<< +# This file was automaticly generated by +# /home/otp/bin/docdepend +# ---------------------------------------------------- + + +# ---------------------------------------------------- +# TeX files that the DVI file depend on +# ---------------------------------------------------- + +book.dvi: book.tex + diff --git a/lib/hipe/doc/src/notes.xml b/lib/hipe/doc/src/notes.xml new file mode 100644 index 0000000000..8bb9320756 --- /dev/null +++ b/lib/hipe/doc/src/notes.xml @@ -0,0 +1,350 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE chapter SYSTEM "chapter.dtd"> + +<chapter> + <header> + <copyright> + <year>2006</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + 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>HiPE Release Notes</title> + <prepared>otp_appnotes</prepared> + <docno>nil</docno> + <date>nil</date> + <rev>nil</rev> + <file>notes.xml</file> + </header> + <p>This document describes the changes made to HiPE.</p> + +<section><title>Hipe 3.7.4</title> + + <section><title>Improvements and New Features</title> + <list> + <item> + <p> + The documentation is now built with open source tools + (xsltproc and fop) that exists on most platforms. One + visible change is that the frames are removed.</p> + <p> + Own Id: OTP-8201</p> + </item> + <item> + <p> + Misc updates.</p> + <p> + Own Id: OTP-8301</p> + </item> + </list> + </section> + +</section> + +<section><title>Hipe 3.7.3</title> + + <section><title>Improvements and New Features</title> + <list> + <item> + <p> + Various small bugs (one involving the handling of large + binaries) were corrected and some additions to its + functionality and/or code cleanups were done.</p> + <p> + Own Id: OTP-8189</p> + </item> + </list> + </section> + +</section> + +<section><title>Hipe 3.7.2</title> + + <section><title>Improvements and New Features</title> + <list> + <item> + <p> + Miscellanous updates.</p> + <p> + Own Id: OTP-8038</p> + </item> + </list> + </section> + +</section> + +<section><title>Hipe 3.7.1</title> + + <section><title>Improvements and New Features</title> + <list> + <item> + <p> + Minor updates and bug fixes.</p> + <p> + Own Id: OTP-7958</p> + </item> + </list> + </section> + +</section> + + +<section><title>Hipe 3.7</title> + + <section><title>Improvements and New Features</title> + <list> + <item> + <p> + Miscellaneous updates.</p> + <p> + Own Id: OTP-7877</p> + </item> + </list> + </section> + +</section> + +<section><title>Hipe 3.6.9</title> + + <section><title>Improvements and New Features</title> + <list> + <item> + <p>The <c>--disable-hipe</c> option for the + <c>configure</c> will now completely disable the hipe + run-time in the emulator, as is the expected + behaviour.</p> + <p> + Own Id: OTP-7631</p> + </item> + </list> + </section> + +</section> + +<section><title>Hipe 3.6.8</title> + + <section><title>Improvements and New Features</title> + <list> + <item> + <p> + Minor updates.</p> + <p> + Own Id: OTP-7522</p> + </item> + </list> + </section> + +</section> + + +<section><title>Hipe 3.6.7</title> + + <section><title>Improvements and New Features</title> + <list> + <item> + <p> + Minor changes.</p> + <p> + Own Id: OTP-7388</p> + </item> + </list> + </section> + +</section> + +<section><title>Hipe 3.6.6</title> + + <section><title>Fixed Bugs and Malfunctions</title> + <list> + <item> + <p>A fix for an #include problem which caused the FP + exception test to fail unnecessarily on + debian/glibc-2.7/x86 systems.</p> + <p>Added SIGFPE loop detection to the FP exception test. + This prevents the test from looping indefinitely, which + could happen when the CPU is supported (so we can enable + FP exceptions on it) but the OS isn't (so we can't write + a proper SIGFPE handler). x86 on an unsupported OS is + known to have had this problem.</p> + <p> + Own Id: OTP-7254</p> + </item> + </list> + </section> + + + <section><title>Improvements and New Features</title> + <list> + <item> + <p> + HiPE now also supports little-endian ARM processors.</p> + <p> + Own Id: OTP-7255</p> + </item> + </list> + </section> + +</section> + +<section><title>Hipe 3.6.5</title> + + <section><title>Fixed Bugs and Malfunctions</title> + <list> + <item> + <p> + HIPE: Corrected the choice of interface to the send/3 and + setnode/3 BIFs for native-compiled code. Using the + incorrect interface could, in unusual circumstances, lead + to random runtime errors.</p> + <p> + Own Id: OTP-7067</p> + </item> + </list> + </section> + + + <section><title>Improvements and New Features</title> + <list> + <item> + <p> + The HiPE compiler's SPARC backend has been rewritten, + improving its correctness and long-term maintainability.</p> + <p> + Own Id: OTP-7133</p> + </item> + </list> + </section> + +</section> + + <section> + <title>Hipe 3.6.3</title> + + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>Minor Makefile changes.</p> + <p>Own Id: OTP-6689</p> + </item> + <item> + <p>Miscellanous updates.</p> + <p>Own Id: OTP-6738</p> + </item> + </list> + </section> + </section> + + <section> + <title>Hipe 3.6.2</title> + + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>Miscellanous improvements.</p> + <p>Own Id: OTP-6577</p> + </item> + </list> + </section> + </section> + + <section> + <title>Hipe 3.6.1.1</title> + + <section> + <title>Fixed Bugs and Malfunctions</title> + <list type="bulleted"> + <item> + <p>Dialyzer could fail to analyze certain beam files that + used try/catch.</p> + <p>Own Id: OTP-6449 Aux Id: seq10563 </p> + </item> + </list> + </section> + </section> + + <section> + <title>Hipe 3.6.1</title> + + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>HiPE runtime system:</p> + <p>* added notes about supported systems to README</p> + <p>* support 32-bit x86 on FreeBSD</p> + <p>* autoenable HiPE on FreeBSD (32-bit x86) and Solaris + (64-bit x86)</p> + <p>* updated x86 runtime system to support glibc-2.5</p> + <p>* work around probable gcc-4.1.1 bug affecting the x86 + runtime system</p> + <p>HiPE compiler:</p> + <p>* improved performance of integer multiplications on + all platforms</p> + <p>* corrected a code optimisation error in R11B-2 that + broke some bsl/bsr operations on all platforms</p> + <p>* corrected a type error in the ARM backend which + could cause the compiler to crash</p> + <p>* corrected an error in the SPARC backend's naive + register allocator which could throw the compiler into an + infinite loop</p> + <p>Own Id: OTP-6423</p> + </item> + </list> + </section> + </section> + + <section> + <title>Hipe 3.6.0</title> + + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>Support for native code on Solaris 10/AMD64.</p> + <p>Support for native code on FreeBSD/AMD64.</p> + <p>Native code now handles external funs (<c><![CDATA[fun M:F/A]]></c>). Native code can now also apply so-called + tuple-funs (<c><![CDATA[{M,F}]]></c>). (Tuple funs are NOT + recommended for new code; they are deprecated and will be + removed in some future release.)</p> + <p>Own Id: OTP-6305</p> + </item> + </list> + </section> + </section> + + <section> + <title>Hipe 3.5.6</title> + + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>Improved compilation of receives for the SMP runtime + system.</p> + <p>Improved code quality in HiPE compiler on ARM.</p> + <p>Fix bug in handling of re-raised exceptions in + try-catch.</p> + <p>(HiPE loader) When native code is incompatible with + the current runtime system, fall back to loading the BEAM + code.</p> + <p>Own Id: OTP-6127</p> + </item> + </list> + </section> + </section> +</chapter> + diff --git a/lib/hipe/doc/src/part_notes.xml b/lib/hipe/doc/src/part_notes.xml new file mode 100644 index 0000000000..8a3e82027b --- /dev/null +++ b/lib/hipe/doc/src/part_notes.xml @@ -0,0 +1,35 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE part SYSTEM "part.dtd"> + +<part xmlns:xi="http://www.w3.org/2001/XInclude"> + <header> + <copyright> + <year>2006</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + 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>HiPE Release Notes</title> + <prepared></prepared> + <docno></docno> + <date></date> + <rev></rev> + </header> + <description> + <p><em>HiPE</em> - High Performance Erlang.</p> + </description> + <xi:include href="notes.xml"/> +</part> + |