diff options
Diffstat (limited to 'lib/hipe/doc')
| -rw-r--r-- | lib/hipe/doc/src/HiPE_app.xml (renamed from lib/hipe/doc/src/hipe_app.xml) | 16 | ||||
| -rw-r--r-- | lib/hipe/doc/src/Makefile | 78 | ||||
| -rw-r--r-- | lib/hipe/doc/src/notes.xml | 58 | ||||
| -rw-r--r-- | lib/hipe/doc/src/ref_man.xml | 2 |
4 files changed, 64 insertions, 90 deletions
diff --git a/lib/hipe/doc/src/hipe_app.xml b/lib/hipe/doc/src/HiPE_app.xml index 50812bc991..27fbf16fd0 100644 --- a/lib/hipe/doc/src/hipe_app.xml +++ b/lib/hipe/doc/src/HiPE_app.xml @@ -72,8 +72,8 @@ </item> <tag>Stack traces</tag> - <item><p>Stack traces returned from <seealso marker="erts:erlang#get_stacktrace/0"> - <c>erlang:get_stacktrace/0</c></seealso> or as part of <c>'EXIT'</c> terms + <item><p>Stack traces returned from <seemfa marker="erts:erlang#get_stacktrace/0"> + <c>erlang:get_stacktrace/0</c></seemfa> or as part of <c>'EXIT'</c> terms can look incomplete if HiPE compiled functions are involved. Typically a stack trace will contain only BEAM compiled functions or only HiPE compiled functions, depending on where the exception was raised.</p> @@ -82,18 +82,18 @@ <tag>Tracing</tag> <item><p>Erlang call trace is not supported by HiPE. Calling - <seealso marker="erts:erlang#trace_pattern/3"><c>erlang:trace_pattern({M,F,A}, ...)</c></seealso> + <seemfa marker="erts:erlang#trace_pattern/3"><c>erlang:trace_pattern({M,F,A}, ...)</c></seemfa> does not have any effect on HiPE compiled modules.</p> </item> <tag>NIFs</tag> - <item><p>Modules compiled with HiPE cannot call <seealso marker="erts:erlang#load_nif-2"> - <c>erlang:load_nif/2</c></seealso> to load NIFs.</p> + <item><p>Modules compiled with HiPE cannot call <seemfa marker="erts:erlang#load_nif/2"> + <c>erlang:load_nif/2</c></seemfa> to load NIFs.</p> </item> <tag>-on_load</tag> <item><p>Modules compiled with HiPE cannot use - <seealso marker="doc/reference_manual:code_loading#on_load"><c>-on_load()</c></seealso> + <seeguide marker="system/reference_manual:code_loading#on_load"><c>-on_load()</c></seeguide> directives.</p> </item> </taglist> @@ -190,8 +190,8 @@ <section> <title>SEE ALSO</title> <p> - <seealso marker="stdlib:c">c(3)</seealso>, - <seealso marker="compiler:compile">compile(3)</seealso> + <seeerl marker="stdlib:c">c(3)</seeerl>, + <seeerl marker="compiler:compile">compile(3)</seeerl> </p> </section> diff --git a/lib/hipe/doc/src/Makefile b/lib/hipe/doc/src/Makefile index 104c15f2bb..ddebe3c415 100644 --- a/lib/hipe/doc/src/Makefile +++ b/lib/hipe/doc/src/Makefile @@ -28,17 +28,12 @@ VSN=$(HIPE_VSN) APPLICATION=hipe # ---------------------------------------------------- -# Release directory specification -# ---------------------------------------------------- -RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN) - -# ---------------------------------------------------- # Target Specs # ---------------------------------------------------- XML_APPLICATION_FILES = ref_man.xml XML_REF3_FILES = -XML_PART_FILES = hipe_app.xml +XML_PART_FILES = HiPE_app.xml XML_CHAPTER_FILES = notes.xml BOOK_FILES = book.xml @@ -47,73 +42,4 @@ 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 -rf $(XMLDIR) - rm -f $(MAN3DIR)/* - rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo) - rm -f errs core *~ - -distclean: clean -realclean: clean - -# ---------------------------------------------------- -# 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: +include $(ERL_TOP)/make/doc.mk diff --git a/lib/hipe/doc/src/notes.xml b/lib/hipe/doc/src/notes.xml index 8e1f5b35cd..600aabaebb 100644 --- a/lib/hipe/doc/src/notes.xml +++ b/lib/hipe/doc/src/notes.xml @@ -31,6 +31,54 @@ </header> <p>This document describes the changes made to HiPE.</p> +<section><title>Hipe 4.0.1</title> + + <section><title>Fixed Bugs and Malfunctions</title> + <list> + <item> + <p> + Fixed a warning issued when building the <c>hipe</c> + application.</p> + <p> + Own Id: OTP-16737</p> + </item> + </list> + </section> + +</section> + +<section><title>Hipe 4.0</title> + + <section><title>Fixed Bugs and Malfunctions</title> + <list> + <item> + <p>Fixed a rare miss-compilation of tuple matching.</p> + <p> + Own Id: OTP-16470</p> + </item> + </list> + </section> + + + <section><title>Improvements and New Features</title> + <list> + <item> + <p>The deprecated <c>erlang:get_stacktrace/0</c> BIF now + returns an empty list instead of a stacktrace. To + retrieve the stacktrace, use the extended try/catch + syntax that was introduced in OTP 21. + <c>erlang:get_stacktrace/0</c> is scheduled for removal + in OTP 24.</p> + <p> + *** POTENTIAL INCOMPATIBILITY ***</p> + <p> + Own Id: OTP-16484</p> + </item> + </list> + </section> + +</section> + <section><title>Hipe 3.19.3</title> <section><title>Fixed Bugs and Malfunctions</title> @@ -381,9 +429,9 @@ Own Id: OTP-13810 Aux Id: PR-1124 </p> </item> <item> - <p>Replaced usage of deprecated symbolic <seealso - marker="erts:erlang#type-time_unit"><c>time - unit</c></seealso> representations.</p> + <p>Replaced usage of deprecated symbolic <seetype + marker="erts:erlang#time_unit"><c>time + unit</c></seetype> representations.</p> <p> Own Id: OTP-13831 Aux Id: OTP-13735 </p> </item> @@ -974,8 +1022,8 @@ </taglist> <p> For information on how to use Maps please see Map Expressions in the - <seealso marker="doc/reference_manual:expressions#map_expressions"> - Reference Manual</seealso>.</p> + <seeguide marker="system/reference_manual:expressions#map_expressions"> + Reference Manual</seeguide>.</p> <p> The current implementation is without the following features:</p> diff --git a/lib/hipe/doc/src/ref_man.xml b/lib/hipe/doc/src/ref_man.xml index 7938729227..05af6b0c4f 100644 --- a/lib/hipe/doc/src/ref_man.xml +++ b/lib/hipe/doc/src/ref_man.xml @@ -31,6 +31,6 @@ </header> <description> </description> - <xi:include href="hipe_app.xml"/> + <xi:include href="HiPE_app.xml"/> </application> |