Merge branch 'lukas/erl_docgen/add-internal-docs'

OTP-15715

* lukas/erl_docgen/add-internal-docs:
  cerl_clauses: Fix broken link
  Fix minor typos
  Add CountingInstructions to the internal documentation
  GarbageCollection.md: Fix links to references
  emd2exml: Remove paragraphs around image tags
  emd2exml: Clean emphasis markers in link texts
  emd2exml: Allow short names of anchors for internal links
  Include figures
  erts: Fix more internal docs xmllint
  compiler: Add internal docs section
  erl_docgen: Add new internal docs chapter to docs

3 files changed, 51 insertions, 1 deletions

diff --git a/lib/compiler/doc/src/Makefile b/lib/compiler/doc/src/Makefile
index 32f150eef8..2fb163b9e7 100644
--- a/lib/compiler/doc/src/Makefile
+++ b/lib/compiler/doc/src/Makefile
@@ -31,6 +31,7 @@ APPLICATION=compiler
 # Release directory specification
 # ----------------------------------------------------
 RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN)
+COMPILER_DIR = $(ERL_TOP)/lib/compiler/src
 
 # ----------------------------------------------------
 # Target Specs
@@ -38,7 +39,7 @@ RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN)
 XML_APPLICATION_FILES = ref_man.xml
 XML_REF3_FILES = compile.xml
 
-XML_PART_FILES =
+XML_PART_FILES = internal.xml
 XML_CHAPTER_FILES = notes.xml
 
 BOOK_FILES = book.xml
@@ -49,6 +50,9 @@ XML_FILES = \
 	$(BOOK_FILES) $(XML_CHAPTER_FILES) \
 	$(XML_PART_FILES) $(XML_REF3_FILES) $(XML_APPLICATION_FILES)
 
+XML_INTERNAL_FILES = \
+	cerl.xml cerl_trees.xml cerl_clauses.xml
+
 # ----------------------------------------------------
 
 HTML_FILES = $(XML_APPLICATION_FILES:%.xml=$(HTMLDIR)/%.html) \
@@ -62,6 +66,8 @@ HTML_REF_MAN_FILE = $(HTMLDIR)/index.html
 
 TOP_PDF_FILE =  $(PDFDIR)/$(APPLICATION)-$(VSN).pdf
 
+XML_GEN_FILES = $(XML_INTERNAL_FILES:%=$(XMLDIR)/%)
+
 # ----------------------------------------------------
 # FLAGS
 # ----------------------------------------------------
@@ -85,6 +91,9 @@ man: $(MAN3_FILES)
 
 gifs: $(GIF_FILES:%=$(HTMLDIR)/%)
 
+$(XML_INTERNAL_FILES:%=$(XMLDIR)/%): $(COMPILER_DIR)/$(@:$(XMLDIR)/%.xml=%.erl)
+	$(gen_verbose)escript $(DOCGEN)/priv/bin/xml_from_edoc.escript -def vsn $(COMPILER_VSN) -dir $(XMLDIR) $(COMPILER_DIR)/$(@:$(XMLDIR)/%.xml=%.erl)
+
 debug opt:
 
 clean clean_docs:
diff --git a/lib/compiler/doc/src/book.xml b/lib/compiler/doc/src/book.xml
index af6b4cf47a..d101d40cb4 100644
--- a/lib/compiler/doc/src/book.xml
+++ b/lib/compiler/doc/src/book.xml
@@ -38,6 +38,9 @@
   <applications>
     <xi:include href="ref_man.xml"/>
   </applications>
+  <internals>
+    <xi:include href="internal.xml"/>
+  </internals>
   <releasenotes>
     <xi:include href="notes.xml"/>
   </releasenotes>
diff --git a/lib/compiler/doc/src/internal.xml b/lib/compiler/doc/src/internal.xml
new file mode 100644
index 0000000000..f24b363c1c
--- /dev/null
+++ b/lib/compiler/doc/src/internal.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE part SYSTEM "part.dtd">
+
+<internal xmlns:xi="http://www.w3.org/2001/XInclude">
+  <header>
+    <copyright>
+      <year>2018</year><year>2018</year>
+      <holder>Ericsson AB. All Rights Reserved.</holder>
+    </copyright>
+    <legalnotice>
+      Licensed under the Apache License, Version 2.0 (the "License");
+      you may not use this file except in compliance with the License.
+      You may obtain a copy of the License at
+ 
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+      See the License for the specific language governing permissions and
+      limitations under the License.
+    
+    </legalnotice>
+
+    <title>Compiler Internal Documentation</title>
+    <prepared>Lukas Larsson</prepared>
+    <docno></docno>
+    <date>2018-07-07</date>
+    <rev>1.0.0</rev>
+    <file>internal.xml</file>
+  </header>
+  <description>
+  </description>
+  <xi:include href="cerl.xml"/>
+  <xi:include href="cerl_trees.xml"/>
+  <xi:include href="cerl_clauses.xml"/>
+</internal>
+