From fa9e189d90a35f2ce4b7fc145c994828f34b3548 Mon Sep 17 00:00:00 2001 From: Lukas Larsson Date: Sat, 7 Jul 2018 11:33:54 +0200 Subject: erl_docgen: Add new internal docs chapter to docs --- erts/doc/src/Makefile | 21 ++++++++++++++++++++- erts/doc/src/book.xml | 3 +++ erts/doc/src/internal.xml | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 69 insertions(+), 1 deletion(-) create mode 100644 erts/doc/src/internal.xml (limited to 'erts/doc/src') diff --git a/erts/doc/src/Makefile b/erts/doc/src/Makefile index 06a8691c0e..8f0e47f85f 100644 --- a/erts/doc/src/Makefile +++ b/erts/doc/src/Makefile @@ -67,7 +67,21 @@ 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 + XML_CHAPTER_FILES = \ introduction.xml \ @@ -97,6 +111,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) \ @@ -164,6 +180,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 # ---------------------------------------------------- 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 @@ + + + diff --git a/erts/doc/src/internal.xml b/erts/doc/src/internal.xml new file mode 100644 index 0000000000..e5f3d9f3fd --- /dev/null +++ b/erts/doc/src/internal.xml @@ -0,0 +1,46 @@ + + + + +
+ + 20182018 + Ericsson AB. All Rights Reserved. + + + 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. + + + + ERTS Internal Documentation + Lukas Larsson + + 2018-07-07 + 4.5.2 + internal.xml +
+ + + + + + + + + + + + --> + + -- cgit v1.2.3 From cbef7064ee299f9463c2b6a0a274fe6603aedae9 Mon Sep 17 00:00:00 2001 From: Lukas Larsson Date: Wed, 29 Aug 2018 15:09:18 +0200 Subject: erts: Fix more internal docs xmllint --- erts/doc/src/Makefile | 2 +- erts/doc/src/internal.xml | 9 +++------ 2 files changed, 4 insertions(+), 7 deletions(-) (limited to 'erts/doc/src') diff --git a/erts/doc/src/Makefile b/erts/doc/src/Makefile index 8f0e47f85f..c8e9a42d48 100644 --- a/erts/doc/src/Makefile +++ b/erts/doc/src/Makefile @@ -75,7 +75,7 @@ XML_INTERNAL_FILES = \ CodeLoading.xml \ Tracing.xml \ DelayedDealloc.xml \ - beam_makeops.xml \ + beam_makeops.xml \ GarbageCollection.xml \ PTables.xml \ PortSignals.xml \ diff --git a/erts/doc/src/internal.xml b/erts/doc/src/internal.xml index e5f3d9f3fd..559cf5d2f4 100644 --- a/erts/doc/src/internal.xml +++ b/erts/doc/src/internal.xml @@ -29,18 +29,15 @@ 4.5.2 internal.xml - - - + + - --> + - -- cgit v1.2.3 From d49d01571ba9ab5bc28f470905269ab98c96b9af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= Date: Wed, 27 Mar 2019 14:26:49 +0100 Subject: Include figures --- erts/doc/src/Makefile | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) (limited to 'erts/doc/src') diff --git a/erts/doc/src/Makefile b/erts/doc/src/Makefile index c8e9a42d48..3cfc2799cd 100644 --- a/erts/doc/src/Makefile +++ b/erts/doc/src/Makefile @@ -132,6 +132,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 # ---------------------------------------------------- @@ -144,10 +150,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) @@ -162,6 +173,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: @@ -192,8 +204,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 \ -- cgit v1.2.3 From 2d9f2307e51606e6234f1ed18d8ba3a7569e38db Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= Date: Tue, 2 Apr 2019 10:03:07 +0200 Subject: Add CountingInstructions to the internal documentation --- erts/doc/src/Makefile | 3 ++- erts/doc/src/internal.xml | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) (limited to 'erts/doc/src') diff --git a/erts/doc/src/Makefile b/erts/doc/src/Makefile index 3cfc2799cd..bc01919da1 100644 --- a/erts/doc/src/Makefile +++ b/erts/doc/src/Makefile @@ -80,7 +80,8 @@ XML_INTERNAL_FILES = \ PTables.xml \ PortSignals.xml \ ProcessManagementOptimizations.xml \ - SuperCarrier.xml + SuperCarrier.xml \ + CountingInstructions.xml XML_CHAPTER_FILES = \ diff --git a/erts/doc/src/internal.xml b/erts/doc/src/internal.xml index 559cf5d2f4..88609d492a 100644 --- a/erts/doc/src/internal.xml +++ b/erts/doc/src/internal.xml @@ -35,6 +35,7 @@ + -- cgit v1.2.3