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, 84 insertions, 2 deletions

diff --git a/erts/doc/src/Makefile b/erts/doc/src/Makefile
index 06a8691c0e..bc01919da1 100644
--- a/erts/doc/src/Makefile
+++ b/erts/doc/src/Makefile
@@ -67,7 +67,22 @@ XML_REF3_FILES = \
 	erts_alloc.xml
 
 XML_PART_FILES = \
-	part.xml
+	part.xml internal.xml
+
+XML_INTERNAL_FILES = \
+	CarrierMigration.xml	\
+	ThreadProgress.xml	\
+	CodeLoading.xml		\
+	Tracing.xml		\
+	DelayedDealloc.xml	\
+	beam_makeops.xml	\
+	GarbageCollection.xml	\
+	PTables.xml		\
+	PortSignals.xml		\
+	ProcessManagementOptimizations.xml \
+	SuperCarrier.xml        \
+	CountingInstructions.xml
+
 
 XML_CHAPTER_FILES = \
 	introduction.xml \
@@ -97,6 +112,8 @@ XML_FILES = \
 	$(BOOK_FILES) $(XML_CHAPTER_FILES) \
 	$(XML_PART_FILES) $(XML_REF3_FILES) $(XML_REF1_FILES) $(XML_APPLICATION_FILES)
 
+XML_GEN_FILES = $(XML_INTERNAL_FILES:%=$(XMLDIR)/%)
+
 # ----------------------------------------------------
 
 HTML_FILES = $(XML_APPLICATION_FILES:%.xml=$(HTMLDIR)/%.html) \
@@ -116,6 +133,12 @@ SPECS_FILES = $(XML_REF3_EFILES:%.xml=$(SPECDIR)/specs_%.xml)
 
 TOP_SPECS_FILE = specs.xml
 
+XML_FIGURE_DIR = $(XMLDIR)/figures
+
+INTERNAL_DOC_PNG_FILES = $(wildcard ../../emulator/internal_doc/figures/*.png)
+PNG_FILES = $(notdir $(INTERNAL_DOC_PNG_FILES))
+XMLDIR_PNG_FILES = $(PNG_FILES:%=$(XML_FIGURE_DIR)/%)
+
 # ----------------------------------------------------
 # FLAGS
 # ----------------------------------------------------
@@ -128,10 +151,15 @@ SPECS_FLAGS = -I$(KERNEL_SRC) -I$(KERNEL_INCLUDE)
 # ----------------------------------------------------
 # Targets
 # ----------------------------------------------------
+_create_dirs := $(shell mkdir -p $(XML_FIGURE_DIR))
+
 $(HTMLDIR)/%.gif: %.gif
 	$(INSTALL_DATA) $< $@
 
-docs: man pdf html $(INFO_FILE)
+$(XML_FIGURE_DIR)/%.png: ../../emulator/internal_doc/figures/%.png
+	$(INSTALL_DATA) $< $@
+
+docs: figures man pdf html $(INFO_FILE)
 
 $(TOP_PDF_FILE): $(XML_FILES)
 
@@ -146,6 +174,7 @@ gifs: $(GIF_FILES:%=$(HTMLDIR)/%)
 $(INFO_FILE): $(INFO_FILE_SRC) $(ERL_TOP)/make/$(TARGET)/otp.mk
 	sed -e 's;%RELEASE%;$(SYSTEM_VSN);' $(INFO_FILE_SRC) > $(INFO_FILE)
 
+figures: $(XMLDIR_PNG_FILES)
 
 debug opt:
 
@@ -164,6 +193,9 @@ $(SPECDIR)/specs_%.xml:
 	$(gen_verbose)escript $(SPECS_EXTRACTOR) $(SPECS_FLAGS) \
                 -o$(dir $@) -module $(patsubst $(SPECDIR)/specs_%.xml,%,$@)
 
+$(XMLDIR)/%.xml: ../../emulator/internal_doc/%.md $(ERL_TOP)/make/emd2exml
+	$(ERL_TOP)/make/emd2exml $< $@
+
 # ----------------------------------------------------
 # Release Target
 # ----------------------------------------------------
@@ -173,8 +205,11 @@ release_docs_spec: docs
 	$(INSTALL_DIR) "$(RELSYSDIR)/doc/pdf"
 	$(INSTALL_DATA) $(TOP_PDF_FILE) "$(RELSYSDIR)/doc/pdf"
 	$(INSTALL_DIR) "$(RELSYSDIR)/doc/html"
+	$(INSTALL_DIR) "$(RELSYSDIR)/doc/html/figures"
 	$(INSTALL_DATA) $(HTMLDIR)/* \
 		"$(RELSYSDIR)/doc/html"
+	$(INSTALL_DATA) $(XMLDIR)/figures/* \
+		"$(RELSYSDIR)/doc/html/figures"
 	$(INSTALL_DATA) $(ERL_TOP)/erts/example/time_compat.erl \
 		"$(RELSYSDIR)/doc/html"
 	$(INSTALL_DATA) $(ERL_TOP)/lib/kernel/examples/gen_tcp_dist/src/gen_tcp_dist.erl \
diff --git a/erts/doc/src/book.xml b/erts/doc/src/book.xml
index a0780c91d9..d79da1e4f7 100644
--- a/erts/doc/src/book.xml
+++ b/erts/doc/src/book.xml
@@ -41,6 +41,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/erts/doc/src/internal.xml b/erts/doc/src/internal.xml
new file mode 100644
index 0000000000..88609d492a
--- /dev/null
+++ b/erts/doc/src/internal.xml
@@ -0,0 +1,44 @@
+<?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>ERTS Internal Documentation</title>
+    <prepared>Lukas Larsson</prepared>
+    <docno></docno>
+    <date>2018-07-07</date>
+    <rev>4.5.2</rev>
+    <file>internal.xml</file>
+  </header>
+  <xi:include href="CarrierMigration.xml"/>
+  <xi:include href="ThreadProgress.xml"/>
+  <xi:include href="CodeLoading.xml"/>
+  <xi:include href="Tracing.xml"/>
+  <xi:include href="DelayedDealloc.xml"/>
+  <xi:include href="beam_makeops.xml"/>
+  <xi:include href="CountingInstructions.xml"/>
+  <xi:include href="GarbageCollection.xml"/>
+  <xi:include href="PTables.xml"/>
+  <xi:include href="PortSignals.xml"/>
+  <xi:include href="ProcessManagementOptimizations.xml"/>
+  <xi:include href="SuperCarrier.xml"/>
+</internal>