summaryrefslogtreecommitdiff
path: root/system
diff options
context:
space:
mode:
authorLukas Larsson <lukas@erlang.org>2020-02-21 10:19:05 +0100
committerLukas Larsson <lukas@erlang.org>2020-02-24 10:02:51 +0100
commit48ecc7a66a23be4d3b8bb7976aaae0ba8e72f0e8 (patch)
tree666910810e54cc16652603cb1ccf05fa8b4d3601 /system
parent31c270cc9d696763dfbdf0d4438142e87dbb95ec (diff)
downloaderlang-48ecc7a66a23be4d3b8bb7976aaae0ba8e72f0e8.tar.gz
Add DOC_TARGETS makefile variable
The variable can be set to pdf, html, man or chunks and also any combination of the above.
Diffstat (limited to 'system')
-rw-r--r--system/doc/design_principles/Makefile13
-rw-r--r--system/doc/efficiency_guide/Makefile14
-rw-r--r--system/doc/embedded/Makefile16
-rw-r--r--system/doc/general_info/Makefile15
-rw-r--r--system/doc/getting_started/Makefile14
-rw-r--r--system/doc/installation_guide/Makefile13
-rw-r--r--system/doc/oam/Makefile14
-rw-r--r--system/doc/programming_examples/Makefile16
-rw-r--r--system/doc/reference_manual/Makefile30
-rw-r--r--system/doc/system_architecture_intro/Makefile16
-rw-r--r--system/doc/system_principles/Makefile15
-rw-r--r--system/doc/top/Makefile41
-rw-r--r--system/doc/top/print.html2
-rw-r--r--system/doc/tutorial/Makefile12
14 files changed, 121 insertions, 110 deletions
diff --git a/system/doc/design_principles/Makefile b/system/doc/design_principles/Makefile
index 2fbd7d087f..d781809137 100644
--- a/system/doc/design_principles/Makefile
+++ b/system/doc/design_principles/Makefile
@@ -95,7 +95,9 @@ $(HTMLDIR)/%.gif: %.gif
$(HTMLDIR)/%.svg: %.svg
$(INSTALL_DATA) $< $@
-docs: html
+DOC_TARGETS?=html
+
+docs: $(DOC_TARGETS)
local_docs: PDFDIR=../../pdf
@@ -116,12 +118,11 @@ clean clean_docs:
# ----------------------------------------------------
include $(ERL_TOP)/make/otp_release_targets.mk
-release_docs_spec: docs
-# $(INSTALL_DIR) "$(RELEASE_PATH)/pdf"
-# $(INSTALL_DATA) $(TOP_PDF_FILE) "$(RELEASE_PATH)/pdf"
- $(INSTALL_DIR) $(RELSYSDIR)
- $(INSTALL_DATA) $(IMAGE_FILES) $(HTMLDIR)/*.html \
+release_html_spec: html
+ $(INSTALL_DIR) "$(RELSYSDIR)"
+ $(INSTALL_DATA) $(IMAGE_FILES) $(EXTRA_FILES) $(HTMLDIR)/*.html \
$(RELSYSDIR)
+release_docs_spec: $(DOC_TARGETS:%=release_%_spec)
release_spec:
diff --git a/system/doc/efficiency_guide/Makefile b/system/doc/efficiency_guide/Makefile
index a2742a1354..285f8aad4b 100644
--- a/system/doc/efficiency_guide/Makefile
+++ b/system/doc/efficiency_guide/Makefile
@@ -88,7 +88,9 @@ DVIPS_FLAGS +=
# Targets
# ----------------------------------------------------
-docs: html
+DOC_TARGETS?=html
+
+docs: $(DOC_TARGETS)
local_docs: PDFDIR=../../pdf
@@ -107,15 +109,11 @@ clean clean_docs:
# ----------------------------------------------------
include $(ERL_TOP)/make/otp_release_targets.mk
-release_docs_spec: docs
-# $(INSTALL_DIR) "$(RELEASE_PATH)/pdf"
-# $(INSTALL_DATA) $(TOP_PDF_FILE) "$(RELEASE_PATH)/pdf"
- $(INSTALL_DIR) $(RELSYSDIR)
+release_html_spec: html
+ $(INSTALL_DIR) "$(RELSYSDIR)"
$(INSTALL_DATA) $(GIF_FILES) $(EXTRA_FILES) $(HTMLDIR)/*.html \
$(RELSYSDIR)
+release_docs_spec: $(DOC_TARGETS:%=release_%_spec)
release_spec:
-
-
-
diff --git a/system/doc/embedded/Makefile b/system/doc/embedded/Makefile
index 1604075312..bb95c8370f 100644
--- a/system/doc/embedded/Makefile
+++ b/system/doc/embedded/Makefile
@@ -76,7 +76,9 @@ DVIPS_FLAGS +=
# Targets
# ----------------------------------------------------
-docs: html
+DOC_TARGETS?=html
+
+docs: $(DOC_TARGETS)
local_docs: PDFDIR=../../pdf
@@ -95,13 +97,11 @@ clean clean_docs:
# ----------------------------------------------------
include $(ERL_TOP)/make/otp_release_targets.mk
-release_docs_spec: docs
-# $(INSTALL_DIR) "$(RELEASE_PATH)/pdf"
-# $(INSTALL_DATA) $(TOP_PDF_FILE) "$(RELEASE_PATH)/pdf"
- $(INSTALL_DIR) $(RELSYSDIR)
- $(INSTALL_DATA) $(GIF_FILES) $(HTMLDIR)/*.html \
+release_html_spec: html
+ $(INSTALL_DIR) "$(RELSYSDIR)"
+ $(INSTALL_DATA) $(GIF_FILES) $(EXTRA_FILES) $(HTMLDIR)/*.html \
$(RELSYSDIR)
-release_spec:
-
+release_docs_spec: $(DOC_TARGETS:%=release_%_spec)
+release_spec:
diff --git a/system/doc/general_info/Makefile b/system/doc/general_info/Makefile
index 539075280e..7496e128b2 100644
--- a/system/doc/general_info/Makefile
+++ b/system/doc/general_info/Makefile
@@ -69,7 +69,9 @@ DVIPS_FLAGS +=
# Targets
# ----------------------------------------------------
-docs: html
+DOC_TARGETS?=html
+
+docs: $(DOC_TARGETS)
local_docs: PDFDIR=../../pdf
@@ -88,12 +90,11 @@ clean clean_docs:
# ----------------------------------------------------
include $(ERL_TOP)/make/otp_release_targets.mk
-release_docs_spec: docs
-# $(INSTALL_DIR) "$(RELEASE_PATH)/pdf"
-# $(INSTALL_DATA) $(TOP_PDF_FILE) "$(RELEASE_PATH)/pdf"
- $(INSTALL_DIR) $(RELSYSDIR)
- $(INSTALL_DATA) $(GIF_FILES) $(HTMLDIR)/*.html \
+release_html_spec: html
+ $(INSTALL_DIR) "$(RELSYSDIR)"
+ $(INSTALL_DATA) $(GIF_FILES) $(EXTRA_FILES) $(HTMLDIR)/*.html \
$(RELSYSDIR)
-release_spec:
+release_docs_spec: $(DOC_TARGETS:%=release_%_spec)
+release_spec:
diff --git a/system/doc/getting_started/Makefile b/system/doc/getting_started/Makefile
index 1c917895d5..47442e85e3 100644
--- a/system/doc/getting_started/Makefile
+++ b/system/doc/getting_started/Makefile
@@ -75,7 +75,9 @@ DVIPS_FLAGS +=
# Targets
# ----------------------------------------------------
-docs: html
+DOC_TARGETS?=html
+
+docs: $(DOC_TARGETS)
local_docs: PDFDIR=../../pdf
@@ -94,11 +96,11 @@ clean clean_docs:
# ----------------------------------------------------
include $(ERL_TOP)/make/otp_release_targets.mk
-release_docs_spec: docs
-# $(INSTALL_DIR) "$(RELEASE_PATH)/pdf"
-# $(INSTALL_DATA) $(TOP_PDF_FILE) "$(RELEASE_PATH)/pdf"
- $(INSTALL_DIR) $(RELSYSDIR)
- $(INSTALL_DATA) $(GIF_FILES) $(HTMLDIR)/*.html \
+release_html_spec: html
+ $(INSTALL_DIR) "$(RELSYSDIR)"
+ $(INSTALL_DATA) $(GIF_FILES) $(EXTRA_FILES) $(HTMLDIR)/*.html \
$(RELSYSDIR)
+release_docs_spec: $(DOC_TARGETS:%=release_%_spec)
+
release_spec:
diff --git a/system/doc/installation_guide/Makefile b/system/doc/installation_guide/Makefile
index c5234c1c9a..c95a426653 100644
--- a/system/doc/installation_guide/Makefile
+++ b/system/doc/installation_guide/Makefile
@@ -100,7 +100,9 @@ $(REDIRECT_HTML_DIR)/%.html: Makefile
echo "This <a href=\"../"$(notdir $@)"\">link</a> will" >> $@
echo "take you there immediately.</p></body></html>" >> $@
-docs: $(XML_GEN_FILES) html
+DOC_TARGETS?=html
+
+docs: $(DOC_TARGETS)
local_docs: PDFDIR=../../pdf
local_docs: $(XML_GEN_FILES)
@@ -123,13 +125,12 @@ clean clean_docs:
# ----------------------------------------------------
include $(ERL_TOP)/make/otp_release_targets.mk
-
-release_docs_spec: docs
- $(INSTALL_DIR) $(RELSYSDIR)
+release_html_spec: html
+ $(INSTALL_DIR) "$(RELSYSDIR)"
$(INSTALL_DATA) $(GIF_FILES) $(HTMLDIR)/*.html $(RELSYSDIR)
$(INSTALL_DIR) $(REDIRECT_HTML_RELSYSDIR)
$(INSTALL_DATA) $(REDIRECT_HTML_FILES) $(REDIRECT_HTML_RELSYSDIR)
-release_spec:
-
+release_docs_spec: $(DOC_TARGETS:%=release_%_spec)
+release_spec:
diff --git a/system/doc/oam/Makefile b/system/doc/oam/Makefile
index 2eb429e04d..4e3848a91a 100644
--- a/system/doc/oam/Makefile
+++ b/system/doc/oam/Makefile
@@ -75,7 +75,9 @@ DVIPS_FLAGS +=
$(HTMLDIR)/%.gif: %.gif
$(CP) $< $@
-docs: html
+DOC_TARGETS?=html
+
+docs: $(DOC_TARGETS)
local_docs: PDFDIR=../../pdf
@@ -96,11 +98,11 @@ clean clean_docs:
# ----------------------------------------------------
include $(ERL_TOP)/make/otp_release_targets.mk
-release_docs_spec: docs
- $(INSTALL_DIR) $(RELSYSDIR)
- $(INSTALL_DATA) $(GIF_FILES) $(HTMLDIR)/*.html \
+release_html_spec: html
+ $(INSTALL_DIR) "$(RELSYSDIR)"
+ $(INSTALL_DATA) $(GIF_FILES) $(EXTRA_FILES) $(HTMLDIR)/*.html \
$(RELSYSDIR)
-release_spec:
-
+release_docs_spec: $(DOC_TARGETS:%=release_%_spec)
+release_spec:
diff --git a/system/doc/programming_examples/Makefile b/system/doc/programming_examples/Makefile
index 9c67c24b64..7c1bdde698 100644
--- a/system/doc/programming_examples/Makefile
+++ b/system/doc/programming_examples/Makefile
@@ -75,7 +75,10 @@ DVIPS_FLAGS +=
# Targets
# ----------------------------------------------------
-docs: html
+DOC_TARGETS?=html
+
+docs: $(DOC_TARGETS)
+
local_docs: PDFDIR=../../pdf
html: $(GIF_FILES) $(HTML_UG_FILE)
@@ -93,12 +96,11 @@ clean clean_docs:
# ----------------------------------------------------
include $(ERL_TOP)/make/otp_release_targets.mk
-release_docs_spec: docs
- $(INSTALL_DIR) $(RELSYSDIR)
- $(INSTALL_DATA) $(GIF_FILES) $(HTMLDIR)/*.html \
+release_html_spec: html
+ $(INSTALL_DIR) "$(RELSYSDIR)"
+ $(INSTALL_DATA) $(GIF_FILES) $(EXTRA_FILES) $(HTMLDIR)/*.html \
$(RELSYSDIR)
-release_spec:
-
-
+release_docs_spec: $(DOC_TARGETS:%=release_%_spec)
+release_spec:
diff --git a/system/doc/reference_manual/Makefile b/system/doc/reference_manual/Makefile
index 809eb2c979..f7b93814ab 100644
--- a/system/doc/reference_manual/Makefile
+++ b/system/doc/reference_manual/Makefile
@@ -18,6 +18,7 @@
# %CopyrightEnd%
#
#
+
include $(ERL_TOP)/make/target.mk
include $(ERL_TOP)/make/$(TARGET)/otp.mk
@@ -25,10 +26,10 @@ include $(ERL_TOP)/make/$(TARGET)/otp.mk
# Application version
# ----------------------------------------------------
include $(ERL_TOP)/erts/vsn.mk
-#VSN=$(SYSTEM_VSN)
APPLICATION=otp-system-documentation
XMLDIR := $(XMLDIR)/reference_manual
+
# ----------------------------------------------------
# Release directory specification
# ----------------------------------------------------
@@ -40,6 +41,7 @@ RELSYSDIR = "$(RELEASE_PATH)/doc/reference_manual"
XML_PART_FILES = part.xml
include xmlfiles.mk
+
XML_CHAPTER_FILES=$(REF_MAN_CHAPTER_FILES)
TOPDOCDIR=..
@@ -48,7 +50,6 @@ BOOK_FILES = book.xml
GIF_FILES=
-
XML_FILES = \
$(BOOK_FILES) $(XML_CHAPTER_FILES) \
$(XML_PART_FILES)
@@ -65,14 +66,6 @@ HTML_FILES = \
HTMLDIR = ../html/reference_manual
-EXTRA_FILES = $(DEFAULT_GIF_FILES) \
- $(DEFAULT_HTML_FILES) \
- $(C_FILES) \
- $(ERL_FILES) \
- $(HRL_FILES) \
- $(MISC_FILES) \
- $(XML_CHAPTER_FILES:%.xml=%.html)
-
HTML_UG_FILE = $(HTMLDIR)/users_guide.html
# ----------------------------------------------------
@@ -85,7 +78,9 @@ DVIPS_FLAGS +=
# Targets
# ----------------------------------------------------
-docs: html
+DOC_TARGETS?=html
+
+docs: $(DOC_TARGETS)
local_docs: PDFDIR=../../pdf
@@ -104,14 +99,11 @@ clean clean_docs:
# ----------------------------------------------------
include $(ERL_TOP)/make/otp_release_targets.mk
-release_docs_spec: docs
-# $(INSTALL_DIR) "$(RELEASE_PATH)/pdf"
-# $(INSTALL_DATA) $(TOP_PDF_FILE) "$(RELEASE_PATH)/pdf"
- $(INSTALL_DIR) $(RELSYSDIR)
- $(INSTALL_DATA) $(GIF_FILES) $(HTMLDIR)/*.html \
+release_html_spec: html
+ $(INSTALL_DIR) "$(RELSYSDIR)"
+ $(INSTALL_DATA) $(GIF_FILES) $(EXTRA_FILES) $(HTMLDIR)/*.html \
$(RELSYSDIR)
-release_spec:
-
-
+release_docs_spec: $(DOC_TARGETS:%=release_%_spec)
+release_spec:
diff --git a/system/doc/system_architecture_intro/Makefile b/system/doc/system_architecture_intro/Makefile
index ea9ee85105..a7b00b4ec5 100644
--- a/system/doc/system_architecture_intro/Makefile
+++ b/system/doc/system_architecture_intro/Makefile
@@ -70,7 +70,9 @@ DVIPS_FLAGS +=
# Targets
# ----------------------------------------------------
-docs: html
+DOC_TARGETS?=html
+
+docs: $(DOC_TARGETS)
local_docs: PDFDIR=../../pdf
@@ -89,13 +91,11 @@ clean clean_docs:
# ----------------------------------------------------
include $(ERL_TOP)/make/otp_release_targets.mk
-release_docs_spec: docs
-# $(INSTALL_DIR) "$(RELEASE_PATH)/pdf"
-# $(INSTALL_DATA) $(TOP_PDF_FILE) "$(RELEASE_PATH)/pdf"
- $(INSTALL_DIR) $(RELSYSDIR)
- $(INSTALL_DATA) $(GIF_FILES) $(HTMLDIR)/*.html \
+release_html_spec: html
+ $(INSTALL_DIR) "$(RELSYSDIR)"
+ $(INSTALL_DATA) $(GIF_FILES) $(EXTRA_FILES) $(HTMLDIR)/*.html \
$(RELSYSDIR)
-release_spec:
-
+release_docs_spec: $(DOC_TARGETS:%=release_%_spec)
+release_spec:
diff --git a/system/doc/system_principles/Makefile b/system/doc/system_principles/Makefile
index 5110b73373..44009b674f 100644
--- a/system/doc/system_principles/Makefile
+++ b/system/doc/system_principles/Makefile
@@ -71,7 +71,9 @@ DVIPS_FLAGS +=
# Targets
# ----------------------------------------------------
-docs: html
+DOC_TARGETS?=html
+
+docs: $(DOC_TARGETS)
local_docs: PDFDIR=../../pdf
@@ -90,12 +92,11 @@ clean clean_docs:
# ----------------------------------------------------
include $(ERL_TOP)/make/otp_release_targets.mk
-release_docs_spec: docs
-# $(INSTALL_DIR) "$(RELEASE_PATH)/pdf"
-# $(INSTALL_DATA) $(TOP_PDF_FILE) "$(RELEASE_PATH)/pdf"
- $(INSTALL_DIR) $(RELSYSDIR)
- $(INSTALL_DATA) $(GIF_FILES) $(HTMLDIR)/*.html \
+release_html_spec: html
+ $(INSTALL_DIR) "$(RELSYSDIR)"
+ $(INSTALL_DATA) $(GIF_FILES) $(EXTRA_FILES) $(HTMLDIR)/*.html \
$(RELSYSDIR)
-release_spec:
+release_docs_spec: $(DOC_TARGETS:%=release_%_spec)
+release_spec:
diff --git a/system/doc/top/Makefile b/system/doc/top/Makefile
index e3f9c4710a..2953491d71 100644
--- a/system/doc/top/Makefile
+++ b/system/doc/top/Makefile
@@ -249,8 +249,9 @@ DVIPS_FLAGS +=
# Targets
# ----------------------------------------------------
+DOC_TARGETS?=pdf html man
-docs: pdf html $(INFO_FILES)
+docs: $(DOC_TARGETS) $(INFO_FILES)
local_docs: PDFREFDIR=../pdf
@@ -258,10 +259,11 @@ $(TOP_PDF_FILE): $(XML_FILES)
pdf: $(TOP_PDF_FILE)
-html: $(INDEX_FILES) \
- $(MAN_INDEX) $(JAVASCRIPT)
+html: $(INDEX_FILES) $(JAVASCRIPT)
-debug opt:
+man: $(MAN_INDEX)
+
+debug opt:
clean:
$(RM) ../html/js/*.js
@@ -280,21 +282,28 @@ include $(ERL_TOP)/make/otp_release_targets.mk
$(RELSYSDIR)/temporary:
$(INSTALL_DIR) $(RELSYSDIR)/temporary
-release_docs_spec: docs
- $(INSTALL_DIR) "$(RELEASE_PATH)"
- $(INSTALL_DATA) $(INFO_FILES) "$(RELEASE_PATH)"
- $(INSTALL_DIR) $(RELSYSDIR)
- $(INSTALL_DIR) $(RELSYSDIR)/pdf
- $(INSTALL_DATA) \
- $(TOP_PDF_FILE) $(RELSYSDIR)/pdf
+$(RELSYSDIR)/docbuild:
+ $(INSTALL_DIR) $(RELSYSDIR)/docbuild
+
+release_man_spec: man $(RELSYSDIR)/docbuild
+ $(INSTALL_DATA) $(MAN_INDEX) $(RELSYSDIR)
+ $(INSTALL_DATA) $(MAN_INDEX_SRC) $(MAN_INDEX_SCRIPT) $(RELSYSDIR)/docbuild
+
+release_html_spec: html $(RELSYSDIR)/docbuild
$(INSTALL_DIR) $(RELSYSDIR)/js
$(INSTALL_DATA) $(JAVASCRIPT) $(RELSYSDIR)/js
- $(INSTALL_DATA) $(INDEX_FILES) $(MAN_INDEX) $(RELSYSDIR)
- $(INSTALL_DIR) $(RELSYSDIR)/docbuild
- $(INSTALL_DATA) $(INDEX_SCRIPT) $(MAN_INDEX_SCRIPT) $(JAVASCRIPT_BUILD_SCRIPT) \
- $(INDEX_SRC) $(MAN_INDEX_SRC) $(JAVASCRIPT_BUILD_SCRIPT_SRC) \
+ $(INSTALL_DATA) $(INDEX_FILES) $(RELSYSDIR)
+ $(INSTALL_DATA) $(INDEX_SCRIPT) $(JAVASCRIPT_BUILD_SCRIPT) \
+ $(INDEX_SRC) $(JAVASCRIPT_BUILD_SCRIPT_SRC) \
$(TEMPLATES) $(RELSYSDIR)/docbuild
- $(RM) -r $(RELSYSDIR)/temporary
+release_pdf_spec: pdf
+ $(INSTALL_DIR) $(RELSYSDIR)/pdf
+ $(INSTALL_DATA) \
+ $(TOP_PDF_FILE) $(RELSYSDIR)/pdf
+
+release_docs_spec: $(DOC_TARGETS:%=release_%_spec) $(INFO_FILES)
+ $(INSTALL_DATA) $(INFO_FILES) "$(RELEASE_PATH)"
+ $(RM) -r $(RELSYSDIR)/temporary
release_spec:
diff --git a/system/doc/top/print.html b/system/doc/top/print.html
index b562d0e9bc..e65ac491a9 100644
--- a/system/doc/top/print.html
+++ b/system/doc/top/print.html
@@ -19,7 +19,7 @@
<center>
<a href="http://www.ericsson.com/technology/opensource/erlang">
- <img alt="Ericsson AB" BORDER=0 SRC="pics/min_head.gif">
+ <img alt="Ericsson AB" BORDER=0>
</a>
<br>
diff --git a/system/doc/tutorial/Makefile b/system/doc/tutorial/Makefile
index 4c62deeffd..effc673af6 100644
--- a/system/doc/tutorial/Makefile
+++ b/system/doc/tutorial/Makefile
@@ -97,7 +97,9 @@ DVIPS_FLAGS +=
$(HTMLDIR)/%.gif: %.gif
$(CP) $< $@
-docs: html
+DOC_TARGETS?=html
+
+docs: $(DOC_TARGETS)
local_docs: PDFDIR=../../pdf
@@ -118,11 +120,11 @@ clean clean_docs:
# ----------------------------------------------------
include $(ERL_TOP)/make/otp_release_targets.mk
-release_docs_spec: docs
-# $(INSTALL_DIR) "$(RELEASE_PATH)/pdf"
-# $(INSTALL_DATA) $(TOP_PDF_FILE) "$(RELEASE_PATH)/pdf"
- $(INSTALL_DIR) $(RELSYSDIR)
+release_html_spec: html
+ $(INSTALL_DIR) "$(RELSYSDIR)"
$(INSTALL_DATA) $(GIF_FILES) $(EXTRA_FILES) $(HTMLDIR)/*.html \
$(RELSYSDIR)
+release_docs_spec: $(DOC_TARGETS:%=release_%_spec)
+
release_spec: