From 75bc5e521dcc9ab798acefb5400f5f15354f08fd Mon Sep 17 00:00:00 2001
From: Lars G Thorsen <lars@erlang.org>
Date: Thu, 11 Feb 2010 07:13:28 +0000
Subject: OTP-8343  The documentation is now possible to build in an open
 source           environment after a number of bugs are fixed and some
 features           are added in the documentation build process.

          - The arity calculation is updated.

          - The module prefix used in the function names for bif's are
          removed in the generated links so the links will look like
          "http://www.erlang.org/doc/man/erlang.html#append_element-2"
          instead of
          "http://www.erlang.org/doc/man/erlang.html#erlang:append_element-
          2".

          - Enhanced the menu positioning in the html documentation when a
          new page is loaded.

          - A number of corrections in the generation of man pages (thanks
          to Sergei Golovan)

          - The legal notice is taken from the xml book file so OTP's build
          process can be used for non OTP applications.
---
 lib/hipe/doc/src/hipe_app.xml | 58 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 lib/hipe/doc/src/hipe_app.xml

(limited to 'lib/hipe/doc/src/hipe_app.xml')

diff --git a/lib/hipe/doc/src/hipe_app.xml b/lib/hipe/doc/src/hipe_app.xml
new file mode 100644
index 0000000000..56729d4cc4
--- /dev/null
+++ b/lib/hipe/doc/src/hipe_app.xml
@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="latin1" ?>
+<!DOCTYPE appref SYSTEM "appref.dtd">
+
+<appref>
+  <header>
+    <copyright>
+      <year>1997</year><year>2010</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>snmp</title>
+    <prepared></prepared>
+    <responsible></responsible>
+    <docno></docno>
+    <approved></approved>
+    <checked></checked>
+    <date></date>
+    <rev></rev>
+    <file>hipe.xml</file>
+  </header>
+  <app>HiPE</app>
+  <appsummary>The HiPE Application</appsummary>
+  <description>
+    <p>
+      The normal way to native-compile an Erlang module using HiPE is to include the atom native 
+      in the Erlang compiler options, as in:
+      <code>
+      1> <input>c(my_module, [native]).</input></code>
+      Options to the HiPE compiler are then passed as follows:
+      <code>
+      1> <input>c(my_module, [native,{hipe,Options}]).</input></code>
+      For on-line help in the Erlang shell, call <c>hipe:help()</c>. 
+      Details on HiPE compiler options are given by <c>hipe:help_options()</c>.
+    </p>
+  </description>  
+  <section>
+    <title>SEE ALSO</title>
+    <p>
+      <seealso marker="stdlib:c">c(3)</seealso>, 
+      <seealso marker="compiler:compile">compile(3)</seealso>
+    </p>
+  </section>
+
+</appref>
+
-- 
cgit v1.2.3